restify-cors-middleware2
v2.2.1
Published
CORS middleware with full W3C spec support
Downloads
49,161
Maintainers
Readme
restify-cors-middleware2
CORS middleware with full W3C spec support.
Setup
$ npm install restify-cors-middleware2 --save
Usage
const corsMiddleware = require('restify-cors-middleware2')
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, using strings or regular expressions.
origins: [
'http://myapp.com',
'http://*.myapp.com',
/^https?:\/\/myapp.com(:[\d]+)?$/
]
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.
By default, credentials are not allowed for the *
origin. This can be
overridden with the allowCredentialsAllOrigins
option.
Troubleshooting
As per the spec, requests without an Origin
will not receive any CORS headers. Requests with a matching Origin
will receive the appropriate response headers. Always be careful that any reverse proxies (e.g. Varnish) vary 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.
TypeScript declaration file support
A basic declaration file has been added (thanks to Dane Horak), but we don't use TypeScript locally, so we have not validated it. Let us know if there is more that can be added.