You are here

Home » API reference » Simple OAuth (OAuth2) & OpenID Connect 8 » AccessTokenIssue.php

class AccessTokenIssue in Simple OAuth (OAuth2) & OpenID Connect 8

Hierarchy

Expanded class hierarchy of AccessTokenIssue

File

src/Controller/AccessTokenIssue.php, line 16

Namespace

Drupal\simple_oauth\Controller
View source 
class AccessTokenIssue extends ControllerBase {

  /**
   * The user authentication object.
   *
   * @var \Drupal\user\UserAuthInterface
   */
  protected $userAuth;

  /**
   * The response object.
   *
   * @var JsonResponse
   */
  protected $response;

  /**
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager service.
   */
  public function __construct(EntityManagerInterface $entity_manager, UserAuthInterface $user_auth, JsonResponse $response) {
    $this->entityManager = $entity_manager;
    $this->userAuth = $user_auth;
    $this->response = $response;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity.manager'), $container
      ->get('user.auth'), new JsonResponse());
  }
  public function issue(Request $request) {
    $body = Json::decode($request
      ->getContent());
    if (!$body['grant_type'] == 'password') {
      throw new HttpException(422, 'Only grant_type=password is supported');
    }
    $scope = 'global';
    if (!empty($body['scope'])) {
      $scope = $body['scope'];
      $resource = $this->entityManager
        ->getStorage('access_token_resource')
        ->load($scope);
      if (!$resource) {
        throw new HttpException(422, sprintf('Unknown scope %s', $scope));
      }
    }
    $uid = $this->userAuth
      ->authenticate($body['username'], $body['password']);

    /** @var \Drupal\user\UserInterface $user */
    $user = $this->entityManager
      ->getStorage('user')
      ->load($uid);
    if (!$user || $user
      ->isBlocked()) {
      throw new HttpException(401, 'Authentication failed.');
    }
    $values = [
      'expire' => AccessToken::defaultExpiration(),
      'user_id' => $uid,
      'auth_user_id' => $uid,
      'resource' => $scope,
    ];
    $store = $this->entityManager
      ->getStorage('access_token');

    /** @var \Drupal\simple_oauth\Entity\AccessToken $token */
    $token = $store
      ->create($values);
    $token
      ->save();
    $this->response
      ->setData($this
      ->normalize($token));
    return $this->response;
  }

  /**
   * Manually normalize a token entity into an structured array.
   *
   * @todo Use the serialization system.
   *
   * @param \Drupal\simple_oauth\Entity\AccessToken $token
   *   The token entity to normalize.
   *
   * @return array
   *   The structured array.
   */
  protected function normalize(AccessToken $token) {
    $output = [
      'access_token' => $token
        ->get('value')->value,
      'token_type' => 'Bearer',
      'expires_in' => $token
        ->get('expire')->value - REQUEST_TIME,
    ];

    // Try to load the associated refresh token.
    $storage = $this
      ->entityManager()
      ->getStorage('access_token');
    $ids = $storage
      ->getQuery()
      ->condition('access_token_id', $token
      ->id())
      ->condition('expire', REQUEST_TIME, '>')
      ->condition('resource', 'authentication')
      ->range(0, 1)
      ->execute();
    if (!empty($ids)) {
      $output['refresh_token'] = $storage
        ->load(reset($ids))
        ->get('value')->value;
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AccessTokenIssue::$response protected property The response object.
AccessTokenIssue::$userAuth protected property The user authentication object.
AccessTokenIssue::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
AccessTokenIssue::issue public function
AccessTokenIssue::normalize protected function Manually normalize a token entity into an structured array.
AccessTokenIssue::__construct public function
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.