npmpackage.info

Gathering detailed insights and metrics for express-ipfilter

Other packages similar to express-ipfilter

express-ipfilter-secured

0.3.3

A light-weight IP address based filtering system

custom-express-ipfilter

0.0.21

A light-weight IP address based filtering system

express-ipfilter-req

1.2.0

A light-weight IP address based filtering system

@curaelabs/express-ipfilter

0.0.1

A light-weight IP address based filtering system - based of of express-ipfilter but without the vulnerabilities.

Gathering detailed insights and metrics for express-ipfilter

express-ipfilter - 1.3.2 | npmpackage.info

express-ipfilter

A light-weight IP address based connection filtering system

1.3.2

MIT

JavaScript

14.44 kB

3.3

Installations

npm install express-ipfilter

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=8.9.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

15

Total

200

Closed

117

Merged

68

Issues

Open

3

Total

13

Closed

10

Releases

v1.3.2

Updated on Feb 20, 2024

v1.3.1

Updated on Aug 03, 2022

v1.3.0

Updated on Aug 01, 2022

v1.2.0

Updated on Mar 28, 2021

v1.1.2

Updated on Mar 25, 2020

v1.1.1

Updated on Nov 13, 2019

View All 8 releases

Languages

JavaScript

Pug

CSS

Shell

JavaScript (98.73%)

Pug (0.79%)

CSS (0.29%)

Shell (0.18%)

Developer

jetersen

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

66 Stars

266 Commits

21 Forks

2 Watchers

23 Branches

20 Contributors

Updated on Apr 04, 2025

Maintainers

View All 20 Contributors

Package Meta Information

Latest Version

1.3.2

Package Id

express-ipfilter@1.3.2

Unpacked Size

14.44 kB

Size

5.17 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Feb 20, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Dependencies

ip lodash proxy-addr range_check

Dev Dependencies

eslint eslint-config-prettier eslint-plugin-jest eslint-plugin-prettier husky jest lint-staged prettier

express-ipfilter: A light-weight IP address based filtering system

This package provides easy IP based access control. This can be achieved either by denying certain IPs and allowing all others, or allowing certain IPs and denying all others.

Installation

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

npm install express-ipfilter

Usage with Express

Denying certain IP addresses, while allowing all other IPs:

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

Allowing certain IP addresses, while denying all other IPs:

1// Init dependencies
2// Init dependencies
3const express = require('express')
4const ipfilter = require('express-ipfilter').IpFilter
5
6// Allow the following IPs
7const 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:

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

Using IP ranges:

1const 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:

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

Using wildcard ip ranges and nginx forwarding:

1  let allowlist_ips = ['10.1.*.*', '123.??.34.8*'] // matches '10.1.76.32' and '123.77.34.89'
2
3  let clientIp = function(req, res) {
4    return req.headers['x-forwarded-for'] ? (req.headers['x-forwarded-for']).split(',')[0] : ""
5  }
6  
7  app.use(
8    ipFilter({
9      detectIp: clientIp,
10      forbidden: 'You are not authorized to access this page.',
11      filter: allowlist_ips,
12    })
13  )

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:

1if (app.get('env') === 'development') {
2  app.use((err, req, res, _next) => {
3    console.log('Error handler', err)
4    if (err instanceof IpDeniedError) {
5      res.status(401)
6    } else {
7      res.status(err.status || 500)
8    }
9
10    res.render('error', {
11      message: 'You shall not pass',
12      error: err
13    })
14  })
15}

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
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
trustProxy	This setting is implemented using the proxy-addr package. Check the documentation for the trust parameter.	boolean, array, string, number, function	false

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.

1const customDetection = req => {
2  var ipAddress
3
4  ipAddress = req.connection.remoteAddress.replace(/\//g, '.')
5
6  return ipAddress
7}
8
9ipfilter(ips, { detectIp: customDetection })

Contributing

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

Running Tests

Run tests by using npm test

Changelog

Moved to GitHub Releases

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

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

Score

3.3

/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

Other packages similar to express-ipfilter

Other packages similar to express-ipfilter

express-ipfilter

Installations

Developer Guide

Yes

CommonJS

>=8.9.0

16.20.2

8.19.4

Pull Requests

15

200

117

68

Issues

3

13

10

Releases

Languages

Developer

jetersen

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Dependencies

Dev Dependencies

express-ipfilter: A light-weight IP address based filtering system

Installation

Usage with Express

Error Handling

Options

Contributing

Running Tests

Changelog

Credits

10

10

10

8

1

0

0

0

0

0

0

0

0

3.3

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads