Basic authentication plugin

npm install hapi-auth-basic
7 downloads in the last day
69 downloads in the last week
293 downloads in the last month


hapi Basic authentication plugin

Build Status

Basic authentication requires validating a username and password combination. The 'basic' scheme takes the following options:

  • validateFunc - (required) a user lookup and password validation function with the signature function(username, password, callback) where:
    • username - the username received from the client.
    • password - the password received from the client.
    • callback - a callback function with the signature function(err, isValid, credentials) where:
      • err - an internal error.
      • isValid - true if both the username was found and the password matched, otherwise false.
      • credentials - a credentials object passed back to the application in request.auth.credentials. Typically, credentials are only included when isValid is true, but there are cases when the application needs to know who tried to authenticate even when it fails (e.g. with authentication mode 'try').
  • allowEmptyUsername - (optional) if true, allows making requests with an empty username. Defaults to false.
var Bcrypt = require('bcrypt');

var users = {
    john: {
        username: 'john',
        password: '$2a$10$iqJSHD.BGr0E2IxQwYgJmeP3NvhPrXAeLSaGCj6IR/XU5QtjVu5Tm',   // 'secret'
        name: 'John Doe',
        id: '2133d32a'

var validate = function (username, password, callback) {

    var user = users[username];
    if (!user) {
        return callback(null, false);

    Bcrypt.compare(password, user.password, function (err, isValid) {

        callback(err, isValid, { id: user.id, name: user.name });

server.pack.require('hapi-auth-basic', function (err) {

    server.auth.strategy('simple', 'basic', { validateFunc: validate });
    server.route({ method: 'GET', path: '/', config: { auth: 'simple' } });
npm loves you