summaryrefslogtreecommitdiff
path: root/node_modules/hawk/lib/server.js
diff options
context:
space:
mode:
authorArman <[email protected]>2018-08-02 16:50:59 -0700
committerArman <[email protected]>2018-08-02 16:50:59 -0700
commit7d5a0696ccc642db0d14aae8677ecada40bf85d1 (patch)
tree1bbbcf2f4c4a3a733326ac2401375f8d891cb2f1 /node_modules/hawk/lib/server.js
parentdialog box for adding items (diff)
downloadlauncher-7d5a0696ccc642db0d14aae8677ecada40bf85d1.tar.xz
launcher-7d5a0696ccc642db0d14aae8677ecada40bf85d1.zip
inital commit
Diffstat (limited to 'node_modules/hawk/lib/server.js')
-rwxr-xr-xnode_modules/hawk/lib/server.js550
1 files changed, 0 insertions, 550 deletions
diff --git a/node_modules/hawk/lib/server.js b/node_modules/hawk/lib/server.js
deleted file mode 100755
index c5b02ae..0000000
--- a/node_modules/hawk/lib/server.js
+++ /dev/null
@@ -1,550 +0,0 @@
-'use strict';
-
-// Load modules
-
-const Boom = require('boom');
-const Hoek = require('hoek');
-const Cryptiles = require('cryptiles');
-const Crypto = require('./crypto');
-const Utils = require('./utils');
-
-
-// Declare internals
-
-const internals = {};
-
-
-// Hawk authentication
-
-/*
- req: node's HTTP request object or an object as follows:
-
- const request = {
- method: 'GET',
- url: '/resource/4?a=1&b=2',
- host: 'example.com',
- port: 8080,
- authorization: 'Hawk id="dh37fgj492je", ts="1353832234", nonce="j4h3g2", ext="some-app-ext-data", mac="6R4rV5iE+NPoym+WwjeHzjAGXUtLNIxmo1vpMofpLAE="'
- };
-
- credentialsFunc: required function to lookup the set of Hawk credentials based on the provided credentials id.
- The credentials include the MAC key, MAC algorithm, and other attributes (such as username)
- needed by the application. This function is the equivalent of verifying the username and
- password in Basic authentication.
-
- const credentialsFunc = function (id, callback) {
-
- // Lookup credentials in database
- db.lookup(id, function (err, item) {
-
- if (err || !item) {
- return callback(err);
- }
-
- const credentials = {
- // Required
- key: item.key,
- algorithm: item.algorithm,
- // Application specific
- user: item.user
- };
-
- return callback(null, credentials);
- });
- };
-
- options: {
-
- hostHeaderName: optional header field name, used to override the default 'Host' header when used
- behind a cache of a proxy. Apache2 changes the value of the 'Host' header while preserving
- the original (which is what the module must verify) in the 'x-forwarded-host' header field.
- Only used when passed a node Http.ServerRequest object.
-
- nonceFunc: optional nonce validation function. The function signature is function(key, nonce, ts, callback)
- where 'callback' must be called using the signature function(err).
-
- timestampSkewSec: optional number of seconds of permitted clock skew for incoming timestamps. Defaults to 60 seconds.
- Provides a +/- skew which means actual allowed window is double the number of seconds.
-
- localtimeOffsetMsec: optional local clock time offset express in a number of milliseconds (positive or negative).
- Defaults to 0.
-
- payload: optional payload for validation. The client calculates the hash value and includes it via the 'hash'
- header attribute. The server always ensures the value provided has been included in the request
- MAC. When this option is provided, it validates the hash value itself. Validation is done by calculating
- a hash value over the entire payload (assuming it has already be normalized to the same format and
- encoding used by the client to calculate the hash on request). If the payload is not available at the time
- of authentication, the authenticatePayload() method can be used by passing it the credentials and
- attributes.hash returned in the authenticate callback.
-
- host: optional host name override. Only used when passed a node request object.
- port: optional port override. Only used when passed a node request object.
- }
-
- callback: function (err, credentials, artifacts) { }
- */
-
-exports.authenticate = function (req, credentialsFunc, options, callback) {
-
- callback = Hoek.nextTick(callback);
-
- // Default options
-
- options.nonceFunc = options.nonceFunc || internals.nonceFunc;
- options.timestampSkewSec = options.timestampSkewSec || 60; // 60 seconds
-
- // Application time
-
- const now = Utils.now(options.localtimeOffsetMsec); // Measure now before any other processing
-
- // Convert node Http request object to a request configuration object
-
- const request = Utils.parseRequest(req, options);
- if (request instanceof Error) {
- return callback(Boom.badRequest(request.message));
- }
-
- // Parse HTTP Authorization header
-
- const attributes = Utils.parseAuthorizationHeader(request.authorization);
- if (attributes instanceof Error) {
- return callback(attributes);
- }
-
- // Construct artifacts container
-
- const artifacts = {
- method: request.method,
- host: request.host,
- port: request.port,
- resource: request.url,
- ts: attributes.ts,
- nonce: attributes.nonce,
- hash: attributes.hash,
- ext: attributes.ext,
- app: attributes.app,
- dlg: attributes.dlg,
- mac: attributes.mac,
- id: attributes.id
- };
-
- // Verify required header attributes
-
- if (!attributes.id ||
- !attributes.ts ||
- !attributes.nonce ||
- !attributes.mac) {
-
- return callback(Boom.badRequest('Missing attributes'), null, artifacts);
- }
-
- // Fetch Hawk credentials
-
- credentialsFunc(attributes.id, (err, credentials) => {
-
- if (err) {
- return callback(err, credentials || null, artifacts);
- }
-
- if (!credentials) {
- return callback(Utils.unauthorized('Unknown credentials'), null, artifacts);
- }
-
- if (!credentials.key ||
- !credentials.algorithm) {
-
- return callback(Boom.internal('Invalid credentials'), credentials, artifacts);
- }
-
- if (Crypto.algorithms.indexOf(credentials.algorithm) === -1) {
- return callback(Boom.internal('Unknown algorithm'), credentials, artifacts);
- }
-
- // Calculate MAC
-
- const mac = Crypto.calculateMac('header', credentials, artifacts);
- if (!Cryptiles.fixedTimeComparison(mac, attributes.mac)) {
- return callback(Utils.unauthorized('Bad mac'), credentials, artifacts);
- }
-
- // Check payload hash
-
- if (options.payload ||
- options.payload === '') {
-
- if (!attributes.hash) {
- return callback(Utils.unauthorized('Missing required payload hash'), credentials, artifacts);
- }
-
- const hash = Crypto.calculatePayloadHash(options.payload, credentials.algorithm, request.contentType);
- if (!Cryptiles.fixedTimeComparison(hash, attributes.hash)) {
- return callback(Utils.unauthorized('Bad payload hash'), credentials, artifacts);
- }
- }
-
- // Check nonce
-
- options.nonceFunc(credentials.key, attributes.nonce, attributes.ts, (err) => {
-
- if (err) {
- return callback(Utils.unauthorized('Invalid nonce'), credentials, artifacts);
- }
-
- // Check timestamp staleness
-
- if (Math.abs((attributes.ts * 1000) - now) > (options.timestampSkewSec * 1000)) {
- const tsm = Crypto.timestampMessage(credentials, options.localtimeOffsetMsec);
- return callback(Utils.unauthorized('Stale timestamp', tsm), credentials, artifacts);
- }
-
- // Successful authentication
-
- return callback(null, credentials, artifacts);
- });
- });
-};
-
-
-// Authenticate payload hash - used when payload cannot be provided during authenticate()
-
-/*
- payload: raw request payload
- credentials: from authenticate callback
- artifacts: from authenticate callback
- contentType: req.headers['content-type']
-*/
-
-exports.authenticatePayload = function (payload, credentials, artifacts, contentType) {
-
- const calculatedHash = Crypto.calculatePayloadHash(payload, credentials.algorithm, contentType);
- return Cryptiles.fixedTimeComparison(calculatedHash, artifacts.hash);
-};
-
-
-// Authenticate payload hash - used when payload cannot be provided during authenticate()
-
-/*
- calculatedHash: the payload hash calculated using Crypto.calculatePayloadHash()
- artifacts: from authenticate callback
-*/
-
-exports.authenticatePayloadHash = function (calculatedHash, artifacts) {
-
- return Cryptiles.fixedTimeComparison(calculatedHash, artifacts.hash);
-};
-
-
-// Generate a Server-Authorization header for a given response
-
-/*
- credentials: {}, // Object received from authenticate()
- artifacts: {} // Object received from authenticate(); 'mac', 'hash', and 'ext' - ignored
- options: {
- ext: 'application-specific', // Application specific data sent via the ext attribute
- payload: '{"some":"payload"}', // UTF-8 encoded string for body hash generation (ignored if hash provided)
- contentType: 'application/json', // Payload content-type (ignored if hash provided)
- hash: 'U4MKKSmiVxk37JCCrAVIjV=' // Pre-calculated payload hash
- }
-*/
-
-exports.header = function (credentials, artifacts, options) {
-
- // Prepare inputs
-
- options = options || {};
-
- if (!artifacts ||
- typeof artifacts !== 'object' ||
- typeof options !== 'object') {
-
- return '';
- }
-
- artifacts = Hoek.clone(artifacts);
- delete artifacts.mac;
- artifacts.hash = options.hash;
- artifacts.ext = options.ext;
-
- // Validate credentials
-
- if (!credentials ||
- !credentials.key ||
- !credentials.algorithm) {
-
- // Invalid credential object
- return '';
- }
-
- if (Crypto.algorithms.indexOf(credentials.algorithm) === -1) {
- return '';
- }
-
- // Calculate payload hash
-
- if (!artifacts.hash &&
- (options.payload || options.payload === '')) {
-
- artifacts.hash = Crypto.calculatePayloadHash(options.payload, credentials.algorithm, options.contentType);
- }
-
- const mac = Crypto.calculateMac('response', credentials, artifacts);
-
- // Construct header
-
- let header = 'Hawk mac="' + mac + '"' +
- (artifacts.hash ? ', hash="' + artifacts.hash + '"' : '');
-
- if (artifacts.ext !== null &&
- artifacts.ext !== undefined &&
- artifacts.ext !== '') { // Other falsey values allowed
-
- header = header + ', ext="' + Hoek.escapeHeaderAttribute(artifacts.ext) + '"';
- }
-
- return header;
-};
-
-
-/*
- * Arguments and options are the same as authenticate() with the exception that the only supported options are:
- * 'hostHeaderName', 'localtimeOffsetMsec', 'host', 'port'
- */
-
-
-// 1 2 3 4
-internals.bewitRegex = /^(\/.*)([\?&])bewit\=([^&$]*)(?:&(.+))?$/;
-
-
-exports.authenticateBewit = function (req, credentialsFunc, options, callback) {
-
- callback = Hoek.nextTick(callback);
-
- // Application time
-
- const now = Utils.now(options.localtimeOffsetMsec);
-
- // Convert node Http request object to a request configuration object
-
- const request = Utils.parseRequest(req, options);
- if (request instanceof Error) {
- return callback(Boom.badRequest(request.message));
- }
-
- // Extract bewit
-
- if (request.url.length > Utils.limits.maxMatchLength) {
- return callback(Boom.badRequest('Resource path exceeds max length'));
- }
-
- const resource = request.url.match(internals.bewitRegex);
- if (!resource) {
- return callback(Utils.unauthorized());
- }
-
- // Bewit not empty
-
- if (!resource[3]) {
- return callback(Utils.unauthorized('Empty bewit'));
- }
-
- // Verify method is GET
-
- if (request.method !== 'GET' &&
- request.method !== 'HEAD') {
-
- return callback(Utils.unauthorized('Invalid method'));
- }
-
- // No other authentication
-
- if (request.authorization) {
- return callback(Boom.badRequest('Multiple authentications'));
- }
-
- // Parse bewit
-
- const bewitString = Hoek.base64urlDecode(resource[3]);
- if (bewitString instanceof Error) {
- return callback(Boom.badRequest('Invalid bewit encoding'));
- }
-
- // Bewit format: id\exp\mac\ext ('\' is used because it is a reserved header attribute character)
-
- const bewitParts = bewitString.split('\\');
- if (bewitParts.length !== 4) {
- return callback(Boom.badRequest('Invalid bewit structure'));
- }
-
- const bewit = {
- id: bewitParts[0],
- exp: parseInt(bewitParts[1], 10),
- mac: bewitParts[2],
- ext: bewitParts[3] || ''
- };
-
- if (!bewit.id ||
- !bewit.exp ||
- !bewit.mac) {
-
- return callback(Boom.badRequest('Missing bewit attributes'));
- }
-
- // Construct URL without bewit
-
- let url = resource[1];
- if (resource[4]) {
- url = url + resource[2] + resource[4];
- }
-
- // Check expiration
-
- if (bewit.exp * 1000 <= now) {
- return callback(Utils.unauthorized('Access expired'), null, bewit);
- }
-
- // Fetch Hawk credentials
-
- credentialsFunc(bewit.id, (err, credentials) => {
-
- if (err) {
- return callback(err, credentials || null, bewit.ext);
- }
-
- if (!credentials) {
- return callback(Utils.unauthorized('Unknown credentials'), null, bewit);
- }
-
- if (!credentials.key ||
- !credentials.algorithm) {
-
- return callback(Boom.internal('Invalid credentials'), credentials, bewit);
- }
-
- if (Crypto.algorithms.indexOf(credentials.algorithm) === -1) {
- return callback(Boom.internal('Unknown algorithm'), credentials, bewit);
- }
-
- // Calculate MAC
-
- const mac = Crypto.calculateMac('bewit', credentials, {
- ts: bewit.exp,
- nonce: '',
- method: 'GET',
- resource: url,
- host: request.host,
- port: request.port,
- ext: bewit.ext
- });
-
- if (!Cryptiles.fixedTimeComparison(mac, bewit.mac)) {
- return callback(Utils.unauthorized('Bad mac'), credentials, bewit);
- }
-
- // Successful authentication
-
- return callback(null, credentials, bewit);
- });
-};
-
-
-/*
- * options are the same as authenticate() with the exception that the only supported options are:
- * 'nonceFunc', 'timestampSkewSec', 'localtimeOffsetMsec'
- */
-
-exports.authenticateMessage = function (host, port, message, authorization, credentialsFunc, options, callback) {
-
- callback = Hoek.nextTick(callback);
-
- // Default options
-
- options.nonceFunc = options.nonceFunc || internals.nonceFunc;
- options.timestampSkewSec = options.timestampSkewSec || 60; // 60 seconds
-
- // Application time
-
- const now = Utils.now(options.localtimeOffsetMsec); // Measure now before any other processing
-
- // Validate authorization
-
- if (!authorization.id ||
- !authorization.ts ||
- !authorization.nonce ||
- !authorization.hash ||
- !authorization.mac) {
-
- return callback(Boom.badRequest('Invalid authorization'));
- }
-
- // Fetch Hawk credentials
-
- credentialsFunc(authorization.id, (err, credentials) => {
-
- if (err) {
- return callback(err, credentials || null);
- }
-
- if (!credentials) {
- return callback(Utils.unauthorized('Unknown credentials'));
- }
-
- if (!credentials.key ||
- !credentials.algorithm) {
-
- return callback(Boom.internal('Invalid credentials'), credentials);
- }
-
- if (Crypto.algorithms.indexOf(credentials.algorithm) === -1) {
- return callback(Boom.internal('Unknown algorithm'), credentials);
- }
-
- // Construct artifacts container
-
- const artifacts = {
- ts: authorization.ts,
- nonce: authorization.nonce,
- host,
- port,
- hash: authorization.hash
- };
-
- // Calculate MAC
-
- const mac = Crypto.calculateMac('message', credentials, artifacts);
- if (!Cryptiles.fixedTimeComparison(mac, authorization.mac)) {
- return callback(Utils.unauthorized('Bad mac'), credentials);
- }
-
- // Check payload hash
-
- const hash = Crypto.calculatePayloadHash(message, credentials.algorithm);
- if (!Cryptiles.fixedTimeComparison(hash, authorization.hash)) {
- return callback(Utils.unauthorized('Bad message hash'), credentials);
- }
-
- // Check nonce
-
- options.nonceFunc(credentials.key, authorization.nonce, authorization.ts, (err) => {
-
- if (err) {
- return callback(Utils.unauthorized('Invalid nonce'), credentials);
- }
-
- // Check timestamp staleness
-
- if (Math.abs((authorization.ts * 1000) - now) > (options.timestampSkewSec * 1000)) {
- return callback(Utils.unauthorized('Stale timestamp'), credentials);
- }
-
- // Successful authentication
-
- return callback(null, credentials);
- });
- });
-};
-
-
-internals.nonceFunc = function (key, nonce, ts, nonceCallback) {
-
- return nonceCallback(); // No validation
-};