CD2H gitForager

Gandi/hubot-restrict-ip

Name: hubot-restrict-ip

Owner: Gandi

Description: A hubot plugin registering an Express middleware for filtering who can access to http endpoints.

Created: 2016-08-16 17:10:09.0

Updated: 2016-08-23 20:01:32.0

Pushed: 2016-09-23 03:57:51.0

Homepage:

Size: 17

Language: CoffeeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Hubot Restrict IP Plugin

This plugin is an Express middleware that will permit to filter who has access to the http endpoints of your hubot bot.

Installation

In your hubot directory:

npm install hubot-restrict-ip --save

Then add hubot-restrict-ip to external-scripts.json

Configuration

HTTP_RESTRICTED if set, protects all express endpoints by default, only the open_endpoints are reachable by everybody, and the ip_whitelist
HTTP_LOG_RESTRICTED if set, hubot will log (warning level) the unauthorized calls
HTTP_IP_WHITELIST only useful when HTTP_RESTRICTED is set
HTTP_IP_BLACKLIST overwrite the whitelist if HTTP_RESTRICTED is set, and blocks ips listed anyways if not
HTTP_OPEN_ENDPOINTS over-rules any other configuration to keep those endpoints open
HTTP_CLOSED_ENDPOINTS if HTTP_RESTRICTED is set and HTTP_OPEN_ENDPOINTS are contradicted by HTTP_CLOSED_ENDPOINTS, the closed one wins.
HTTP_UNAUTHORIZED_MESSAGE the message provided with the 401 status triggered when access is restricted by any rule.

With

The IP lists are separated by , commas, and use CIDR for range definition like 192.168.0.0/24. IP can also be IPv6 ranges.
the endpoints are a list of endpoints, separated by commas too, like /hubot/help but it can also be a regexp like /.*/help

Testing

npm install

# will run make test and coffeelint
npm test 

# or
make test

# or, for watch-mode
make test-w

# or for more documentation-style output
make test-spec

# and to generate coverage
make test-cov

# and to run the lint
make lint

# run the lint and the coverage
make

Changelog

All changes are listed in the CHANGELOG

Contribute

Feel free to open a PR if you find any bug, typo, want to improve documentation, or think about a new feature.

Gandi loves Free and Open Source Software. This project is used internally at Gandi but external contributions are very welcome.

Authors

@mose - author and maintainer

License

This source code is available under MIT license.

Copyright

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.