class JwtPathAuth in JSON Web Token Authentication (JWT) 8

JWT Authentication Provider.

Hierarchy

• class \Drupal\jwt_path_auth\Authentication\Provider\JwtPathAuth implements AuthenticationProviderInterface

1 string reference to 'JwtPathAuth'

jwt_path_auth.services.yml in modules/jwt_path_auth/jwt_path_auth.services.yml

modules/jwt_path_auth/jwt_path_auth.services.yml

1 service uses JwtPathAuth

jwt_path_auth.authentication.jwt in modules/jwt_path_auth/jwt_path_auth.services.yml

Drupal\jwt_path_auth\Authentication\Provider\JwtPathAuth

File

modules/jwt_path_auth/src/Authentication/Provider/JwtPathAuth.php, line 16

Namespace

Drupal\jwt_path_auth\Authentication\Provider

class JwtPathAuth implements AuthenticationProviderInterface {

  /**
   * The JWT Transcoder service.
   *
   * @var \Drupal\jwt\Transcoder\JwtTranscoderInterface
   */
  protected $transcoder;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The kill switch.
   *
   * @var \Drupal\Core\PageCache\ResponsePolicy\KillSwitch
   */
  protected $killSwitch;

  /**
   * Constructs a HTTP basic authentication provider object.
   *
   * @param \Drupal\jwt\Transcoder\JwtTranscoderInterface $transcoder
   *   The jwt transcoder service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager service.
   * @param \Drupal\Core\PageCache\ResponsePolicy\KillSwitch $killSwitch
   *   The kill switch.
   */
  public function __construct(JwtTranscoderInterface $transcoder, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, KillSwitch $killSwitch) {
    $this->transcoder = $transcoder;
    $this->configFactory = $config_factory;
    $this->entityTypeManager = $entity_type_manager;
    $this->killSwitch = $killSwitch;
  }

  /**
   * {@inheritdoc}
   */
  public function applies(Request $request) {
    $raw_jwt = $request->query
      ->get('jwt');
    if (empty($raw_jwt)) {
      return FALSE;
    }
    $config = $this->configFactory
      ->get('jwt_path_auth.config');
    $allowed_path_prefixes = (array) $config
      ->get('allowed_path_prefixes');
    $path_matched = FALSE;
    $request_path = $request
      ->getPathInfo();
    foreach ($allowed_path_prefixes as $prefix) {
      if (strpos($request_path, $prefix) === 0) {
        $path_matched = TRUE;
        break;
      }
    }
    return $path_matched;
  }

  /**
   * {@inheritdoc}
   */
  public function authenticate(Request $request) {
    $raw_jwt = $request->query
      ->get('jwt');

    // Decode JWT and validate signature.
    try {
      $jwt = $this->transcoder
        ->decode($raw_jwt);
    } catch (JwtDecodeException $e) {
      return NULL;
    }
    $uid = $jwt
      ->getClaim([
      'drupal',
      'path_auth',
      'uid',
    ]);

    // The JWT must include a claim matching the path after the host name,
    // or a prefix of the path.  E.g. "/system/files/". Note that this
    // must include any base path if the site is in a subdirectory.
    $path = $jwt
      ->getClaim([
      'drupal',
      'path_auth',
      'path',
    ]);
    $request_path = $request
      ->getBaseUrl() . $request
      ->getPathInfo();
    if ($uid && $path && strpos($request_path, $path) === 0) {
      $user = $this->entityTypeManager
        ->getStorage('user')
        ->load($uid);
      if ($user && !$user
        ->isBlocked()) {

        // Mark this page as being uncacheable.
        $this->killSwitch
          ->trigger();
        return $user;
      }
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
JwtPathAuth::$configFactory	protected	property	The config factory.
JwtPathAuth::$entityTypeManager	protected	property	Entity type manager.
JwtPathAuth::$killSwitch	protected	property	The kill switch.
JwtPathAuth::$transcoder	protected	property	The JWT Transcoder service.
JwtPathAuth::applies	public	function	Checks whether suitable authentication credentials are on the request. Overrides AuthenticationProviderInterface::applies
JwtPathAuth::authenticate	public	function	Authenticates the user. Overrides AuthenticationProviderInterface::authenticate
JwtPathAuth::__construct	public	function	Constructs a HTTP basic authentication provider object.