Middleware for [koa][] that filters IPs against glob patterns, RegExp, string or array of globs. Support custom `403 Forbidden` message and custom ID.
npm install koa-ip-filter> Middleware for [koa][] that filters IPs against glob patterns, RegExp, string or array of globs. Support custom 403 Forbidden message and custom ID.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]
``
npm i koa-ip-filter --save
response, through opts.forbidden
- custom identifier different than default , through opts.id
+ you may want to add if it's not IP
- filter IP using glob patterns, regexp, string, array or function
- blacklist with negative glob patterns, whitelist with positive
- would restrict all to 403 Forbidden that not match to filter> Notice: In the next middleware you will have
this.filter method which is [ip-filter][]
> and this.identifier - the IP/ID that passed the given filterUsage
> For more use-cases see the tests`js
const koaIpFilter = require('koa-ip-filter')
`$3
> Filtering incoming request with glob patterns array, regexp, string or matcher functionParams
*
{Object}
- id {Function}: custom identifier, defaults to this.ip
- {Boolean}: to throw when not valid IPv4/IPv6? default true
- {Array|String|RegExp|Function}: black/white list filter
- forbidden {String|Function}: custom message when 403 Forbidden response
* returns {GeneratorFunction} Example
`js
'use strict'var koa = require('koa')
var ipFilter = require('koa-ip-filter')
var helloWorld = require('koa-hello-world')
var app = koa()
app
.use(ipFilter({
forbidden: '403: Get out of here!',
filter: ['127.??.6.12', '!1.2..4']
}))
.use(helloWorld())
app.listen(1234)
console.log('koa server start listening on http://localhost:1234')
// if your IP is
127.43.65.12 you will see Hello World
// otherwise you will see
$3
> If you want to allow all IPs, but want to restrict only some rangejs
'use strict'var koa = require('koa')
var ipFilter = require('koa-ip-filter')
var helloWorld = require('koa-hello-world')
var app = koa()
app
.use(ipFilter({
forbidden: '403: Get out of here!',
filter: ['', '!213.15.']
}))
.use(helloWorld())
app.listen(1234)
console.log('koa server start listening on http://localhost:1234')
// only user with IP starting with
213.15.*
// will see the message 403: Get out of here!
Related
- ip-filter: Filters valid IPv4 or IPv6 against glob pattern, array, string and etc… more | ip, otherwise null is returned. Have no strict mode to check no IP values."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- is-match-ip: Matching IPs using [micromatch][] and [ip-filter][] - glob patterns, RegExp, string or… more | homepage
- is-match: Create a matching function from a glob pattern, regex, string, array, object… more | homepage
- koa-better-body: Full-featured [koa][] body parser! Support parsing text, buffer, json, json patch, json… more | homepage
- koa-ip-filter: koa middleware to filter request IPs or custom ID with glob patterns… more | 403 Forbidden` message and custom ID."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
- micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch… more | homepageContributing
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 [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]
[![tunnckoCore.tk][author-www-img]][author-www-url] [![keybase tunnckoCore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]
[ip-filter]: https://github.com/tunnckocore/ip-filter
[is-match]: https://github.com/jonschlinkert/is-match
[koa]: https://github.com/koajs/koa
[micromatch]: https://github.com/jonschlinkert/micromatch
[npmjs-url]: https://www.npmjs.com/package/koa-ip-filter
[npmjs-img]: https://img.shields.io/npm/v/koa-ip-filter.svg?label=koa-ip-filter
[license-url]: https://github.com/tunnckoCore/koa-ip-filter/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/koa-ip-filter.svg
[downloads-url]: https://www.npmjs.com/package/koa-ip-filter
[downloads-img]: https://img.shields.io/npm/dm/koa-ip-filter.svg
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/koa-ip-filter
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/koa-ip-filter.svg
[travis-url]: https://travis-ci.org/tunnckoCore/koa-ip-filter
[travis-img]: https://img.shields.io/travis/tunnckoCore/koa-ip-filter/master.svg
[coveralls-url]: https://coveralls.io/r/tunnckoCore/koa-ip-filter
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/koa-ip-filter.svg
[david-url]: https://david-dm.org/tunnckoCore/koa-ip-filter
[david-img]: https://img.shields.io/david/tunnckoCore/koa-ip-filter.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg
[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg
[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg
[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg
[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg
[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg
[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg