npmpackage.info

Gathering detailed insights and metrics for @curaelabs/express-ipfilter

@curaelabs/express-ipfilter - 0.0.1 | npmpackage.info

@curaelabs/express-ipfilter

A light-weight IP address based connection filtering system

0.0.1

MIT

JavaScript

116.66 kB

1.7

Installations

npm install @curaelabs/express-ipfilter

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

10.11.0

NPM Version

6.4.1 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

HTML

CSS

JavaScript (96.36%)

HTML (2.66%)

CSS (0.98%)

Developer

sylvaingirardbe

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

155 Commits

2 Watchers

4 Branches

1 Contributors

Updated on Jan 16, 2019

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

0.0.1

Package Id

@curaelabs/express-ipfilter@0.0.1

Unpacked Size

116.66 kB

Size

18.26 kB

File Count

NPM Version

6.4.1

Node Version

10.11.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

ip lodash range_check

Dev Dependencies

@babel/core @babel/preset-env grunt grunt-babel grunt-check-dependencies grunt-cli grunt-contrib-copy grunt-contrib-watch grunt-eslint grunt-mocha-istanbul grunt-mocha-test istanbul load-grunt-tasks minimatch mocha mocha-junit-reporter

@curaelabs/express-ipfilter: 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.

Version

0.0.1

Installation

Recommended installation is with npm. To add node-ipfilter to your project, do:

npm install @curaelabs/express-ipfilter

Usage with Express

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:

1// Init dependencies
2var express = require('express'),
3    ipfilter = require('express-ipfilter').IpFilter;
4
5// Blacklist the following IPs
6var ips = ['127.0.0.1'];
7
8// Create the server
9app.use(ipfilter(ips));
10app.listen(3000);

Whitelisting certain IP addresses, while denying all other IPs:

1// Init dependencies
2// Init dependencies
3var express = require('express'),
4    ipfilter = require('express-ipfilter').IpFilter;
5
6// Whitelist the following IPs
7var ips = ['127.0.0.1'];
8
9// Create the server
10app.use(ipfilter(ips, {mode: 'allow'}));
11
12module.exports = app;

Using CIDR subnet masks for ranges:

1var ips = ['127.0.0.1/24'];
2
3// Create the server
4app.use(ipfilter(ips, {mode: 'allow'}));
5
6module.exports = app;

Using IP ranges:

1var ips = [['127.0.0.1','127.0.0.10']];
2
3// Create the server
4app.use(ipfilter(ips, {mode: 'allow'}));
5
6module.exports = app;

Using a function to get Ips:

1var ips = function() { return ['127.0.0.1']; };
2
3// Create the server
4app.use(ipfilter(ips, {mode: 'allow'}));
5
6module.exports = app;

Error Handling

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.

Options

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});

Contributing

See the CONTRIBUTING.MD document for more information on contributing.

Building from source

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.

Running Tests

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.

Changelog

0.0.1

First revision - forked from express-filter
Updated all packages
Removed vulnerabilities

Credits

BaM Interactive - code.bamideas.com

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

53 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3
Warn: Project is vulnerable to: GHSA-957j-59c2-j692
Warn: Project is vulnerable to: GHSA-m5pj-vjjf-4m3h
Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4
Warn: Project is vulnerable to: GHSA-rm36-94g8-835r
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-pc58-wgmc-hfjr
Warn: Project is vulnerable to: GHSA-vvv8-xw5f-3f88
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More