1.0.0 • Published 6 years ago
redirect-whitelister v1.0.0
redirect-whitelister
npm install redirect-whitelister
Usage:
const RedirectWhitelister = require('redirect-whitelister');
const whitelister = new RedirectWhitelister(<domain-list>);
const validUrl = whitelister.verify('https://example.com/test/1234?s=test');
Options:
domain-list
- Either an array or single string domain. Domains may contain wildcards eg:test.*.example.com
. You can also use simple regex (see tests cases).
Overriding Protocols:
By default only http and https are allowed. If you need to change this, say to support a custom protocol for a mobile app:
const RedirectWhitelister = require('redirect-whitelister');
const whitelister = new RedirectWhitelister(<domain-list>);
whitelister.allowedProtocols = ['gopher:', 'http:', 'https:'];
Validating a url
verify(<url>)
- Returns a boolean if the url contains a domain that matches any of the allowed domains.
1.0.0
6 years ago