CORS middleware with full W3C spec support
Find a file
Romain Prieto 9088f776e5 1.0.0
2017-07-04 13:14:32 +10:00
src Pre-process origin matchers for better performance (regexes created once only) 2017-05-23 13:39:58 +10:00
test Pre-process origin matchers for better performance (regexes created once only) 2017-05-23 13:39:58 +10:00
.gitignore First commit, supports 12/15 items of the spec 2014-05-08 12:16:17 +10:00
.npmignore Don't publish test code to npm (.npmignore) 2016-07-11 14:54:18 +10:00
.travis.yml chore: drop support for Node.js 0.10 2016-11-01 09:32:37 +11:00
package.json 1.0.0 2017-07-04 13:14:32 +10:00
README.md Support for * in the origin list for partial matches 2017-05-23 13:39:58 +10:00

restify-cors-middleware

CORS middleware with full W3C spec support.

NPM License

Build Status Dependencies Dev dependencies Peer dependencies Known Vulnerabilities

JavaScript Style Guide

Usage

const corsMiddleware = require('restify-cors-middleware')

const cors = corsMiddleware({
  preflightMaxAge: 5, //Optional
  origins: ['http://api.myapp.com', 'http://web.myapp.com'],
  allowHeaders: ['API-Token'],
  exposeHeaders: ['API-Token-Expiry']
})

server.pre(cors.preflight)
server.use(cors.actual)

Allowed origins

You can specify the full list of domains and subdomains allowed in your application:

origins: [
  'http://myapp.com',
  'http://*.myapp.com'
]

For added security, this middleware sets Access-Control-Allow-Origin to the origin that matched, not the configured wildcard. This means callers won't know about other domains that are supported.

Setting origins: ['*'] is also valid, although it comes with obvious security implications. Note that it will still return a customised response (matching Origin), so any caching layer (reverse proxy or CDN) will grow in size accordingly.

Troubleshooting

As per the spec, requests without an Origin will not receive any headers. Requests with a matching Origin will receive the appropriate response headers. Always be careful that any reverse proxies (e.g. Varnish) very their cache depending on the origin, so you don't serve CORS headers to the wrong request.

Compliance to the spec

See unit tests for examples of preflight and actual requests.