auth0 2.37.0 → 2.40.0

package/src/management/AttackProtectionManager.js

@@ -0,0 +1,187 @@
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
+
+/**
+ * Simple facade for consuming a REST API endpoint.
+ *
+ * @external RestClient
+ * @see https://github.com/ngonzalvez/rest-facade
+ */
+
+class AttackProtectionManager {
+  /**
+   * @class
+   * Abstracts interaction with the attack-protection endpoints.
+   * @class
+   * @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
+   * @param {object} [options.tokenProvider] Management API Token Provider
+   */
+  constructor(options) {
+    if (options === null || typeof options !== 'object') {
+      throw new ArgumentError('Must provide manager 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');
+    }
+
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    const bruteForceProtection = new Auth0RestClient(
+      `${options.baseUrl}/attack-protection/brute-force-protection`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.bruteForceProtection = new RetryRestClient(bruteForceProtection, options.retry);
+
+    const suspiciousIpThrottling = new Auth0RestClient(
+      `${options.baseUrl}/attack-protection/suspicious-ip-throttling`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.suspiciousIpThrottling = new RetryRestClient(suspiciousIpThrottling, options.retry);
+
+    const breachedPasswordDetection = new Auth0RestClient(
+      `${options.baseUrl}/attack-protection/breached-password-detection`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.breachedPasswordDetection = new RetryRestClient(breachedPasswordDetection, options.retry);
+  }
+
+  /**
+   * Get the Brute Force Protection configuration.
+   *
+   * @example
+   * management.attackProtection.getBruteForceConfig(params, function (err, bruteForceConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Brute force config
+   *   console.log(bruteForceConfig);
+   * });
+   * @param   {object}    params            Brute force parameters (leave empty).
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  getBruteForceConfig(...args) {
+    return this.bruteForceProtection.get(...args);
+  }
+
+  /**
+   * Update the Brute Force Protection configuration.
+   *
+   * @example
+   * management.attackProtection.updateBruteForceConfig(params, data, function (err, bruteForceConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Brute force config
+   *   console.log(bruteForceConfig);
+   * });
+   * @param   {object}    params            Brute force parameters (leave empty).
+   * @param   {object}    data              Updated brute force configuration.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  updateBruteForceConfig(...args) {
+    return this.bruteForceProtection.patch(...args);
+  }
+
+  /**
+   * Get the Suspicious IP Throttling configuration.
+   *
+   * @example
+   * management.attackProtection.getSuspiciousIpThrottlingConfig(params, function (err, suspiciousIpThrottlingConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Access suspicious IP throttling configuration
+   *   console.log(suspiciousIpThrottlingConfig);
+   * });
+   * @param   {object}    params            Suspicious IP throttling parameters (leave empty).
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  getSuspiciousIpThrottlingConfig(...args) {
+    return this.suspiciousIpThrottling.get(...args);
+  }
+
+  /**
+   * Update the Suspicious IP Throttling configuration.
+   *
+   * @example
+   * management.attackProtection.updateSuspiciousIpThrottlingConfig(params, data, function (err, suspiciousIpThrottlingConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Access suspicious IP throttling configuration
+   *   console.log(suspiciousIpThrottlingConfig);
+   * });
+   * @param   {object}    params            Suspicious IP throttling parameters (leave empty).
+   * @param   {object}    data              Updated suspicious IP throttling configuration.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  updateSuspiciousIpThrottlingConfig(...args) {
+    return this.suspiciousIpThrottling.patch(...args);
+  }
+
+  /**
+   * Get the Breached Password Detection configuration.
+   *
+   * @example
+   * management.attackProtection.getBreachedPasswordDetectionConfig(params, function (err, breachedPasswordDetectionConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Access breached password detection configuration
+   *   console.log(breachedPasswordDetectionConfig);
+   * });
+   * @param   {object}    params            Breached password detection parameters (leave empty).
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  getBreachedPasswordDetectionConfig(...args) {
+    return this.breachedPasswordDetection.get(...args);
+  }
+
+  /**
+   * Update the breached password detection configuration.
+   *
+   * @example
+   * management.attackProtection.updateBreachedPasswordDetectionConfig(params, data, function (err, breachedPasswordDetectionConfig) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
+   *
+   *   // Access breached password detection configuration
+   *   console.log(breachedPasswordDetectionConfig);
+   * });
+   * @param   {object}    params            Breached password detection parameters (leave empty).
+   * @param   {object}    data              Updated breached password detection configuration.
+   * @param   {Function}  [cb]              Callback function.
+   * @returns    {Promise|undefined}
+   */
+  updateBreachedPasswordDetectionConfig(...args) {
+    return this.breachedPasswordDetection.patch(...args);
+  }
+}
+module.exports = AttackProtectionManager;

package/src/management/BlacklistedTokensManager.js

@@ -1,102 +1,95 @@
-var ArgumentError = require('rest-facade').ArgumentError;
-var utils = require('../utils');
-var Auth0RestClient = require('../Auth0RestClient');
-var RetryRestClient = require('../RetryRestClient');
+const { ArgumentError } = require('rest-facade');
+const Auth0RestClient = require('../Auth0RestClient');
+const RetryRestClient = require('../RetryRestClient');
 
 /**
- * @class BlacklistedTokensManager
  * The BlacklistedTokensManager class provides methods to retrieve the list of
  * blacklisted tokens and blacklist new ones..
- * @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 BlacklistedTokensManager = function(options) {
-  if (options === null || typeof options !== 'object') {
-    throw new ArgumentError('Must provide client options');
-  }
+class BlacklistedTokensManager {
+  /**
+   * @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
+   */
+  constructor(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 (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');
+    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}
+     */
+    const clientOptions = {
+      errorFormatter: { message: 'message', name: 'error' },
+      headers: options.headers,
+      query: { repeatParams: false },
+    };
+
+    /**
+     * Provides an abstraction layer for consuming the
+     * [Auth0 Blacklisted Tokens endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
+     *
+     * @type {external:RestClient}
+     */
+    const auth0RestClient = new Auth0RestClient(
+      `${options.baseUrl}/blacklists/tokens`,
+      clientOptions,
+      options.tokenProvider
+    );
+    this.resource = new RetryRestClient(auth0RestClient, options.retry);
   }
 
   /**
-   * Options object for the Rest Client instance.
+   * Blacklist a new token.
+   *
+   * @example
+   * var token = {
+   *  aud: 'aud',
+   *  jti: 'jti'
+   * };
+   *
+   * management.blacklistedTokens.add(token, function (err) {
+   *   if (err) {
+   *     // Handle error.
+   *   }
    *
-   * @type {Object}
+   *   // Token blacklisted.
+   * });
+   * @param   {object}    token      Token data.
+   * @param   {string}    token.aud  Audience (your app client ID).
+   * @param   {string}    token.jti  The JWT ID claim.
+   * @param   {Function}  [cb]       Callback function.
+   * @returns  {Promise|undefined}
    */
-  var clientOptions = {
-    errorFormatter: { message: 'message', name: 'error' },
-    headers: options.headers,
-    query: { repeatParams: false }
-  };
+  add(...args) {
+    return this.resource.create(...args);
+  }
 
   /**
-   * Provides an abstraction layer for consuming the
-   * [Auth0 Blacklisted Tokens endpoint]{@link https://auth0.com/docs/api/v2#!/Clients}.
+   * Get all blacklisted tokens.
    *
-   * @type {external:RestClient}
+   * @example
+   * management.blacklistedTokens.getAll(function (err, tokens) {
+   *   console.log(tokens.length);
+   * });
+   * @param   {Function}  [cb]    Callback function.
+   * @returns  {Promise|undefined}
    */
-  var auth0RestClient = new Auth0RestClient(
-    options.baseUrl + '/blacklists/tokens',
-    clientOptions,
-    options.tokenProvider
-  );
-  this.resource = new RetryRestClient(auth0RestClient, options.retry);
-};
-
-/**
- * Blacklist a new token.
- *
- * @method    add
- * @memberOf  module:management.BlacklistedTokensManager.prototype
- *
- * @example
- * var token = {
- *  aud: 'aud',
- *  jti: 'jti'
- * };
- *
- * management.blacklistedTokens.add(token, function (err) {
- *   if (err) {
- *     // Handle error.
- *   }
- *
- *   // Token blacklisted.
- * });
- *
- * @param   {Object}    token      Token data.
- * @param   {String}    token.aud  Audience (your app client ID).
- * @param   {String}    token.jti  The JWT ID claim.
- * @param   {Function}  [cb]       Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(BlacklistedTokensManager, 'add', 'resource.create');
-
-/**
- * Get all blacklisted tokens.
- *
- * @method    getAll
- * @memberOf  module:management.BlacklistedTokensManager.prototype
- *
- * @example
- * management.blacklistedTokens.getAll(function (err, tokens) {
- *   console.log(tokens.length);
- * });
- *
- * @param   {Function}  [cb]    Callback function.
- *
- * @return  {Promise|undefined}
- */
-utils.wrapPropertyMethod(BlacklistedTokensManager, 'getAll', 'resource.getAll');
+  getAll(...args) {
+    return this.resource.getAll(...args);
+  }
+}
 
 module.exports = BlacklistedTokensManager;