express-ipfilter-secured
Version:
A light-weight IP address based filtering system
291 lines (185 loc) • 7.32 kB
Markdown
express-ipfilter-secured: A light-weight IP address based filtering system
=================================================================================
This package provides easy IP based access control. This can be achieved either by blacklisting certain IPs and whitelisting all others, or whitelisting certain IPs and blacklisting all others.
0.3.2
Recommended installation is with npm. To add node-ipfilter to your project, do:
npm install express-ipfilter-secured
> NOTE: Starting with version 0.1.0, allow forwarded IP addresses through headers (forward, Cloudflare, Codio) are disabled by **default**. You must explicitly enable them by adding them to the `allowedHeaders` list.
Blacklisting certain IP addresses, while allowing all other IPs:
```javascript
// Init dependencies
var express = require('express'),
ipfilter = require('express-ipfilter-secured').IpFilter;
// Blacklist the following IPs
var ips = ['127.0.0.1'];
// Create the server
app.use(ipfilter(ips));
app.listen(3000);
```
Whitelisting certain IP addresses, while denying all other IPs:
```javascript
// Init dependencies
// Init dependencies
var express = require('express'),
ipfilter = require('express-ipfilter-secured').IpFilter;
// Whitelist the following IPs
var ips = ['127.0.0.1'];
// Create the server
app.use(ipfilter(ips, {mode: 'allow'}));
module.exports = app;
```
Using CIDR subnet masks for ranges:
```javascript
var ips = ['127.0.0.1/24'];
// Create the server
app.use(ipfilter(ips, {mode: 'allow'}));
module.exports = app;
```
Using IP ranges:
```javascript
var ips = [['127.0.0.1','127.0.0.10']];
// Create the server
app.use(ipfilter(ips, {mode: 'allow'}));
module.exports = app;
```
Using a function to get Ips:
```javascript
var ips = function() { return ['127.0.0.1']; };
// Create the server
app.use(ipfilter(ips, {mode: 'allow'}));
module.exports = app;
```
When an IP is denied, an IpDeniedError will be thrown by the middleware. If you do not handle the error, it will cause your app to crash due to an unhandled exception. Here is an example of how to handle the error, which can also be found in the example app:
```
if (app.get('env') === 'development') {
app.use(function(err, req, res, _next) {
console.log('Error handler', err);
if(err instanceof IpDeniedError){
res.status(401);
}else{
res.status(err.status || 500);
}
res.render('error', {
message: 'You shall not pass',
error: err
});
});
}
```
You will need to require the `IpDeniedError` type in order to handle it.
| Property | Description | Type | Default|
| ------------- |-------------| -----|--------|
| mode | whether to *deny* or *allow* to the IPs provided | string|deny|
| log | console log actions | boolean|true|
| logLevel | level of logging (*all*,*deny*,*allow*) | string | all
| allowedHeaders | an array of strings for header names that are acceptable for retrieving an IP address | array | [] |
| excluding | routes that should be excluded from ip filtering | array|[]|
| detectIp | define a custom function that takes an Express request object and returns an IP address to test against | function | built-in detection |
> A note on detectIp
If you need to parse an IP address in a way that is not supported by default, you can write your own parser and pass that to `ipfilter`.
```
function customDetection(req){
var ipAddress;
ipAddress = req.connection.remoteAddress.replace(/\//g, '.');
return ipAddress;
}
ipfilter(ids, {detectIp: customDetection});
```
See the `CONTRIBUTING.MD` document for more information on contributing.
You can run `grunt` to build the source. This will run `eslint` and `babel` against `src/ipfilter.js`.
There is an included `example` project that will load the package from the local build for testing.
Run tests by using
`grunt test`
This will run `eslint`,`babel`, and `mocha` and output coverage data into `coverage`. Any pull request you submit needs to be accompanied by a test.
0.3.3
* Use invokeMap to match the Ips
0.3.2
* Bump the lodash version due to security concerns
* Update lodash usage in `src/ipfulter.js` for tests to pass
0.3.1
* Fixes critical bug that allowed access when ips is empty and mode == 'allow'.
* Adds minor speed improvements for middleware.
* Minor spelling and documentation fixes in README
0.3.0
* Adds the ability to pass IPs by function so that we can dynamically retrieve white/black listed addresses.
0.2.6
- Minor change to the Contributing Guidelines to include updating the version numbers
0.2.5
* Added fields `status` and `statusCode` to the IpDeniedError object, which both equal `403`.
0.2.4
* For IPv4 addresses that have a port (as experienced with Azure web apps), the port is now stripped before comparing it with the contents of the whitelist or blacklist. Fixes issue #49.
0.2.3
* Fixed a bug that sent all logging through instead of just denied requests
0.2.2
* Added a customization point for IP detection
* Fixed a bug with IPv4 over IPv6
0.2.1
* Add log level property.
0.2.0
* Changed how error handling works
* Removed settings for specific vendor ip addresses and added `allowedHeaders` to support those header-based IP addresses.
* You must now specifically require `IpFilter`, i.e. `var ipfilter = require('express-ipfilter-secured').IpFilter;`
* If you want to handle errors you must require the error type as well `var IpDeniedError = require('express-ipfilter-secured').IpDeniedError;`
0.1.1
* Added a favicon to the example to suppress the 404 error looking for it.
0.1.0
* Changed default behavior of the library to disable reading forwarded IP headers. They must now be explicitly enabled.
* Using `res.send` when a failure occurs to allow for different formats of `errorMessage`
0.0.25
* Switched from netmask to range_check (uses ipaddr.js)
* Added support for IPv6 CIDR
* Fixed issue with mixed IPv4 and IPv6 rules
0.0.24
* Added lib to version control
0.0.23
* added codio x-real-ip header
0.0.22
* Added IPv6 Support
* Added build tools
* Added test coverage and reporting
0.0.20
* Added a setting to explicitly allow CloudFlare and Forwarded IPs. By default they are set to not allow these headers. Thanks to @longstone!
0.0.19
* Added detection for CloudFlare forwarded ips - https://github.com/baminteractive/express-ipfilter-secured/commit/9aa43af14f5a003bad3145eef658f429808818f9 (@lafama)
0.0.18
* Fixing bug when array of CIDR blocks are used
0.0.16
* Fixing bug when no IP address can be determined
0.0.15
* Minor bug fix
0.0.14
* Adding the ability to have exclusion urls
0.0.12
* Diagnostic Options
0.0.11
* Bug Fix for port logic
0.0.10
* Added support for IPs with port numbers
0.0.9
* Fixing deploy issues
0.0.8
* Auto deploys for npm
0.0.7
* Add support ip ranges.
0.0.6
* Fixed a bug when using console output
0.0.5
* Added ability to block by subnet mask (i.e. 127.0.0.1/24)
* Added tests for cidr functionality
0.0.4
* Add tests
* Update docs
* Refactor, and restyle
0.0.1
* First revision
## Credits
BaM Interactive - [code.bamideas.com](http://code.bamideas.com)