You are here

Home » API reference » Key 8 » FileKeyProvider.php

class FileKeyProvider in Key 8

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

Plugin annotation


@KeyProvider(
  id = "file",
  label = @Translation("File"),
  description = @Translation("The File key provider allows a key to be stored in a file, preferably outside of the web root."),
  storage_method = "file",
  key_value = {
    "accepted" = FALSE,
    "required" = FALSE
  }
)

Hierarchy

Expanded class hierarchy of FileKeyProvider

File

src/Plugin/KeyProvider/FileKeyProvider.php, line 24

Namespace

Drupal\key\Plugin\KeyProvider
View source 
class FileKeyProvider extends KeyProviderBase implements KeyPluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'file_location' => '',
      'base64_encoded' => FALSE,
      'strip_line_breaks' => FALSE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['file_location'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('File location'),
      '#description' => $this
        ->t('The location of the file in which the key will be stored. The path may be absolute (e.g., %abs), relative to the Drupal directory (e.g., %rel), or defined using a stream wrapper (e.g., %str).', [
        '%abs' => '/etc/keys/foobar.key',
        '%rel' => '../keys/foobar.key',
        '%str' => 'private://keys/foobar.key',
      ]),
      '#required' => TRUE,
      '#default_value' => $this
        ->getConfiguration()['file_location'],
    ];
    $form['strip_line_breaks'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Strip trailing line breaks'),
      '#description' => $this
        ->t('Check this to remove any trailing line breaks from the file. Leave unchecked if there is a chance that a line break could be a valid character in the key.'),
      '#default_value' => $this
        ->getConfiguration()['strip_line_breaks'],
    ];

    // If this key type is for an encryption key.
    if ($form_state
      ->getFormObject()
      ->getEntity()
      ->getKeyType()
      ->getPluginDefinition()['group'] == 'encryption') {

      // Add an option to indicate that the value is stored Base64-encoded.
      $form['base64_encoded'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Base64-encoded'),
        '#description' => $this
          ->t('Check this if the key in the file is Base64-encoded.'),
        '#default_value' => $this
          ->getConfiguration()['base64_encoded'],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $key_provider_settings = $form_state
      ->getValues();
    $file = $key_provider_settings['file_location'];

    // Does the file exist?
    if (!is_file($file)) {
      $form_state
        ->setErrorByName('file_location', $this
        ->t('There is no file at the specified location.'));
      return;
    }

    // Is the file readable?
    if (!is_readable($file)) {
      $form_state
        ->setErrorByName('file_location', $this
        ->t('The file at the specified location is not readable.'));
      return;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getKeyValue(KeyInterface $key) {
    $file = $this->configuration['file_location'];

    // Make sure the file exists and is readable.
    if (!is_file($file) || !is_readable($file)) {
      return NULL;
    }
    $key_value = file_get_contents($file);
    if (isset($this->configuration['strip_line_breaks']) && $this->configuration['strip_line_breaks'] == TRUE) {
      $key_value = rtrim($key_value, "\n\r");
    }
    if (isset($this->configuration['base64_encoded']) && $this->configuration['base64_encoded'] == TRUE) {
      $key_value = base64_decode($key_value);
    }
    return $key_value;
  }

}

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
FileKeyProvider::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
FileKeyProvider::defaultConfiguration public function Gets default configuration for this plugin. Overrides KeyPluginBase::defaultConfiguration
FileKeyProvider::getKeyValue public function Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
FileKeyProvider::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
FileKeyProvider::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
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
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.