Skip to content

a very simple, minimalistic basic authentication tool, that will mostly serve as a middleware.

License

Notifications You must be signed in to change notification settings

Allaye/nub-auth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nub-auth

npm version npm TypeScript compatible MIT Licence

a very simple, minimalistic basic authentication tool, that will mostly serve as a middleware.

How to Install and Installation information

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

type below command in your terminal

npm install nub-auth

How to use it

The module interface exposes just a single function that expects a single argument

var express = require('express');
var nubAuth = require('nub-auth');
app = express();

app.use(['/v1'], nubAuth({
    challenge: true,
    users: { 'admins': 'admin', 'users': 'user', 'guest': 'guested' }
}));
app.get('/', function(req, res) {
    res.send('Hello World!');
});

app.get('/api', (req, res) => {
    res.send('Hello World welcome to API endpoints free !');
});

app.get("/v1", (req, res) => {
  res.send("Hello World welcome to API endpoints closed !");
});

app.listen(3000, function() {
    console.log('Example app listening on port 3000!');
});

argument users

You should pass an objects with users and password as key value pairs

argument chanllenge

By defaults the tools does not force the browser to display a basic chanllenge to the user, set this to true to force the browser to display a chanllenge. NB browsers like chromium edge will not display a chanellege, you have to set this on your browser settings.

About

a very simple, minimalistic basic authentication tool, that will mostly serve as a middleware.

Resources

License

Stars

Watchers

Forks

Packages

No packages published