class ResourceOwnersCredentialsGrantService in OAuth2 Client 8.3

Handles Authorization Grants for the OAuth2 Client module.

Hierarchy

• class \Drupal\oauth2_client\Service\Oauth2ClientServiceBase implements Oauth2ClientServiceInterface
  • class \Drupal\oauth2_client\Service\Grant\Oauth2ClientGrantServiceBase implements Oauth2ClientGrantServiceInterface
    • class \Drupal\oauth2_client\Service\Grant\ResourceOwnersCredentialsGrantService

1 file declares its use of ResourceOwnersCredentialsGrantService

Oauth2ClientService.php in src/Service/Oauth2ClientService.php

1 string reference to 'ResourceOwnersCredentialsGrantService'

oauth2_client.services.yml in ./oauth2_client.services.yml

oauth2_client.services.yml

File

src/Service/Grant/ResourceOwnersCredentialsGrantService.php, line 8

Namespace

Drupal\oauth2_client\Service\Grant

class ResourceOwnersCredentialsGrantService extends Oauth2ClientGrantServiceBase {

  /**
   * Storage for usernames and passwords keyed by plugin id.
   *
   * @var array
   */
  protected $usernamesPasswords;

  /**
   * {@inheritdoc}
   */
  public function getAccessToken($pluginId) {
    $provider = $this
      ->getProvider($pluginId);
    $credentials = $this
      ->getUsernamePassword($pluginId);
    if (empty($credentials)) {
      throw new \RuntimeException('Missing username and password for client plugin ' . $pluginId);
    }
    try {
      $accessToken = $provider
        ->getAccessToken('password', [
        'username' => $credentials['username'],
        'password' => $credentials['password'],
      ]);
      $this
        ->storeAccessToken($pluginId, $accessToken);
    } catch (\Exception $e) {

      // Failed to get the access token.
      watchdog_exception('OAuth2 Client', $e);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getGrantProvider($pluginId) {
    return $this
      ->getProvider($pluginId);
  }

  /**
   * Pass credentials in memory to be used in the oauth request.
   *
   * It may not be necessary, but storing by client id in case some edge
   * case has two or more client plugins operating on the same request.
   *
   * @param string $pluginId
   *   The id of the Oauth2Client plugin implementing this grant type.
   * @param string $username
   *   Optional - The username if needed by the grant type.
   * @param string $password
   *   Optional - The password if needed by the grant type.
   */
  public function setUsernamePassword($pluginId, $username, $password) {
    $this->usernamesPasswords[$pluginId] = [
      'username' => $username,
      'password' => $password,
    ];
  }

  /**
   * Gets credential pairs by plugin id.
   *
   * @param string $pluginId
   *   The id of the Oauth2Client plugin implementing this grant type.
   *
   * @return array
   *   Associative array with `username` and `password` keys.
   */
  protected function getUsernamePassword($pluginId) {
    return $this->usernamesPasswords[$pluginId] ?? [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Oauth2ClientGrantServiceBase::$clientProviderCache	protected	property	Client provider cache.
Oauth2ClientGrantServiceBase::$currentRequest	protected	property	The Request Stack.
Oauth2ClientGrantServiceBase::$oauth2ClientPluginManager	protected	property	The OAuth2 Client plugin manager. Overrides Oauth2ClientServiceBase::$oauth2ClientPluginManager
Oauth2ClientGrantServiceBase::$state	protected	property	The Drupal state.
Oauth2ClientGrantServiceBase::$urlGenerator	protected	property	The URL generator service.
Oauth2ClientGrantServiceBase::getProvider	protected	function	Creates a new provider object.
Oauth2ClientGrantServiceBase::storeAccessToken	protected	function	Store an access token using plugin specific storage.
Oauth2ClientGrantServiceBase::__construct	public	function	Construct an OAuth2Client object.	1
Oauth2ClientServiceBase::clearAccessToken	public	function	Clears the access token for the given client. Overrides Oauth2ClientServiceInterface::clearAccessToken
Oauth2ClientServiceBase::getClient	public	function	Retrieve an OAuth2 Client Plugin. Overrides Oauth2ClientServiceInterface::getClient
Oauth2ClientServiceBase::retrieveAccessToken	public	function	Retrieve an access token from storage. Overrides Oauth2ClientServiceInterface::retrieveAccessToken
ResourceOwnersCredentialsGrantService::$usernamesPasswords	protected	property	Storage for usernames and passwords keyed by plugin id.
ResourceOwnersCredentialsGrantService::getAccessToken	public	function	Get an OAuth2 access token. Overrides Oauth2ClientGrantServiceInterface::getAccessToken
ResourceOwnersCredentialsGrantService::getGrantProvider	public	function	Get the league/oauth2 provider. Overrides Oauth2ClientGrantServiceInterface::getGrantProvider
ResourceOwnersCredentialsGrantService::getUsernamePassword	protected	function	Gets credential pairs by plugin id.
ResourceOwnersCredentialsGrantService::setUsernamePassword	public	function	Pass credentials in memory to be used in the oauth request.