class LockrEncryptionKeyType in Lockr 8.2

Defines a key type for encryption that generates keys with Lockr.

Plugin annotation

@KeyType(
  id = "lockr_encryption",
  label = @Translation("Lockr Encryption"),
  description = @Translation("A key type used for encryption, generating keys using Townsend AKM."),
  group = "encryption",
  key_value = {
    "plugin" = "generate"
  }
)

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\KeyTypeBase implements KeyTypeInterface
        • class \Drupal\lockr\Plugin\KeyType\LockrEncryptionKeyType implements KeyPluginFormInterface

File

src/Plugin/KeyType/LockrEncryptionKeyType.php, line 23

Namespace

Drupal\lockr\Plugin\KeyType

class LockrEncryptionKeyType extends KeyTypeBase implements KeyPluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'key_size' => 256,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $key_size_options = [
      '128' => 128,
      '192' => 192,
      '256' => 256,
    ];
    $key_size = $this
      ->getConfiguration()['key_size'];
    $form['key_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Key size'),
      '#description' => $this
        ->t('The size of the key in bits.'),
      '#options' => $key_size_options,
      '#default_value' => $key_size,
      '#required' => TRUE,
    ];
    return $form;
  }

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

    // Default validation is fine.
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public static function generateKeyValue(array $configuration) {
    $key_size = $configuration['key_size'];
    $key_client = \Drupal::service('lockr.client_factory')
      ->getKeyClient();
    return $key_client
      ->create($key_size);
  }

  /**
   * {@inheritdoc}
   */
  public function validateKeyValue(array $form, FormStateInterface $form_state, $key_value) {
    if (!$form_state
      ->getValue('key_size')) {
      return;
    }

    // Validate the key size.
    $bytes = $form_state
      ->getValue('key_size') / 8;
    if (strlen($key_value) != $bytes) {
      $form_state
        ->setErrorByName('key_size', $this
        ->t('The selected key size does not match the actual size of the key.'));
    }
  }

}

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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
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
KeyPluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
LockrEncryptionKeyType::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
LockrEncryptionKeyType::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
LockrEncryptionKeyType::generateKeyValue	public static	function	Generate a key value of this type using the submitted configuration. Overrides KeyTypeInterface::generateKeyValue
LockrEncryptionKeyType::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
LockrEncryptionKeyType::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
LockrEncryptionKeyType::validateKeyValue	public	function	Allows the Key Type plugin to validate the key value. Overrides KeyTypeInterface::validateKeyValue
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.