can-iframe-url
v1.0.0
Published
Detect if an url can be included in an by detecting the X-Frame-Options header with a HEAD request.
Downloads
351
Maintainers
Readme
can-iframe-url (in active development)
Detect if an url can be included in an by detecting the
X-Frame-Options
header with a OPTIONS request.
Install
npm install can-iframe-url
or yarn add can-iframe-url
Compatibility
This package compatibility depends on the Fetch API and on promises.
UMD compatible.
Note : this library does not handle how browsers behaviors might differ from each other. This is purely based on the X-Frame-Options
intended behavior.
Usage
Node.js
// Exports a function that returns a Promise
const canIframeUrl = require('can-iframe-url');
const includeAllowed = await canIframeUrl('http://google.com', null);
const includeAllowed = await canIframeUrl('http://google.com', 'google.com');
// false
Browser
const includeAllowed = await window.canIframeUrl('http://google.com', window.location.hostname);
// false
TODO
- API docs
License
MIT License
Copyright (c) 2018-2019 Nicolas COUTIN
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.