1.2.5 • Published 1 year ago

@utilitywarehouse/uw-lib-auth.js v1.2.5

Weekly downloads
11
License
MIT
Repository
github
Last release
1 year ago

This package is now deprecated, and should not be considered secure and will not be maintained

uw-lib-auth.js

A node.js module providing universal auth implementation for use in utilitywarehouse service implementation.

OAuth2 + JWT

This handler applies if a Authorization: Bearer <token> header is present. JWT verification is implemented using a private/public key pair where private part is held secretly by issuing server (uw-service-shepherd) and public key is issued to implementing services.

Extending with your own handlers

The module exposes an 'abstract' class module.Method.Method that your handler needs to be extending. You are required to implement following methods:

  • applies(headers hash) : bool - a synchronous function accepting a hash of request headers (all lowercase) that returns true if the correct header is present
  • execute(headers hash, callback fn(err, result)) : void - an asynchronous function accepting a hash of request headers and a result callback, any result out of the auth process can be passed in the callback and will be attached to reques

Usage

const express = require('express');
const path = require('path');
const app = express();

const authModule = require('./..');

const auth = new authModule.Provider([
	new authModule.Method.oAuth2JWT({
		key: authModule.Key.fromFile(path.join(__dirname, '../tests/resources/public.pem')),
		algo: [authModule.Key.RS256]
	})
]);

app.use(auth.middleware());

app.get('/:id', /*auth.middleware.scope('partner.:id.read'),*/ function (req, res) {
  res.json({auth: req.auth});
});

app.use((error, req, res, next) => {
	res.status(error.status).json(error);
});

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

NPM

Lib is published on NPM under the utilitywarehosue namespace. It is public.

yarn add @utilitywarehouse/uw-lib-auth.js

1.2.5

1 year ago

1.2.4

2 years ago

1.2.3

5 years ago

1.2.2

7 years ago

1.2.0

7 years ago

1.1.3

7 years ago

1.1.2

7 years ago

1.1.1

7 years ago