@mojaloop/central-services-auth

Authentication module for central services

Stats

StarsIssuesVersionUpdatedCreatedSize
@mojaloop/central-services-auth
075.2.13 years ago4 years agoMinified + gzip package size for @mojaloop/central-services-auth in KB

Readme

central-services-auth

Share authentication and authorization code for central services

Registering this module with hapi with install an authentication scheme with the name 'basic'

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

  • validate - (required) a user lookup and password validation function with the signature function(request, username, password, callback) where:
    • request - is the hapi request object of the request which is being authenticated.
    • 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').
const Bcrypt = require('bcrypt');

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

const validate = function (request, username, password, callback) {

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

    Bcrypt.compare(password, user.password, (err, isValid) => {

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

server.register(require('@@mojaloop/central-services-shared'))

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.