package
Express middleware to handle openapi security.
npm install express-openapi-securityGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 2 packages.
798.5 kB
Includes dependencies.
Moving forward you can use openapi-security-handler. See express-openapi for an example.
Express middleware to handle openapi security.
See ./test/data-driven/*.js for more examples.
var app = require('express')();
var securityDefinitions = {
keyScheme: {
type: 'apiKey',
name: 'api_key',
in: 'header'
},
passwordScheme: {
type: 'basic'
}
};
var securityHandlers = {
keyScheme: function(req, scopes, securityDefinition, cb) {
req.user = {name: 'fred'};
cb(null, true);// pass true if validation succeeds, false otherwise.
},
passwordScheme: function(req, scopes, securityDefinition, cb) {
req.user
express-openapi-security will respond in the following ways:
401
cb(null, false) is called from all securityHandlers.cb({status: 401, challange: 'a challenge string like "Basic"'}) is called
from at least one of the handlers in the last set of security handlers.403
cb({status: 403, message: 'some message'}) is called
from at least one of the handlers in the last set of security handlers.500
status is passed to cb.true.Upon successful authentication, next() is called.
The MIT License (MIT)
Copyright (c) 2016 Kogo Software LLC
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.