request-bouncer v2.0.1

request-bouncer

An abstract request blacklisting class.

Install

Depending on your Node version, you may need --harmony or --es_staging to run this package.

npm i --save request-bouncer

Example

var Bouncer = require('request-bouncer');
var bouncer = new Bouncer();

// Adds a new bouncing rule
bouncer.bounce({
    // The rule applies if the #match
    // pattern matches
    $match: {
        request: 'login'
    },
    // These key/value pairs of the request object
    // will be added to its identifier
    $include: ['username', 'ip']
})
// Blacklist these requests when we've had 100
// of them in 10 seconds for 10 seconds
.on(100).over(10000).for(10000);

In the example above, only 100 login requests will be allowed every 10 seconds before a 10 second ban occurs. Now that we have added the rule, let's validate a request:

// This returns true or false depending
// on the matching rules
bouncer.check({
    request: 'login',
    username: 'someone',
    password: 'something',
    ip: '127.0.0.1'
});

License

(The MIT License)

Copyright (c) 2015 Kosmas Papadatos <kosmas.papadatos@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.