Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

hpp

0.1.0 • Public • Published

HPP

Express/Connect middleware to protect against HTTP Parameter Pollution attacks

Build Status Coverage Status Dependency Status

Why?

GET /search?firstname=John&firstname=John

req.query.firstname // => ???

It is [ "John", "John" ] ! These excellent slides give you the details.

This library prevents those HTTP Parameter Pollution attacks by putting array parameters in req.query and/or req.body aside and just selecting the first parameter value.

Installation

NPM Stats

This is a module for node.js and io.js and is installed via npm:

npm install hpp --save

Getting Started

Add the HPP middleware like this:

// ...
var hpp = require('hpp');
 
// ...
app.use(bodyParser.urlencoded()); // Make sure the body is parsed beforehand.
 
app.use(hpp()); // <- THIS IS THE NEW LINE
 
// Add your own middlewares afterwards, e.g.:
app.get('/search', function (req, res, next) { /* ... */ });
// They are safe from HTTP Parameter Pollution now.

Details about req.query

By default all top-level parameters in req.query are checked for being an array. If a parameter is an array the array is moved to req.queryPolluted and req.query is assigned the first value of the array:

GET /search?firstname=John&firstname=Alice&lastname=Doe

=>

req: {
    query: {
        firstname: 'John',
        lastname: 'Doe',
    },
    queryPolluted: {
        firstname: [ 'John', 'Alice' ]
    }
}

Checking req.query may be turned off by using app.use(hpp({ checkQuery: false })).

Details about req.body

Checking req.body is only done for requests with an urlencoded body. Not for json nor multipart bodies.

By default all top-level parameters in req.body are checked for being an array. If a parameter is an array the array is moved to req.bodyPolluted and req.body is assigned the first value of the array:

POST firstname=John&firstname=Alice&lastname=Doe

=>

req: {
    body: {
        firstname: 'John',
        lastname: 'Doe',
    },
    bodyPolluted: {
        firstname: [ 'John', 'Alice' ]
    }
}

Checking req.body may be turned off by using app.use(hpp({ checkBody: false })).

Contributing

To set up your development environment for HPP:

  1. Clone this repo to your desktop,
  2. in the shell cd to the main folder,
  3. hit npm install,
  4. hit npm install gulp -g if you haven't installed gulp globally yet, and
  5. run gulp dev. (Or run node ./node_modules/.bin/gulp dev if you don't want to install gulp globally.)

gulp dev watches all source files and if you save some changes it will lint the code and execute all tests. The test coverage report can be viewed from ./coverage/lcov-report/index.html.

If you want to debug a test you should use gulp test-without-coverage to run all tests without obscuring the code by the test coverage instrumentation.

Change History

  • v0.1.0 (2015-04-12)
    • Updated dependencies
    • Use in production satisfactory
  • v0.0.1 (2015-03-05)
    • Initial version

License (ISC)

In case you never heard about the ISC license it is functionally equivalent to the MIT license.

See the LICENSE file for details.

Install

npm i [email protected]

Version

0.1.0

License

ISC

Last publish

Collaborators

  • avatar