A library to process OpenAPI security definitions in parallel.
Highlights
Easily handle security schemes.
Performant.
Extensively tested.
Small footprint.
Promise based interface.
Example
See ./test/data-driven/*.js for more examples.
import OpenAPISecurityHandler from 'openapi-security-handler';const handler = new OpenAPISecurityHandler({ // these are typically taken from the global api doc securityDefinitions: { keyScheme: { type: 'apiKey', name: 'api_key', in: 'header' }, passwordScheme: { type: 'basic' } }, // these handle the operation security reference securityHandlers: { keyScheme: function(req, scopes, securityDefinition) { req.user = {name: 'fred'}; return true; // could also throw or return a Promise. }, passwordScheme
handler.handle
Return Value
openapi-security-handler#handle returns a Promise.
If any of the securityHandlers throw an error, the error will be available with .catch.
If all of the securityHandlers for the given operationSecurity scheme resolve with true, then true will be resolved.
If none of the securityHandlers resolve with true for all of the operationSecurity schemes, then a 401 error will be thrown.
Successful Authentication
Handlers should assign credentials to the request object.
LICENSE
The MIT License (MIT)Copyright (c) 2018 Kogo Software LLCPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, 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 INTHE SOFTWARE.
:
function
(req, scopes, securityDefinition) {
req.user = {name: 'fred'};
return true;
}
},
// These are typically defined on an operation's openapi document.
operationSecurity: [
// we'll execute all the schemes in the object. If any fail, we'll move to the