OpenIDConnectStateToken.php in OpenID Connect / OAuth client 2.x

Namespace

Drupal\openid_connect

File

src/OpenIDConnectStateToken.php

<?php

namespace Drupal\openid_connect;

use Drupal\Component\Utility\Crypt;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Creates and validates state tokens.
 *
 * @package Drupal\openid_connect
 */
class OpenIDConnectStateToken implements OpenIDConnectStateTokenInterface, ContainerInjectionInterface {

  /**
   * The OpenID Connect session service.
   *
   * @var \Drupal\openid_connect\OpenIDConnectSessionInterface
   */
  protected $session;

  /**
   * Construct an instance of the OpenID Connect state token service.
   *
   * @param \Drupal\openid_connect\OpenIDConnectSessionInterface $session
   *   The OpenID Connect session service.
   */
  public function __construct(OpenIDConnectSessionInterface $session) {
    $this->session = $session;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : OpenIDConnectStateToken {
    return new static($container
      ->get('openid_connect.session'));
  }

  /**
   * {@inheritdoc}
   */
  public function generateToken() : string {
    $state = Crypt::randomBytesBase64();
    $this->session
      ->saveStateToken($state);
    return $state;
  }

  /**
   * {@inheritdoc}
   */
  public function confirm(string $state_token) : bool {
    $state = $this->session
      ->retrieveStateToken(FALSE);
    return !empty($state) && $state_token == $state;
  }

}

Classes

Name	Description
OpenIDConnectStateToken	Creates and validates state tokens.