Blame view
node_modules/frameguard/README.md
1.66 KB
f7563de62
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
Frameguard ========== [](https://travis-ci.org/helmetjs/frameguard) [](http://standardjs.com/) [_Looking for a changelog?_](https://github.com/helmetjs/helmet/blob/master/HISTORY.md) The `X-Frame-Options` HTTP header restricts who can put your site in a frame which can help mitigate things like [clickjacking attacks](https://en.wikipedia.org/wiki/Clickjacking). It has three modes: `DENY`, `SAMEORIGIN`, and `ALLOW-FROM`. If your app does not need to be framed (and most don't) you can use the default `DENY`. If your site can be in frames from the same origin, you can set it to `SAMEORIGIN`. If you want to allow it from a specific URL, you can allow that with `ALLOW-FROM` and a URL. Usage: ```javascript var frameguard = require('frameguard') // Don't allow me to be in ANY frames: app.use(frameguard({ action: 'deny' })) // Only let me be framed by people of the same origin: app.use(frameguard({ action: 'sameorigin' })) app.use(frameguard()) // defaults to sameorigin // Allow from a specific host: app.use(frameguard({ action: 'allow-from', domain: 'http://example.com' })) ``` This has pretty good (but not 100%) browser support: IE8+, Opera 10.50+, Safari 4+, Chrome 4.1+, and Firefox 3.6.9+. The `ALLOW-FROM` header option is [not supported in most browsers](https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options#Browser_compatibility). Those browsers will ignore the entire header, [and the frame *will* be displayed](https://www.owasp.org/index.php/Clickjacking_Defense_Cheat_Sheet#Limitations_2). |