package
a simple slay preboot to instantiate an auth middleware and a custom/default lookup function on the app object
npm install authbootGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
A simple slay preboot that initializes an authboot namespaced lookup function
and middeware on the app object to be used within the application. Its meant
to wrap up some configuration conventions to be more easily reused in multiple
slay applications without duplicating code unnecessarily.
The purpose of this library is to simply wrap an auth middleware (currently basic-auth based)
and give a mechanism for async validation of that auth. We support
properties of express-basic-auth as configuration. The lookup function
replaces the authorizer function with a slightly tweaked API which we will cover
below.
npm install authboot --saveusers - ObjectThe users object we give contains assumptions if you are not passing in your
own lookup function. Those assumptions is that that each key must be the
username for your authorized users while the value must be a hexidecimal encoding of the sha256 hash of the password. This ensures we are following security best practices even
when this information is loaded in memory from an encrypted config.
lookup({ name, password }, callback)Function to override the default behavior of using the users object as
a direct comparison map for who is authorized and using the provided algorithm to
compare the given password with the hash we have stored as part of the users
object.
challenge BooleanIndicating whether we will send a challenge response for browser based requests.
realm StringThe realm given for the service for browser storage of basic auth.
algorithm StringThe algorithm given to crypto when creating a hash.
// root slay preboot in preboots/index.js or preboots.js
module.exports = function (app, opts, callback) {
app.preboot(require('authboot')({
users: {
name: 'hexOfSHA256HashOfPassword'
},
// send challenge request for browser auth
challenge: true,
realm: 'myservicerealm'
}));
callback();
};// middlewares/index.js or middlewares.js
module.exports = function (app, options, callback) {
// add the middleware itself to the app object when you setup all your other
// middlewares. If its not going to be used across the board for all routes,
// this would be setup in each route handler or on the router itself.
app.use(app.authboot.middleware);
};
const db = require('./db');
const verify = require('./verify');
// root slay preboot in preboots/index.js or preboots.js
module.exports = function (app, opts, callback) {
app.preboot(require('authboot')({
// override lookup with our own async lookup
lookup: ({ user, password }, callback) => {
db.users.get(user, (err, user) => {
if (err) return callback(err);
verify.password(user.passwordHash, password, callback);
});
},
// send challenge request for browser auth
challenge:
// routes/index.js or routes.js
const db = require('./db');
module.exports = function (app, options, callback) {
app.routes.get('/resource', app.authboot.middleware, (req, res, next) => {
// authed route
db.resource.get(req.params, (err, resource) => {
if (err) return next(err);
res.status(200).json(resource);
})
});
};
npm testkinetifex
andrew@kinetifex.com
kquerna
kirsten@querna.org
3rdeden
npmjs@3rd-Eden.com
jcrugzz
jcrugzz@gmail.com
jgowdy
jeremiah@gowdy.me
swaagie
martijn@swaagman.online
jpina1-godaddy
jpina1@godaddy.com
mmason2
mmason2@godaddy.com
sgore-godaddy
sgore@godaddy.com
rmarkins
rmarkins@godaddy.com
wcole1-godaddy
wcole1@godaddy.com
indexzero
charlie.robbins@gmail.com
bradleymeck
bradley.meck@gmail.com
decompil3d
npm@jonathankeslin.com
msluther
msluther99@gmail.com
Estimated unpacked size across 9 packages.
434.8 kB
Includes dependencies.