class JwtAuth in JSON Web Token Authentication (JWT) 8

JWT Authentication Provider.

Hierarchy

• class \Drupal\jwt\Authentication\Provider\JwtAuth implements AuthenticationProviderInterface

2 files declare their use of JwtAuth

DisallowJwtAuthRequests.php in src/PageCache/DisallowJwtAuthRequests.php

JwtAuthIssuerController.php in modules/jwt_auth_issuer/src/Controller/JwtAuthIssuerController.php

1 string reference to 'JwtAuth'

jwt.services.yml in ./jwt.services.yml

jwt.services.yml

1 service uses JwtAuth

jwt.authentication.jwt in ./jwt.services.yml

Drupal\jwt\Authentication\Provider\JwtAuth

File

src/Authentication/Provider/JwtAuth.php, line 19

Namespace

Drupal\jwt\Authentication\Provider

class JwtAuth implements AuthenticationProviderInterface {

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

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Constructs a HTTP basic authentication provider object.
   *
   * @param \Drupal\jwt\Transcoder\JwtTranscoderInterface $transcoder
   *   The jwt transcoder service.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher service.
   */
  public function __construct(JwtTranscoderInterface $transcoder, EventDispatcherInterface $event_dispatcher) {
    $this->transcoder = $transcoder;
    $this->eventDispatcher = $event_dispatcher;
  }

  /**
   * {@inheritdoc}
   */
  public function applies(Request $request) {
    return (bool) self::getJwtFromRequest($request);
  }

  /**
   * {@inheritdoc}
   */
  public function authenticate(Request $request) {
    $raw_jwt = self::getJwtFromRequest($request);

    // Decode JWT and validate signature.
    try {
      $jwt = $this->transcoder
        ->decode($raw_jwt);
    } catch (JwtDecodeException $e) {
      return NULL;
    }
    $validate = new JwtAuthValidateEvent($jwt);

    // Signature is validated, but allow modules to do additional validation.
    $this->eventDispatcher
      ->dispatch(JwtAuthEvents::VALIDATE, $validate);
    if (!$validate
      ->isValid()) {
      return NULL;
    }
    $valid = new JwtAuthValidEvent($jwt);
    $this->eventDispatcher
      ->dispatch(JwtAuthEvents::VALID, $valid);
    $user = $valid
      ->getUser();
    if (!$user) {
      return NULL;
    }
    return $user;
  }

  /**
   * Generate a new JWT token calling all event handlers.
   *
   * @return string|bool
   *   The encoded JWT token. False if there is a problem encoding.
   */
  public function generateToken() {
    $event = new JwtAuthGenerateEvent(new JsonWebToken());
    $this->eventDispatcher
      ->dispatch(JwtAuthEvents::GENERATE, $event);
    $jwt = $event
      ->getToken();
    return $this->transcoder
      ->encode($jwt);
  }

  /**
   * Gets a raw JsonWebToken from the current request.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return string|bool
   *   Raw JWT String if on request, false if not.
   */
  public static function getJwtFromRequest(Request $request) {
    $auth_headers = [];
    $auth = $request->headers
      ->get('Authorization');
    if ($auth) {
      $auth_headers[] = $auth;
    }

    // Check a second header used in combination with basic auth.
    $fallback = $request->headers
      ->get('JWT-Authorization');
    if ($fallback) {
      $auth_headers[] = $fallback;
    }
    foreach ($auth_headers as $value) {
      if (preg_match('/^Bearer (.+)/', $value, $matches)) {
        return $matches[1];
      }
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
JwtAuth::$eventDispatcher	protected	property	The event dispatcher.
JwtAuth::$transcoder	protected	property	The JWT Transcoder service.
JwtAuth::applies	public	function	Checks whether suitable authentication credentials are on the request. Overrides AuthenticationProviderInterface::applies
JwtAuth::authenticate	public	function	Authenticates the user. Overrides AuthenticationProviderInterface::authenticate
JwtAuth::generateToken	public	function	Generate a new JWT token calling all event handlers.
JwtAuth::getJwtFromRequest	public static	function	Gets a raw JsonWebToken from the current request.
JwtAuth::__construct	public	function	Constructs a HTTP basic authentication provider object.