auth0 2.37.0 → 2.40.0

package/src/auth/UsersManager.js

@@ -1,172 +1,161 @@
-var extend = require('util')._extend;
-var axios = require('axios');
+const axios = require('axios');
 
-var ArgumentError = require('rest-facade').ArgumentError;
+const { ArgumentError } = require('rest-facade');
 
 /**
- * @class UsersManager
  * Provides methods for getting user information and impersonating users.
- * @constructor
- * @memberOf module:auth
- *
- * @param  {Object}   options               Manager options.
- * @param  {String}   options.baseUrl       The auth0 account URL.
- * @param  {String}   [options.headers]     Default request headers.
- * @param  {String}   [options.clientId]    Default client ID.
  */
-var UsersManager = function(options) {
-  if (typeof options !== 'object') {
-    throw new ArgumentError('Missing users manager options');
+class UsersManager {
+  /**
+   * @param  {object}   options               Manager options.
+   * @param  {string}   options.baseUrl       The auth0 account URL.
+   * @param  {string}   [options.headers]     Default request headers.
+   * @param  {string}   [options.clientId]    Default client ID.
+   */
+  constructor(options) {
+    if (typeof options !== 'object') {
+      throw new ArgumentError('Missing users manager options');
+    }
+
+    if (typeof options.baseUrl !== 'string') {
+      throw new ArgumentError('baseUrl field is required');
+    }
+
+    this.baseUrl = options.baseUrl;
+    this.headers = options.headers;
+    this.clientId = options.clientId;
   }
 
-  if (typeof options.baseUrl !== 'string') {
-    throw new ArgumentError('baseUrl field is required');
+  /**
+   * Given an access token get the user profile linked to it.
+   *
+   * @example <caption>
+   *   Get the user information based on the Auth0 access token (obtained during
+   *   login). Find more information in the
+   *   <a href="https://auth0.com/docs/auth-api#!#get--userinfo">API Docs</a>.
+   * </caption>
+   *
+   * auth0.users.getInfo(accessToken, function (err, userInfo) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(userInfo);
+   * });
+   * @param   {string}    accessToken   User access token.
+   * @param   {Function}  [cb]          Callback function.
+   * @returns  {Promise|undefined}
+   */
+  getInfo(accessToken, cb) {
+    const url = `${this.baseUrl}/userinfo`;
+    const headers = { ...this.headers };
+
+    if (accessToken === null || accessToken === undefined) {
+      throw new ArgumentError('An access token is required');
+    }
+
+    if (typeof accessToken !== 'string' || accessToken.trim().length === 0) {
+      throw new ArgumentError('Invalid access token');
+    }
+
+    // Send the user access token in the Authorization header.
+    headers['Authorization'] = `Bearer ${accessToken}`;
+
+    // Perform the request.
+    const promise = axios({
+      method: 'GET',
+      url,
+      headers,
+    }).then(({ data }) => data);
+
+    // Use callback if given.
+    if (cb instanceof Function) {
+      promise.then(cb.bind(null, null)).catch(cb);
+      return;
+    }
+
+    return promise;
   }
 
-  this.baseUrl = options.baseUrl;
-  this.headers = options.headers;
-  this.clientId = options.clientId;
-};
-
-/**
- * Given an access token get the user profile linked to it.
- *
- * @method    getInfo
- * @memberOf  module:auth.UsersManager.prototype
- *
- * @example <caption>
- *   Get the user information based on the Auth0 access token (obtained during
- *   login). Find more information in the
- *   <a href="https://auth0.com/docs/auth-api#!#get--userinfo">API Docs</a>.
- * </caption>
- *
- * auth0.users.getInfo(accessToken, function (err, userInfo) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(userInfo);
- * });
- *
- * @param   {String}    accessToken   User access token.
- * @param   {Function}  [cb]          Callback function.
- *
- * @return  {Promise|undefined}
- */
-UsersManager.prototype.getInfo = function(accessToken, cb) {
-  var url = this.baseUrl + '/userinfo';
-  var headers = extend({}, this.headers);
-
-  if (accessToken === null || accessToken === undefined) {
-    throw new ArgumentError('An access token is required');
+  /**
+   * Impersonate the user with the given user ID.
+   *
+   * @example <caption>
+   *   Gets a link that can be used once to log in as a specific user. Useful for
+   *   troubleshooting. Find more information in the
+   *   [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate).
+   * </caption>
+   *
+   * var settings = {
+   *   impersonator_id: '{IMPERSONATOR_ID}',
+   *   protocol: 'oauth2',
+   *   additionalParameters: {}  // Optional additional params.
+   * };
+   *
+   * auth0.users.impersonate(userId, settings, function (err, link) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   console.log(link);
+   * });
+   * @param   {string}    userId                    User ID token.
+   * @param   {object}    settings                  Impersonation settings.
+   * @param   {string}    settings.impersonator_id  Impersonator user ID.
+   * @param   {string}    settings.protocol         The authentication protocol.
+   * @param   {string}    settings.token            API v1 token obtained for impersonation
+   * @param   {string}    [settings.clientId]       Client id used for impersonation. Uses the one supplied in the constructor by default.
+   * @param   {Function}  [cb]                      Callback function.
+   * @returns  {Promise|undefined}
+   */
+  impersonate(userId, settings, cb) {
+    const url = `${this.baseUrl}/users/${userId}/impersonate`;
+
+    if (userId === null || userId === undefined) {
+      throw new ArgumentError('You must specify a user ID');
+    }
+
+    if (typeof userId !== 'string' || userId.trim().length === 0) {
+      throw new ArgumentError('The user ID is not valid');
+    }
+
+    if (typeof settings !== 'object') {
+      throw new ArgumentError('Missing impersonation settings object');
+    }
+
+    if (
+      typeof settings.impersonator_id !== 'string' ||
+      settings.impersonator_id.trim().length === 0
+    ) {
+      throw new ArgumentError('impersonator_id field is required');
+    }
+
+    if (typeof settings.protocol !== 'string' || settings.protocol.trim().length === 0) {
+      throw new ArgumentError('protocol field is required');
+    }
+
+    if (typeof settings.token !== 'string' || settings.token.trim().length === 0) {
+      throw new ArgumentError('token field is required');
+    }
+
+    const data = { client_id: settings.clientId || this.clientId, ...settings };
+    const headers = { Authorization: `Bearer ${settings.token}`, ...this.headers };
+    // Perform the request.
+    const promise = axios({
+      method: 'POST',
+      headers,
+      data,
+      url,
+    }).then(({ data }) => data);
+
+    // Use callback if given.
+    if (cb instanceof Function) {
+      promise.then(cb.bind(null, null)).catch(cb);
+      return;
+    }
+
+    return promise;
   }
-
-  if (typeof accessToken !== 'string' || accessToken.trim().length === 0) {
-    throw new ArgumentError('Invalid access token');
-  }
-
-  // Send the user access token in the Authorization header.
-  headers['Authorization'] = 'Bearer ' + accessToken;
-
-  // Perform the request.
-  var promise = axios({
-    method: 'GET',
-    url: url,
-    headers: headers
-  }).then(({ data }) => data);
-
-  // Use callback if given.
-  if (cb instanceof Function) {
-    promise.then(cb.bind(null, null)).catch(cb);
-    return;
-  }
-
-  return promise;
-};
-
-/**
- * Impersonate the user with the given user ID.
- *
- * @method    impersonate
- * @memberOf  module:auth.UsersManager.prototype
- *
- * @example <caption>
- *   Gets a link that can be used once to log in as a specific user. Useful for
- *   troubleshooting. Find more information in the
- *   [API Docs](https://auth0.com/docs/auth-api#!#post--users--user_id--impersonate).
- * </caption>
- *
- * var settings = {
- *   impersonator_id: '{IMPERSONATOR_ID}',
- *   protocol: 'oauth2',
- *   additionalParameters: {}  // Optional additional params.
- * };
- *
- * auth0.users.impersonate(userId, settings, function (err, link) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   console.log(link);
- * });
- *
- * @param   {String}    userId                    User ID token.
- * @param   {Object}    settings                  Impersonation settings.
- * @param   {String}    settings.impersonator_id  Impersonator user ID.
- * @param   {String}    settings.protocol         The authentication protocol.
- * @param   {String}    settings.token            API v1 token obtained for impersonation
- * @param   {String}    [settings.clientId]       Client id used for impersonation. Uses the one supplied in the constructor by default.
- * @param   {Function}  [cb]]                     Callback function.
- *
- * @return  {Promise|undefined}
- */
-UsersManager.prototype.impersonate = function(userId, settings, cb) {
-  var url = this.baseUrl + '/users/' + userId + '/impersonate';
-
-  if (userId === null || userId === undefined) {
-    throw new ArgumentError('You must specify a user ID');
-  }
-
-  if (typeof userId !== 'string' || userId.trim().length === 0) {
-    throw new ArgumentError('The user ID is not valid');
-  }
-
-  if (typeof settings !== 'object') {
-    throw new ArgumentError('Missing impersonation settings object');
-  }
-
-  if (
-    typeof settings.impersonator_id !== 'string' ||
-    settings.impersonator_id.trim().length === 0
-  ) {
-    throw new ArgumentError('impersonator_id field is required');
-  }
-
-  if (typeof settings.protocol !== 'string' || settings.protocol.trim().length === 0) {
-    throw new ArgumentError('protocol field is required');
-  }
-
-  if (typeof settings.token !== 'string' || settings.token.trim().length === 0) {
-    throw new ArgumentError('token field is required');
-  }
-
-  var data = extend({ client_id: settings.clientId || this.clientId }, settings);
-  var headers = extend({ Authorization: `Bearer ${settings.token}` }, this.headers);
-  // Perform the request.
-  var promise = axios({
-    method: 'POST',
-    headers: headers,
-    data: data,
-    url: url
-  }).then(({ data }) => data);
-
-  // Use callback if given.
-  if (cb instanceof Function) {
-    promise.then(cb.bind(null, null)).catch(cb);
-    return;
-  }
-
-  return promise;
-};
+}
 
 module.exports = UsersManager;

package/src/auth/idToken.js

@@ -1,13 +1,15 @@
-var urlDecodeB64 = function(data) {
+const urlDecodeB64 = function (data) {
   return Buffer.from(data, 'base64').toString('utf8');
 };
 
 /**
  * Decodes a string token into the 3 parts, throws if the format is invalid
- * @param token
+ *
+ * @param {string} token token
+ * @returns {object}
  */
-var decode = function(token) {
-  var parts = token.split('.');
+const decode = function (token) {
+  const parts = token.split('.');
 
   if (parts.length !== 3) {
     throw new Error('ID token could not be decoded');
@@ -17,34 +19,35 @@ var decode = function(token) {
     _raw: token,
     header: JSON.parse(urlDecodeB64(parts[0])),
     payload: JSON.parse(urlDecodeB64(parts[1])),
-    signature: parts[2]
+    signature: parts[2],
   };
 };
 
-var DEFAULT_LEEWAY = 60; //default clock-skew, in seconds
+const DEFAULT_LEEWAY = 60; //default clock-skew, in seconds
 
 /**
  * Validator for ID Tokens following OIDC spec.
- * @param token the string token to verify
- * @param options the options required to run this verification
- * @returns A promise containing the decoded token payload, or throws an exception if validation failed
+ *
+ * @param {string} token the string token to verify
+ * @param {object} options the options required to run this verification
+ * @returns {object} The decoded token payload, or throws an exception if validation failed
  */
-var validate = function(token, options) {
+const validate = function (token, options) {
   if (!token) {
     throw new Error('ID token is required but missing');
   }
 
-  var decodedToken = decode(token);
+  const decodedToken = decode(token);
 
   // Check algorithm
-  var header = decodedToken.header;
+  const { header } = decodedToken;
   if (header.alg !== 'RS256' && header.alg !== 'HS256') {
     throw new Error(
       `Signature algorithm of "${header.alg}" is not supported. Expected the ID token to be signed with "RS256" or "HS256".`
     );
   }
 
-  var payload = decodedToken.payload;
+  const { payload } = decodedToken;
 
   // Issuer
   if (!payload.iss || typeof payload.iss !== 'string') {
@@ -93,14 +96,14 @@ var validate = function(token, options) {
   }
 
   // --Time validation (epoch)--
-  var now = Math.floor(Date.now() / 1000);
-  var leeway = options.leeway || DEFAULT_LEEWAY;
+  const now = Math.floor(Date.now() / 1000);
+  const leeway = options.leeway || DEFAULT_LEEWAY;
 
   // Expires at
   if (!payload.exp || typeof payload.exp !== 'number') {
     throw new Error('Expiration Time (exp) claim must be a number present in the ID token');
   }
-  var expTime = payload.exp + leeway;
+  const expTime = payload.exp + leeway;
 
   if (now > expTime) {
     throw new Error(
@@ -147,7 +150,7 @@ var validate = function(token, options) {
       );
     }
 
-    var authValidUntil = payload.auth_time + options.maxAge + leeway;
+    const authValidUntil = payload.auth_time + options.maxAge + leeway;
     if (now > authValidUntil) {
       throw new Error(
         `Authentication Time (auth_time) claim in the ID token indicates that too much time has passed since the last end-user authentication. Currrent time (${now}) is after last auth at ${authValidUntil}`
@@ -159,6 +162,6 @@ var validate = function(token, options) {
 };
 
 module.exports = {
-  decode: decode,
-  validate: validate
+  decode,
+  validate,
 };