express-basicauth

1.0.2 • Public • Published

express-basicauth

Build Status

A simple express middleware for basic authentication

How to install

Install with npm:

npm install --save express-basicauth

How to use with Express

This will authenticate if username entered is 'username' and password entered is 'password'.

var express = require('express');
var basicAuth = require('express-basicauth');
var app = express();
 
 
app.use(basicAuth());

Using a custom username and password:

var express = require('express');
var basicAuth = require('express-basicauth');
var app = express();
 
 
app.use(basicAuth({username: 'name', password: 'pass' }));

You can also optionally provide your own custom athenticator.

var express = require('express');
var basicAuth = require('express-basicauth');
var app = express();
 
/**
 * All you need is a function which returns a promise that is resolved once authenticated.
 * You can also use async functions for this 
 */
function myCustomAuthenticator(username, password) {
    let authenticated = false;
 
    // add authentication logic 
 
    return authenticated ? Promise.resolve() : Promise.reject();
}
 
app.use(basicAuth({authenticator: myCustomAuthenticator}));

Readme

Keywords

none

Package Sidebar

Install

npm i express-basicauth

Weekly Downloads

112

Version

1.0.2

License

MIT

Last publish

Collaborators

  • mariusespejo