tunnckoCore / ip-filter

~~(moved to `tunnckoCore/opensource` monorepo)~~ Validates valid IPs (IPv4 and IPv6) using `micromatch` - glob patterns, RegExp, string or array of globs. If match returns the IP, otherwise null.

ip-filter

Validates valid IPs (IPv4 and IPv6) using micromatch - glob patterns, RegExp, string or array of globs. If match returns the IP, otherwise null.

You might also be interested in is-match-ip, to-object-path, to-file-path or koa-ip-filter.

Install

npm i ip-filter --save

Usage

For more use-cases see the tests

const ipFilter = require('ip-filter')

ipFilter

Filter ip against glob patterns, using micromatch under the hood, so options are passed to it.

Params

• ip {String}: Accepts only valid IPs by default
• patterns {String|Array|RegExp|Function|Object}: Basically everything that is-match can accept.
• options {Object}: Pass strict: false if want to validate non-ip values, also passed to is-match.
• returns {String|null}: If not match returns null, otherwise the passed ip.

Example

var ipFilter = require('ip-filter')

console.log(ipFilter('123.77.34.89', '123.??.34.8*')) // => '123.77.34.89'
console.log(ipFilter('123.222.34.88', '123.??.34.8*')) // => null
console.log(ipFilter('123.222.33.1', ['123.*.34.*', '*.222.33.*'])) // => '123.222.33.1'

// should notice the difference
console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.**']))
// => null
console.log(ipFilter('123.222.34.88', ['123.*.34.*', '!123.222.*']))
// => '123.222.34.88'

//
// NON-STRICT mode
//

var res = ipFilter('x-koaip', ['*-koaip', '!foo-koa*'], { strict: false })
console.log(res) // => 'x-koaip'

var res = ipFilter('x-koa.foo', ['*-koa.*', '!foo-koa.*'], { strict: false })
console.log(res) // => 'x-koa.foo'

Related

• ip-regex: Regular expression for matching IP addresses | homepage
• is-match-ip: Matching IPs using micromatch and ip-filter - glob patterns, RegExp, string… more | homepage
• is-match: Create a matching function from a glob pattern, regex, string, array… more | homepage
• koa-ip-filter: koa middleware to filter request IPs or custom ID with glob… more | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to… more | homepage
• to-file-path: Create a filepath from an object path (dot notation), list of… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent