class RealAESEncryptionMethod in Real AES 8.2

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_group = {"encryption"},
  can_decrypt = TRUE
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\encrypt\Plugin\EncryptionMethod\EncryptionMethodBase implements ConfigurableInterface, DependentPluginInterface, EncryptionMethodInterface
      • class \Drupal\real_aes\Plugin\EncryptionMethod\RealAESEncryptionMethod implements EncryptionMethodInterface

File

src/Plugin/EncryptionMethod/RealAESEncryptionMethod.php, line 23

Namespace

Drupal\real_aes\Plugin\EncryptionMethod

class RealAESEncryptionMethod extends EncryptionMethodBase implements EncryptionMethodInterface {

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

    // Check if the key size meets the requirement.
    if (strlen($key) != Key::KEY_BYTE_SIZE) {
      $errors[] = $this
        ->t("This encryption method requires a @size byte key.", [
        '@size' => Key::KEY_BYTE_SIZE,
      ]);
    }
    return $errors;
  }

  /**
   * {@inheritdoc}
   */
  public function encrypt($text, $key, $options = []) {
    try {

      // Defuse PHP-Encryption requires a key object instead of a string.
      $key = Encoding::saveBytesToChecksummedAsciiSafeString(Key::KEY_CURRENT_VERSION, $key);
      $key = Key::loadFromAsciiSafeString($key);
      return Crypto::encrypt((string) $text, $key);
    } catch (Ex\CryptoException $ex) {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function decrypt($text, $key, $options = []) {
    try {

      // Defuse PHP-Encryption requires a key object instead of a string.
      $key = Encoding::saveBytesToChecksummedAsciiSafeString(Key::KEY_CURRENT_VERSION, $key);
      $key = Key::loadFromAsciiSafeString($key);
      return Crypto::decrypt((string) $text, $key);
    } catch (Ex\CryptoException $ex) {
      return FALSE;
    }
  }

}

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
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.