You are here

Home » API reference » Key 8 » EncryptionKeyType.php

class EncryptionKeyType in Key 8

Defines a generic key type for encryption.

Plugin annotation


@KeyType(
  id = "encryption",
  label = @Translation("Encryption"),
  description = @Translation("A generic key type to use for an encryption key that does not belong to any other defined key type."),
  group = "encryption",
  key_value = {
    "plugin" = "text_field"
  }
)

Hierarchy

Expanded class hierarchy of EncryptionKeyType

File

src/Plugin/KeyType/EncryptionKeyType.php, line 22

Namespace

Drupal\key\Plugin\KeyType
View source 
class EncryptionKeyType extends KeyTypeBase implements KeyPluginFormInterface {

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

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

    // Define the most common key size options.
    $key_size_options = [
      '128' => 128,
      '256' => 256,
    ];
    $key_size = $this
      ->getConfiguration()['key_size'];
    $key_size_other_value = '';
    if (!in_array($key_size, $key_size_options)) {
      $key_size_other_value = $key_size;
      $key_size = 'other';
    }
    $form['key_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Key size'),
      '#description' => $this
        ->t('The size of the key in bits, with 8 bits per byte.'),
      '#options' => $key_size_options + [
        'other' => $this
          ->t('Other'),
      ],
      '#default_value' => $key_size,
      '#required' => TRUE,
    ];
    $form['key_size_other_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Key size (other value)'),
      '#title_display' => 'invisible',
      '#description' => $this
        ->t('Enter a custom key size in bits.'),
      '#default_value' => $key_size_other_value,
      '#maxlength' => 20,
      '#size' => 20,
      '#states' => [
        'visible' => [
          'select[name="key_type_settings[key_size]"]' => [
            'value' => 'other',
          ],
        ],
        'required' => [
          'select[name="key_type_settings[key_size]"]' => [
            'value' => 'other',
          ],
        ],
      ],
    ];
    return $form;
  }

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

    // If 'Other' was selected for the key size, use the custom entered value.
    $key_size = $form_state
      ->getValue('key_size');
    if ($key_size == 'other') {
      $form_state
        ->setValue('key_size', $form_state
        ->getValue('key_size_other_value'));
    }
    $form_state
      ->unsetValue('key_size_other_value');
  }

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

  /**
   * {@inheritdoc}
   */
  public static function generateKeyValue(array $configuration) {
    if (!empty($configuration['key_size'])) {
      $bytes = $configuration['key_size'] / 8;
    }
    else {

      // If no key size has been defined, use 32 bytes as the default.
      $bytes = 32;
    }
    $random_key = random_bytes($bytes);
    return $random_key;
  }

  /**
   * {@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

Namesort descending 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
EncryptionKeyType::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
EncryptionKeyType::defaultConfiguration public function Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
EncryptionKeyType::generateKeyValue public static function Generate a key value of this type using the submitted configuration. Overrides KeyTypeInterface::generateKeyValue
EncryptionKeyType::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
EncryptionKeyType::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
EncryptionKeyType::validateKeyValue public function Allows the Key Type plugin to validate the key value. Overrides KeyTypeInterface::validateKeyValue
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
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.