class LockrKeyProvider in Lockr 8.4

Adds a key provider that allows a key to be stored in Lockr.

Plugin annotation

@KeyProvider(
  id = "lockr",
  label = "Lockr",
  description = @Translation("The Lockr key provider stores the key in Lockr key management service."),
  storage_method = "lockr",
  key_value = {
    "accepted" = TRUE,
    "required" = TRUE
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\key\Plugin\KeyPluginBase implements KeyPluginInterface
      • class \Drupal\key\Plugin\KeyProviderBase implements KeyProviderInterface
        • class \Drupal\lockr\Plugin\KeyProvider\LockrKeyProvider implements KeyPluginFormInterface, KeyProviderSettableValueInterface

File

src/Plugin/KeyProvider/LockrKeyProvider.php, line 40

Contains Drupal\lockr\Plugin\KeyProvider\LockrKeyProvider.

Namespace

Drupal\lockr\Plugin\KeyProvider

class LockrKeyProvider extends KeyProviderBase implements KeyProviderSettableValueInterface, KeyPluginFormInterface {

  /**
   * Drupal config factory.
   *
   * @var ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Lockr library client.
   *
   * @var Lockr
   */
  protected $lockr;

  /**
   * Logger channel.
   *
   * @var LoggerChannelInterface
   */
  protected $logger;

  /**
   * Constructs a new LockrKeyProvider.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param ConfigFactoryInterface $config_factory
   *   The simple config factory.
   * @param EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param Lockr $lockr
   *   The Lockr library client.
   * @param LoggerChannelFactoryInterface $logger_factory
   *   The Drupal logger channel factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, Lockr $lockr, LoggerChannelFactoryInterface $logger_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config_factory;
    $this->secretStorage = $entity_type_manager
      ->getStorage('lockr_secret');
    $this->lockr = $lockr;
    $this->logger = $logger_factory
      ->get('lockr');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('lockr.lockr'), $container
      ->get('logger.factory'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $info = $this->lockr
      ->getInfo();
    if (!$info) {
      $form['need_register'] = [
        '#prefix' => '<p>',
        '#markup' => $this
          ->t('This site has not yet registered with Lockr, please <a href="@link">click here to register</a>.', [
          '@link' => Url::fromRoute('lockr.admin')
            ->toString(),
        ]),
        '#suffix' => '</p>',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function getKeyValue(KeyInterface $key) {
    $key_id = $this
      ->getLockrSecretName($key
      ->id());
    try {
      return $this->lockr
        ->getSecretValue($key_id);
    } catch (\Exception $e) {
      if ($e
        ->getCode() === 404) {
        $key_type = $key
          ->getKeyType();
        if ($key_type
          ->getPluginId() === 'lockr_encryption') {
          $key_size = (int) $key_type
            ->getConfiguration()['key_size'];
          $new_value = $this->lockr
            ->generateKey($key_size);
          try {
            $this
              ->setKeyValue($key, $new_value);
          } catch (\Exception $e) {
            $this
              ->logException($e);
            return NULL;
          }
          return $new_value;
        }
      }
      $this
        ->logException($e);
      return NULL;
    }
  }

  /**
   * Logs exceptions that occur during Lockr requests.
   *
   * @param \Exception $e
   *   The exception to log.
   */
  protected function logException(\Exception $e) {
    $this->logger
      ->error('Error retrieving value from Lockr [{ex_code}]: {ex_msg}', [
      'ex_code' => $e
        ->getCode(),
      'ex_msg' => $e
        ->getMessage(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function setKeyValue(KeyInterface $key, $key_value) {
    $this->lockr
      ->createSecretValue($this
      ->getLockrSecretName($key
      ->id()), $key_value, $key
      ->label(), $this->configFactory
      ->get('lockr.settings')
      ->get('region'));
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function deleteKeyValue(KeyInterface $key) {
    $this->lockr
      ->deleteSecretValue($key
      ->id());
    return TRUE;
  }

  /**
   * Gets the lockr secret name for the given key ID.
   */
  public function getLockrSecretName($key_id) {
    $secrets = $this->secretStorage
      ->loadByProperties([
      'key_id' => $key_id,
    ]);
    if (!$secrets) {
      return $key_id;
    }
    return reset($secrets)
      ->id();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
KeyPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
KeyPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
KeyPluginBase::getPluginType	public	function	Returns the type of plugin. Overrides KeyPluginInterface::getPluginType
KeyPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
KeyProviderBase::obscureKeyValue	public static	function	Obscures a key value. Overrides KeyProviderInterface::obscureKeyValue	1
KeyProviderBase::obscureValue	protected static	function	Helper method to obscure a value.
KeyProviderBase::postSave	public	function	Allows a key provider to perform actions after a key entity is saved. Overrides KeyProviderInterface::postSave
LockrKeyProvider::$configFactory	protected	property	Drupal config factory.
LockrKeyProvider::$lockr	protected	property	Lockr library client.
LockrKeyProvider::$logger	protected	property	Logger channel.
LockrKeyProvider::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
LockrKeyProvider::create	public static	function	Creates an instance of the plugin. Overrides KeyPluginBase::create
LockrKeyProvider::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
LockrKeyProvider::deleteKeyValue	public	function	Deletes the value of a key. Overrides KeyProviderSettableValueInterface::deleteKeyValue
LockrKeyProvider::getKeyValue	public	function	Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
LockrKeyProvider::getLockrSecretName	public	function	Gets the lockr secret name for the given key ID.
LockrKeyProvider::logException	protected	function	Logs exceptions that occur during Lockr requests.
LockrKeyProvider::setKeyValue	public	function	Sets the value of a key. Overrides KeyProviderSettableValueInterface::setKeyValue
LockrKeyProvider::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
LockrKeyProvider::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
LockrKeyProvider::__construct	public	function	Constructs a new LockrKeyProvider. Overrides KeyPluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.