class Oauth2GrantManager in Simple OAuth (OAuth2) & OpenID Connect 8.2
Same name and namespace in other branches
- 8.4 src/Plugin/Oauth2GrantManager.php \Drupal\simple_oauth\Plugin\Oauth2GrantManager
- 8.3 src/Plugin/Oauth2GrantManager.php \Drupal\simple_oauth\Plugin\Oauth2GrantManager
- 5.x src/Plugin/Oauth2GrantManager.php \Drupal\simple_oauth\Plugin\Oauth2GrantManager
Provides the OAuth2 Grant plugin manager.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\simple_oauth\Plugin\Oauth2GrantManager implements Oauth2GrantManagerInterface
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of Oauth2GrantManager
1 string reference to 'Oauth2GrantManager'
1 service uses Oauth2GrantManager
File
- src/
Plugin/ Oauth2GrantManager.php, line 23
Namespace
Drupal\simple_oauth\PluginView source
class Oauth2GrantManager extends DefaultPluginManager implements Oauth2GrantManagerInterface {
/**
* @var \League\OAuth2\Server\Repositories\ClientRepositoryInterface
*/
protected $clientRepository;
/**
* @var \League\OAuth2\Server\Repositories\ScopeRepositoryInterface
*/
protected $scopeRepository;
/**
* @var \League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface
*/
protected $accessTokenRepository;
/**
* @var \League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface
*/
protected $refreshTokenRepository;
/**
* @var string
*/
protected $privateKeyPath;
/**
* @var string
*/
protected $publicKeyPath;
/**
* @var \DateTime
*/
protected $expiration;
/**
* Constructor for Oauth2GrantManager objects.
*
* @param \Traversable $namespaces
* An object that implements \Traversable which contains the root paths
* keyed by the corresponding namespace to look for plugin implementations.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* Cache backend instance to use.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler to invoke the alter hook with.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ClientRepositoryInterface $client_repository, ScopeRepositoryInterface $scope_repository, AccessTokenRepositoryInterface $access_token_repository, RefreshTokenRepositoryInterface $refresh_token_repository, ConfigFactoryInterface $config_factory) {
parent::__construct('Plugin/Oauth2Grant', $namespaces, $module_handler, 'Drupal\\simple_oauth\\Plugin\\Oauth2GrantInterface', 'Drupal\\simple_oauth\\Annotation\\Oauth2Grant');
$this
->alterInfo('simple_oauth_oauth2_grant_info');
$this
->setCacheBackend($cache_backend, 'simple_oauth_oauth2_grant_plugins');
$this->clientRepository = $client_repository;
$this->scopeRepository = $scope_repository;
$this->accessTokenRepository = $access_token_repository;
$this->refreshTokenRepository = $refresh_token_repository;
$settings = $config_factory
->get('simple_oauth.settings');
$this
->setKeyPaths($settings);
$this->expiration = new \DateInterval(sprintf('PT%dS', $settings
->get('access_token_expiration')));
}
/**
* {@inheritdoc}
*/
public function getAuthorizationServer($grant_type) {
try {
/** @var \Drupal\simple_oauth\Plugin\Oauth2GrantInterface $plugin */
$plugin = $this
->createInstance($grant_type);
} catch (PluginNotFoundException $exception) {
throw OAuthServerException::invalidGrant('Check the configuration to see if the grant is enabled.');
}
$this
->checkKeyPaths();
$salt = Settings::getHashSalt();
$server = new AuthorizationServer($this->clientRepository, $this->accessTokenRepository, $this->scopeRepository, realpath($this->privateKeyPath), Core::ourSubstr($salt, 0, 32));
// Enable the password grant on the server with a token TTL of X hours.
$server
->enableGrantType($plugin
->getGrantType(), $this->expiration);
return $server;
}
/**
* Set the public and private key paths.
*
* @param \Drupal\Core\Config\ImmutableConfig $settings
* The Simple OAuth settings configuration object.
*/
protected function setKeyPaths(ImmutableConfig $settings) {
$this->publicKeyPath = $settings
->get('public_key');
$this->privateKeyPath = $settings
->get('private_key');
}
/**
* @throws \League\OAuth2\Server\Exception\OAuthServerException
* If one or both keys are not set properly.
*/
protected function checkKeyPaths() {
if (!file_exists($this->publicKeyPath) || !file_exists($this->privateKeyPath)) {
throw OAuthServerException::serverError(sprintf('You need to set the OAuth2 secret and private keys.'));
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultPluginManager:: |
protected | property | Additional namespaces the annotation discovery mechanism should scan for annotation definitions. | |
DefaultPluginManager:: |
protected | property | Name of the alter hook if one should be invoked. | |
DefaultPluginManager:: |
protected | property | The cache key. | |
DefaultPluginManager:: |
protected | property | An array of cache tags to use for the cached definitions. | |
DefaultPluginManager:: |
protected | property | A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. | 9 |
DefaultPluginManager:: |
protected | property | The module handler to invoke the alter hook. | 1 |
DefaultPluginManager:: |
protected | property | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations. | |
DefaultPluginManager:: |
protected | property | The name of the annotation that contains the plugin definition. | |
DefaultPluginManager:: |
protected | property | The interface each plugin should implement. | 1 |
DefaultPluginManager:: |
protected | property | The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace. | |
DefaultPluginManager:: |
protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 1 |
DefaultPluginManager:: |
protected | function | Sets the alter hook name. | |
DefaultPluginManager:: |
public | function |
Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface:: |
5 |
DefaultPluginManager:: |
protected | function | Extracts the provider from a plugin definition. | |
DefaultPluginManager:: |
protected | function | Finds plugin definitions. | 7 |
DefaultPluginManager:: |
private | function | Fix the definitions of context-aware plugins. | |
DefaultPluginManager:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
protected | function | Returns the cached plugin definitions of the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
Gets the definition of all plugins for this type. Overrides DiscoveryTrait:: |
2 |
DefaultPluginManager:: |
protected | function |
Gets the plugin discovery. Overrides PluginManagerBase:: |
12 |
DefaultPluginManager:: |
protected | function |
Gets the plugin factory. Overrides PluginManagerBase:: |
|
DefaultPluginManager:: |
public | function | Performs extra processing on plugin definitions. | 13 |
DefaultPluginManager:: |
protected | function | Determines if the provider of a definition exists. | 3 |
DefaultPluginManager:: |
public | function | Initialize the cache backend. | |
DefaultPluginManager:: |
protected | function | Sets a cache of plugin definitions for the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
Disable the use of caches. Overrides CachedDiscoveryInterface:: |
1 |
DiscoveryCachedTrait:: |
protected | property | Cached definitions array. | 1 |
DiscoveryCachedTrait:: |
public | function |
Overrides DiscoveryTrait:: |
3 |
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | property | ||
Oauth2GrantManager:: |
protected | function | ||
Oauth2GrantManager:: |
public | function |
Gets the authorization server. Overrides Oauth2GrantManagerInterface:: |
|
Oauth2GrantManager:: |
protected | function | Set the public and private key paths. | |
Oauth2GrantManager:: |
public | function |
Constructor for Oauth2GrantManager objects. Overrides DefaultPluginManager:: |
|
PluginManagerBase:: |
protected | property | The object that discovers plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that instantiates plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. | |
PluginManagerBase:: |
public | function |
Creates a pre-configured instance of a plugin. Overrides FactoryInterface:: |
12 |
PluginManagerBase:: |
public | function |
Gets a preconfigured instance of a plugin. Overrides MapperInterface:: |
7 |
PluginManagerBase:: |
protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 |
UseCacheBackendTrait:: |
protected | property | Cache backend instance. | |
UseCacheBackendTrait:: |
protected | property | Flag whether caches should be used or skipped. | |
UseCacheBackendTrait:: |
protected | function | Fetches from the cache backend, respecting the use caches flag. | 1 |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. |