class AuthHelper in Auth0 Single Sign On 8.2

Controller routines for auth0 authentication.

Hierarchy

• class \Drupal\auth0\Util\AuthHelper

2 files declare their use of AuthHelper

AuthController.php in src/Controller/AuthController.php

Contains \Drupal\auth0\Controller\AuthController.

BasicSettingsForm.php in src/Form/BasicSettingsForm.php

Contains \Drupal\auth0\Form\BasicSettingsForm.

1 string reference to 'AuthHelper'

auth0.services.yml in ./auth0.services.yml

auth0.services.yml

1 service uses AuthHelper

auth0.helper in ./auth0.services.yml

Drupal\auth0\Util\AuthHelper

File

src/Util/AuthHelper.php, line 21

Contains \Drupal\auth0\Util\AuthHelper.

Namespace

Drupal\auth0\Util

class AuthHelper {
  const AUTH0_LOGGER = 'auth0_helper';
  const AUTH0_DOMAIN = 'auth0_domain';
  const AUTH0_CUSTOM_DOMAIN = 'auth0_custom_domain';
  const AUTH0_CLIENT_ID = 'auth0_client_id';
  const AUTH0_CLIENT_SECRET = 'auth0_client_secret';
  const AUTH0_REDIRECT_FOR_SSO = 'auth0_redirect_for_sso';
  const AUTH0_JWT_SIGNING_ALGORITHM = 'auth0_jwt_signature_alg';
  const AUTH0_SECRET_ENCODED = 'auth0_secret_base64_encoded';
  const AUTH0_OFFLINE_ACCESS = 'auth0_allow_offline_access';
  private $logger;
  private $config;
  private $domain;
  private $customDomain;
  private $clientId;
  private $clientSecret;
  private $redirectForSso;
  private $auth0JwtSignatureAlg;
  private $secretBase64Encoded;

  /**
   * Initialize the Helper.
   *
   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory
   *   The logger factory.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(LoggerChannelFactoryInterface $logger_factory, ConfigFactoryInterface $config_factory) {
    $this->logger = $logger_factory
      ->get(AuthHelper::AUTH0_LOGGER);
    $this->config = $config_factory
      ->get('auth0.settings');
    $this->domain = $this->config
      ->get(AuthHelper::AUTH0_DOMAIN);
    $this->customDomain = $this->config
      ->get(AuthHelper::AUTH0_CUSTOM_DOMAIN);
    $this->clientId = $this->config
      ->get(AuthHelper::AUTH0_CLIENT_ID);
    $this->clientSecret = $this->config
      ->get(AuthHelper::AUTH0_CLIENT_SECRET);
    $this->redirectForSso = $this->config
      ->get(AuthHelper::AUTH0_REDIRECT_FOR_SSO);
    $this->auth0JwtSignatureAlg = $this->config
      ->get(AuthHelper::AUTH0_JWT_SIGNING_ALGORITHM, AUTH0_DEFAULT_SIGNING_ALGORITHM);
    $this->secretBase64Encoded = FALSE || $this->config
      ->get(AuthHelper::AUTH0_SECRET_ENCODED);
    self::setTelemetry();
  }

  /**
   * Get the user using token.
   *
   * @param string $refreshToken
   *   The refresh token to use to get the user.
   *
   * @return array
   *   A user array of named claims from the ID token.
   *
   * @throws RefreshTokenFailedException
   * @throws CoreException
   * @throws InvalidTokenException
   */
  public function getUserUsingRefreshToken($refreshToken) {
    global $base_root;
    $auth0Api = new Authentication($this
      ->getAuthDomain(), $this->clientId, $this->clientSecret);
    try {
      $tokens = $auth0Api
        ->oauth_token([
        'grant_type' => 'refresh_token',
        'client_id' => $this->clientId,
        'client_secret' => $this->clientSecret,
        'refresh_token' => $refreshToken,
      ]);
      return $this
        ->validateIdToken($tokens->idToken);
    } catch (\Exception $e) {
      throw new RefreshTokenFailedException($e);
    }
  }

  /**
   * Validate the ID token.
   *
   * @param string $idToken
   *   The ID token to validate.
   *
   * @return mixed
   *   A user array of named claims from the ID token.
   *
   * @throws CoreException
   * @throws InvalidTokenException
   * @throws \Exception
   */
  public function validateIdToken($idToken) {
    $auth0_domain = 'https://' . $this
      ->getAuthDomain() . '/';
    $auth0_settings = [];
    $auth0_settings['authorized_iss'] = [
      $auth0_domain,
    ];
    $auth0_settings['supported_algs'] = [
      $this->auth0JwtSignatureAlg,
    ];
    $auth0_settings['valid_audiences'] = [
      $this->clientId,
    ];
    $auth0_settings['client_secret'] = $this->clientSecret;
    $auth0_settings['secret_base64_encoded'] = $this->secretBase64Encoded;
    $jwt_verifier = new JWTVerifier($auth0_settings);
    return $jwt_verifier
      ->verifyAndDecode($idToken);
  }

  /**
   * Extend Auth0 PHP SDK telemetry to report for Drupal.
   */
  public static function setTelemetry() {
    $oldInfoHeaders = ApiClient::getInfoHeadersData();
    if ($oldInfoHeaders) {
      $infoHeaders = InformationHeaders::Extend($oldInfoHeaders);
      $infoHeaders
        ->setEnvironment('drupal', \Drupal::VERSION);
      $infoHeaders
        ->setPackage('auth0-drupal', AUTH0_MODULE_VERSION);
      ApiClient::setInfoHeadersData($infoHeaders);
    }
  }

  /**
   * Return the custom domain, if one has been set.
   *
   * @return mixed
   *   A string with the domain name
   *   A empty string if the config is not set
   */
  public function getAuthDomain() {
    return !empty($this->customDomain) ? $this->customDomain : $this->domain;
  }

  /**
   * Get the tenant CDN base URL based on the Application domain.
   *
   * @param string $domain
   *   Tenant domain.
   *
   * @return string
   *   Tenant CDN base URL
   */
  public static function getTenantCdn($domain) {
    preg_match('/^[\\w\\d\\-_0-9]+\\.([\\w\\d\\-_0-9]*)[\\.]*auth0\\.com$/', $domain, $matches);
    return 'https://cdn' . (empty($matches[1]) || $matches[1] == 'us' ? '' : '.' . $matches[1]) . '.auth0.com';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AuthHelper::$auth0JwtSignatureAlg	private	property
AuthHelper::$clientId	private	property
AuthHelper::$clientSecret	private	property
AuthHelper::$config	private	property
AuthHelper::$customDomain	private	property
AuthHelper::$domain	private	property
AuthHelper::$logger	private	property
AuthHelper::$redirectForSso	private	property
AuthHelper::$secretBase64Encoded	private	property
AuthHelper::AUTH0_CLIENT_ID		constant
AuthHelper::AUTH0_CLIENT_SECRET		constant
AuthHelper::AUTH0_CUSTOM_DOMAIN		constant
AuthHelper::AUTH0_DOMAIN		constant
AuthHelper::AUTH0_JWT_SIGNING_ALGORITHM		constant
AuthHelper::AUTH0_LOGGER		constant
AuthHelper::AUTH0_OFFLINE_ACCESS		constant
AuthHelper::AUTH0_REDIRECT_FOR_SSO		constant
AuthHelper::AUTH0_SECRET_ENCODED		constant
AuthHelper::getAuthDomain	public	function	Return the custom domain, if one has been set.
AuthHelper::getTenantCdn	public static	function	Get the tenant CDN base URL based on the Application domain.
AuthHelper::getUserUsingRefreshToken	public	function	Get the user using token.
AuthHelper::setTelemetry	public static	function	Extend Auth0 PHP SDK telemetry to report for Drupal.
AuthHelper::validateIdToken	public	function	Validate the ID token.
AuthHelper::__construct	public	function	Initialize the Helper.