You are here

class RealAESEncryptionMethod in Real AES 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/EncryptionMethod/RealAESEncryptionMethod.php \Drupal\real_aes\Plugin\EncryptionMethod\RealAESEncryptionMethod

Class RealAESEncryptionMethod.

Plugin annotation


@EncryptionMethod(
  id = "real_aes",
  title = @Translation("Authenticated AES (Real AES)"),
  description = "Authenticated encryption based on AES-128 in CBC mode. Verifies ciphertext integrity via an Encrypt-then-MAC scheme using HMAC-SHA256.",
  key_type = {"encryption"}
)

Hierarchy

Expanded class hierarchy of RealAESEncryptionMethod

File

src/Plugin/EncryptionMethod/RealAESEncryptionMethod.php, line 25
Contains \Drupal\real_aes\Plugin\EncryptionMethod\RealAESEncryptionMethod.

Namespace

Drupal\real_aes\Plugin\EncryptionMethod
View source
class RealAESEncryptionMethod extends EncryptionMethodBase implements EncryptionMethodInterface {

  /**
   * {@inheritdoc}
   */
  public function checkDependencies($text = NULL, $key = NULL) {
    $errors = array();
    if (!class_exists('\\Defuse\\Crypto\\Crypto')) {
      $errors[] = t('Defuse PHP Encryption library is not correctly installed.');
    }

    // Check if we have a 128 bit key.
    if (strlen($key) != 16) {
      $errors[] = t('This encryption method requires a 128 bit key.');
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function encrypt($text, $key, $options = array()) {
    try {
      return Crypto::encrypt($text, $key);
    } catch (Ex\CryptoTestFailed $ex) {
      return FALSE;
    } catch (Ex\CannotPerformOperation $ex) {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function decrypt($text, $key, $options = array()) {
    try {
      return Crypto::decrypt($text, $key);
    } catch (Ex\CryptoTestFailed $ex) {
      return FALSE;
    } catch (Ex\CannotPerformOperation $ex) {
      return FALSE;
    }
  }

}

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
EncryptionMethodBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EncryptionMethodBase::canDecrypt public function Define if encryption method can also decrypt. Overrides EncryptionMethodInterface::canDecrypt
EncryptionMethodBase::create public static function
EncryptionMethodBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
EncryptionMethodBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EncryptionMethodBase::getLabel public function Get the label. Overrides EncryptionMethodInterface::getLabel
EncryptionMethodBase::isDeprecated public function Define if encryption method is deprecated. Overrides EncryptionMethodInterface::isDeprecated
EncryptionMethodBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EncryptionMethodBase::__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.
RealAESEncryptionMethod::checkDependencies public function Check dependencies for the encryption method. Overrides EncryptionMethodInterface::checkDependencies
RealAESEncryptionMethod::decrypt public function Decrypt text. Overrides EncryptionMethodInterface::decrypt
RealAESEncryptionMethod::encrypt public function Encrypt text. Overrides EncryptionMethodInterface::encrypt
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.