Merge branch 'master' into master

auth0 · May 22, 2019 · ce7476c · ce7476c
2 parents 2a5ea06 + 699f285
commit ce7476c
Show file tree

Hide file tree

Showing 96 changed files with 24,927 additions and 5,782 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+*	@auth0/sdk-team-approvers
diff --git a/.gitignore b/.gitignore
@@ -33,7 +33,7 @@ node_modules
 # Compressed files.
 *.tgz
 
-# InelliJ IDEA
+# IntelliJ IDEA
 .idea
 
 build
@@ -43,4 +43,7 @@ test-results.xml
 
 # Release process
 .release
-.release-tmp-*/
+.release-tmp-*/
+
+# npm
+package-lock.json
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,34 @@
 # Change Log
 
+## [v2.17.0](https://github.com/auth0/node-auth0/tree/v2.17.0) (2019-04-15)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.16.0...v2.17.0)
+
+**Added**
+
+* Add method to assign users to a role [\#348](https://github.com/auth0/node-auth0/pull/348) ([pushpabrol](https://github.com/pushpabrol))
+* Add support for roles and permissions [\#344](https://github.com/auth0/node-auth0/pull/344) ([pushpabrol](https://github.com/pushpabrol))
+
+## [v2.16.0](https://github.com/auth0/node-auth0/tree/v2.16.0) (2019-03-18)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.15.0...v2.16.0)
+
+**Added**
+
+* Add support for Auth0 Grants [\#343](https://github.com/auth0/node-auth0/pull/343) ([jsmpereira](https://github.com/jsmpereira))
+
+## [v2.15.0](https://github.com/auth0/node-auth0/tree/v2.15.0) (2019-03-11)
+
+[Full Changelog](https://github.com/auth0/node-auth0/compare/v2.14.0...v2.15.0)
+
+**Added**
+
+* Add users-exports endpoint [\#340](https://github.com/auth0/node-auth0/pull/340) ([arjenvanderende](https://github.com/arjenvanderende))
+
+**Fixed**
+
+* Don't validate id_token when alg is HS256 and there is no clientSecret [\#330](https://github.com/auth0/node-auth0/pull/330) ([luisrudge](https://github.com/luisrudge))
+
 ## [v2.14.0](https://github.com/auth0/node-auth0/tree/v2.14.0) (2018-11-12)
 
 [Full Changelog](https://github.com/auth0/node-auth0/compare/v2.13.0...v2.14.0)

diff --git a/docs/RetryRestClient.js.html b/docs/RetryRestClient.js.html
diff --git a/docs/auth_DatabaseAuthenticator.js.html b/docs/auth_DatabaseAuthenticator.js.html
diff --git a/docs/auth_OAUthWithIDTokenValidation.js.html b/docs/auth_OAUthWithIDTokenValidation.js.html
diff --git a/docs/auth_OAuthAuthenticator.js.html b/docs/auth_OAuthAuthenticator.js.html
diff --git a/docs/auth_PasswordlessAuthenticator.js.html b/docs/auth_PasswordlessAuthenticator.js.html
diff --git a/docs/auth_TokensManager.js.html b/docs/auth_TokensManager.js.html
diff --git a/docs/auth_UsersManager.js.html b/docs/auth_UsersManager.js.html
diff --git a/docs/auth_index.js.html b/docs/auth_index.js.html
diff --git a/docs/external-RestClient.html b/docs/external-RestClient.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/index.js.html b/docs/index.js.html
diff --git a/docs/management_BlacklistedTokensManager.js.html b/docs/management_BlacklistedTokensManager.js.html
diff --git a/docs/management_ClientGrantsManager.js.html b/docs/management_ClientGrantsManager.js.html
diff --git a/docs/management_ClientsManager.js.html b/docs/management_ClientsManager.js.html
diff --git a/docs/management_ConnectionsManager.js.html b/docs/management_ConnectionsManager.js.html
diff --git a/docs/management_CustomDomainsManager.js.html b/docs/management_CustomDomainsManager.js.html
diff --git a/docs/management_DeviceCredentialsManager.js.html b/docs/management_DeviceCredentialsManager.js.html
diff --git a/docs/management_EmailProviderManager.js.html b/docs/management_EmailProviderManager.js.html
diff --git a/docs/management_EmailTemplatesManager.js.html b/docs/management_EmailTemplatesManager.js.html
diff --git a/docs/management_GrantsManager.js.html b/docs/management_GrantsManager.js.html
diff --git a/docs/management_GuardianManager.js.html b/docs/management_GuardianManager.js.html
diff --git a/docs/management_JobsManager.js.html b/docs/management_JobsManager.js.html
diff --git a/docs/management_LogsManager.js.html b/docs/management_LogsManager.js.html
diff --git a/docs/management_ManagementTokenProvider.js.html b/docs/management_ManagementTokenProvider.js.html
diff --git a/docs/management_ResourceServersManager.js.html b/docs/management_ResourceServersManager.js.html
diff --git a/docs/management_RolesManager.js.html b/docs/management_RolesManager.js.html
diff --git a/docs/management_RulesConfigsManager.js.html b/docs/management_RulesConfigsManager.js.html
diff --git a/docs/management_RulesManager.js.html b/docs/management_RulesManager.js.html
diff --git a/docs/management_StatsManager.js.html b/docs/management_StatsManager.js.html
diff --git a/docs/management_TenantManager.js.html b/docs/management_TenantManager.js.html
diff --git a/docs/management_TicketsManager.js.html b/docs/management_TicketsManager.js.html
diff --git a/docs/management_UsersManager.js.html b/docs/management_UsersManager.js.html
diff --git a/docs/management_index.js.html b/docs/management_index.js.html
diff --git a/docs/module-auth.AuthenticationClient.html b/docs/module-auth.AuthenticationClient.html
diff --git a/docs/module-auth.DatabaseAuthenticator.html b/docs/module-auth.DatabaseAuthenticator.html
diff --git a/docs/module-auth.OAUthWithIDTokenValidation.html b/docs/module-auth.OAUthWithIDTokenValidation.html
diff --git a/docs/module-auth.OAuthAuthenticator.html b/docs/module-auth.OAuthAuthenticator.html
diff --git a/docs/module-auth.PasswordlessAuthenticator.html b/docs/module-auth.PasswordlessAuthenticator.html
diff --git a/docs/module-auth.TokensManager.html b/docs/module-auth.TokensManager.html
diff --git a/docs/module-auth.UsersManager.html b/docs/module-auth.UsersManager.html
diff --git a/docs/module-auth.html b/docs/module-auth.html
diff --git a/docs/module-management.BlacklistedTokensManager.html b/docs/module-management.BlacklistedTokensManager.html
diff --git a/docs/module-management.ClientGrantsManager.html b/docs/module-management.ClientGrantsManager.html
diff --git a/docs/module-management.ClientsManager.html b/docs/module-management.ClientsManager.html
diff --git a/docs/module-management.ConnectionsManager.html b/docs/module-management.ConnectionsManager.html
diff --git a/docs/module-management.CustomDomainsManager.html b/docs/module-management.CustomDomainsManager.html
diff --git a/docs/module-management.DeviceCredentialsManager.html b/docs/module-management.DeviceCredentialsManager.html
diff --git a/docs/module-management.EmailProviderManager.html b/docs/module-management.EmailProviderManager.html
diff --git a/docs/module-management.EmailTemplatesManager.html b/docs/module-management.EmailTemplatesManager.html
diff --git a/docs/module-management.GrantsManager.html b/docs/module-management.GrantsManager.html
diff --git a/docs/module-management.GuardianManager.html b/docs/module-management.GuardianManager.html
diff --git a/docs/module-management.JobsManager.html b/docs/module-management.JobsManager.html
diff --git a/docs/module-management.LogsManager.html b/docs/module-management.LogsManager.html
diff --git a/docs/module-management.ManagementClient.html b/docs/module-management.ManagementClient.html
diff --git a/docs/module-management.ManagementTokenProvider.html b/docs/module-management.ManagementTokenProvider.html
diff --git a/docs/module-management.ResourceServersManager.html b/docs/module-management.ResourceServersManager.html
diff --git a/docs/module-management.RetryRestClient.html b/docs/module-management.RetryRestClient.html
diff --git a/docs/module-management.RolesManager.html b/docs/module-management.RolesManager.html
diff --git a/docs/module-management.RulesConfigsManager.html b/docs/module-management.RulesConfigsManager.html
diff --git a/docs/module-management.RulesManager.html b/docs/module-management.RulesManager.html
diff --git a/docs/module-management.StatsManager.html b/docs/module-management.StatsManager.html
diff --git a/docs/module-management.TenantManager.html b/docs/module-management.TenantManager.html
diff --git a/docs/module-management.TicketsManager.html b/docs/module-management.TicketsManager.html
diff --git a/docs/module-management.UsersManager.html b/docs/module-management.UsersManager.html
diff --git a/docs/module-management.html b/docs/module-management.html
diff --git a/docs/module-utils.html b/docs/module-utils.html
diff --git a/docs/utils.js.html b/docs/utils.js.html
diff --git a/package.json b/package.json
@@ -1,15 +1,16 @@
 {
   "name": "auth0",
-  "version": "2.14.0",
+  "version": "2.17.0",
   "description": "SDK for Auth0 API v2",
   "main": "src/index.js",
-  "files": ["src"],
+  "files": [
+    "src"
+  ],
   "scripts": {
-    "test": "mocha -R spec $(find ./test -name *.tests.js)",
-    "test:ci":
-      "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
+    "test": "mocha -R spec ./test/**/*.tests.js ./test/*.tests.js",
+    "test:ci": "istanbul cover _mocha --report lcovonly -R $(find ./test -name *.tests.js) -- -R mocha-multi --reporter-options spec=-,mocha-junit-reporter=-",
     "test:coverage": "codecov",
-    "test:watch": "NODE_ENV=test mocha --timeout 5000 $(find ./test -name *.tests.js) --watch",
+    "test:watch": "cross-env NODE_ENV=test mocha --timeout 5000 ./test/**/*.tests.js ./test/*.tests.js --watch",
     "jsdoc:generate": "jsdoc --configure .jsdoc.json --verbose",
     "release:clean": "node scripts/cleanup.js",
     "preversion": "node scripts/prepare.js",
@@ -21,7 +22,10 @@
     "type": "git",
     "url": "https://github.com/auth0/node-auth0"
   },
-  "keywords": ["auth0", "api"],
+  "keywords": [
+    "auth0",
+    "api"
+  ],
   "author": "Auth0",
   "license": "MIT",
   "bugs": {
@@ -31,16 +35,17 @@
   "dependencies": {
     "bluebird": "^2.10.2",
     "jsonwebtoken": "^8.3.0",
-    "jwks-rsa": "^1.3.0",
-    "lru-memoizer": "^1.11.1",
+    "jwks-rsa": "^1.4.0",
+    "lru-memoizer": "^1.12.0",
     "object.assign": "^4.0.4",
-    "request": "^2.83.0",
+    "request": "^2.88.0",
     "rest-facade": "^1.10.1",
     "retry": "^0.10.1"
   },
   "devDependencies": {
     "chai": "^2.2.0",
     "codecov": "^2.2.0",
+    "cross-env": "^5.2.0",
     "husky": "^0.14.3",
     "istanbul": "^0.4.0",
     "jsdoc": "^3.5.5",

diff --git a/src/auth/DatabaseAuthenticator.js b/src/auth/DatabaseAuthenticator.js
@@ -30,7 +30,8 @@ var DatabaseAuthenticator = function(options, oauth) {
    * @type {Object}
    */
   var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' }
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers
   };
 
   this.oauth = oauth;

diff --git a/src/auth/OAUthWithIDTokenValidation.js b/src/auth/OAUthWithIDTokenValidation.js
@@ -4,6 +4,9 @@ var Promise = require('bluebird');
 
 var ArgumentError = require('rest-facade').ArgumentError;
 
+var HS256_IGNORE_VALIDATION_MESSAGE =
+  'Validation of `id_token` requires a `clientSecret` when using the HS256 algorithm. To ensure tokens are validated, please switch the signing algorithm to RS256 or provide a `clientSecret` in the constructor.';
+
 /**
  * @class
  * Abstracts the `oauth.create` method with additional id_token validation
@@ -58,6 +61,9 @@ OAUthWithIDTokenValidation.prototype.create = function(params, data, cb) {
     if (r.id_token) {
       function getKey(header, callback) {
         if (header.alg === 'HS256') {
+          if (!_this.clientSecret) {
+            return callback({ message: HS256_IGNORE_VALIDATION_MESSAGE });
+          }
           return callback(null, Buffer.from(_this.clientSecret, 'base64'));
         }
         _this._jwksClient.getSigningKey(header.kid, function(err, key) {
@@ -77,11 +83,15 @@ OAUthWithIDTokenValidation.prototype.create = function(params, data, cb) {
             audience: this.clientId,
             issuer: 'https://' + this.domain + '/'
           },
-          function(err, payload) {
-            if (err) {
-              return rej(err);
+          function(err) {
+            if (!err) {
+              return res(r);
+            }
+            if (err.message && err.message.includes(HS256_IGNORE_VALIDATION_MESSAGE)) {
+              console.warn(HS256_IGNORE_VALIDATION_MESSAGE);
+              return res(r);
             }
-            return res(r);
+            return rej(err);
           }
         );
       });

diff --git a/src/auth/OAuthAuthenticator.js b/src/auth/OAuthAuthenticator.js
@@ -33,7 +33,8 @@ var OAuthAuthenticator = function(options) {
    * @type {Object}
    */
   var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' }
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers
   };
 
   this.oauth = new RestClient(options.baseUrl + '/oauth/:type', clientOptions);

diff --git a/src/auth/PasswordlessAuthenticator.js b/src/auth/PasswordlessAuthenticator.js
@@ -29,7 +29,8 @@ var PasswordlessAuthenticator = function(options, oauth) {
    * @type {Object}
    */
   var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' }
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers
   };
 
   this.oauth = oauth;

diff --git a/src/auth/index.js b/src/auth/index.js
@@ -1,8 +1,6 @@
 /** @module auth **/
 
 var util = require('util');
-
-var pkg = require('../../package.json');
 var utils = require('../utils');
 var jsonToBase64 = utils.jsonToBase64;
 var ArgumentError = require('rest-facade').ArgumentError;
@@ -67,8 +65,11 @@ var AuthenticationClient = function(options) {
   };
 
   if (options.telemetry !== false) {
-    var telemetry = jsonToBase64(options.clientInfo || this.getClientInfo());
-    managerOptions.headers['Auth0-Client'] = telemetry;
+    var clientInfo = options.clientInfo || utils.generateClientInfo();
+    if ('string' === typeof clientInfo.name && clientInfo.name) {
+      var telemetry = jsonToBase64(clientInfo);
+      managerOptions.headers['Auth0-Client'] = telemetry;
+    }
   }
 
   /**
@@ -107,38 +108,6 @@ var AuthenticationClient = function(options) {
   this.tokens = new TokensManager(managerOptions);
 };
 
-/**
- * Return an object with information about the current client,
- *
- * @method    getClientInfo
- * @memberOf  module:auth.AuthenticationClient.prototype
- *
- * @return {Object}   Object containing client information.
- */
-AuthenticationClient.prototype.getClientInfo = function() {
-  var clientInfo = {
-    name: 'node-auth0',
-    version: pkg.version,
-    dependencies: [],
-    environment: [
-      {
-        name: 'node.js',
-        version: process.version.replace('v', '')
-      }
-    ]
-  };
-
-  // Add the dependencies to the client info object.
-  Object.keys(pkg.dependencies).forEach(function(name) {
-    clientInfo.dependencies.push({
-      name: name,
-      version: pkg.dependencies[name]
-    });
-  });
-
-  return clientInfo;
-};
-
 /**
  * Start passwordless flow sending an email.
  *

diff --git a/src/management/EmailProviderManager.js b/src/management/EmailProviderManager.js
@@ -91,7 +91,10 @@ utils.wrapPropertyMethod(EmailProviderManager, 'configure', 'resource.create');
  * });
  *
  * @param   {Function}  [cb]    Callback function.
- *
+ * @param   {Object}    [params]          Clients parameters.
+ * @param   {Number}    [params.fields] A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.
+ * @param   {Number}    [params.include_fields]  true if the fields specified are to be excluded from the result, false otherwise (defaults to true)
+
  * @return  {Promise|undefined}
  */
 utils.wrapPropertyMethod(EmailProviderManager, 'get', 'resource.getAll');

diff --git a/src/management/GrantsManager.js b/src/management/GrantsManager.js
@@ -0,0 +1,119 @@
+var ArgumentError = require('rest-facade').ArgumentError;
+var utils = require('../utils');
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+/**
+ * @class GrantsManager
+ * Auth0 Grants Manager.
+ *
+ * See {@link https://auth0.com/docs/api/v2#!/Grants Grants}
+ *
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options            The client options.
+ * @param {String} options.baseUrl    The URL of the API.
+ * @param {Object} [options.headers]  Headers to be included in all requests.
+ * @param {Object} [options.retry]    Retry Policy Config
+ */
+var GrantsManager = function(options) {
+  if (options === null || typeof options !== 'object') {
+    throw new ArgumentError('Must provide client options');
+  }
+
+  if (options.baseUrl === null || options.baseUrl === undefined) {
+    throw new ArgumentError('Must provide a base URL for the API');
+  }
+
+  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+    throw new ArgumentError('The provided base URL is invalid');
+  }
+
+  /**
+   * Options object for the Rest Client instance.
+   *
+   * @type {Object}
+   */
+  var clientOptions = {
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers,
+    query: { repeatParams: false }
+  };
+
+  /**
+   * Provides an abstraction layer for consuming the
+   * {@link https://auth0.com/docs/api/v2#!/Grants Auth0 Grants endpoint}.
+   *
+   * @type {external:RestClient}
+   */
+  var auth0RestClient = new Auth0RestClient(
+    options.baseUrl + '/grants/:id',
+    clientOptions,
+    options.tokenProvider
+  );
+  this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+/**
+ * Get all Auth0 Grants.
+ *
+ * @method    getAll
+ * @memberOf  module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ *   per_page: 10,
+ *   page: 0,
+ *   include_totals: true,
+ *   user_id: 'USER_ID',
+ *   client_id: 'CLIENT_ID',
+ *   audience: 'AUDIENCE'
+ * };
+ *
+ * management.getGrants(params, function (err, grants) {
+ *   console.log(grants.length);
+ * });
+ *
+ * @param   {Object}    params                Grants parameters.
+ * @param   {Number}    params.per_page       Number of results per page.
+ * @param   {Number}    params.page           Page number, zero indexed.
+ * @param   {Boolean}   params.include_totals true if a query summary must be included in the result, false otherwise. Default false;
+ * @param   {String}    params.user_id        The user_id of the grants to retrieve.
+ * @param   {String}    params.client_id      The client_id of the grants to retrieve.
+ * @param   {String}    params.audience       The audience of the grants to retrieve.
+ * @param   {Function}  [cb]                  Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GrantsManager, 'getAll', 'resource.getAll');
+
+/**
+ * Delete an Auth0 grant.
+ *
+ * @method    delete
+ * @memberOf  module:management.GrantsManager.prototype
+ *
+ * @example
+ * var params = {
+ *    id: 'GRANT_ID',
+ *    user_id: 'USER_ID'
+ * };
+ *
+ * management.deleteGrant(params, function (err) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ *
+ *   // Grant deleted.
+ * });
+ *
+ * @param   {Object}    params         Grant parameters.
+ * @param   {String}    params.id      Grant ID.
+ * @param   {String}    params.user_id The user_id of the grants to delete.
+ * @param   {Function}  [cb]           Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+utils.wrapPropertyMethod(GrantsManager, 'delete', 'resource.delete');
+
+module.exports = GrantsManager;