method

decrypt

v7.1.3.2 - Show latest stable - 0 notes - Class: Encryptor

1.0.0
1.1.6
1.2.6
2.0.3
2.1.0
2.2.1
2.3.8
3.0.0
3.0.9
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0 (0)
7.1.3.2 (-38)
7.1.3.4 (0)
What's this?

decrypt(encrypted_text, key_provider: default_key_provider, cipher_options: {}) public

Decrypts a clean_text and returns the result as clean text

Options

:key_provider: Key provider to use for the encryption operation. It will default to +ActiveRecord::Encryption.key_provider+ when not provided
:cipher_options: Cipher-specific options that will be passed to the Cipher configured in +ActiveRecord::Encryption.cipher+

Show source

# File activerecord/lib/active_record/encryption/encryptor.rb, line 52
      def decrypt(encrypted_text, key_provider: default_key_provider, cipher_options: {})
        message = deserialize_message(encrypted_text)
        keys = key_provider.decryption_keys(message)
        raise Errors::Decryption unless keys.present?
        uncompress_if_needed(cipher.decrypt(message, key: keys.collect(&:secret), **cipher_options), message.headers.compressed)
      rescue *(ENCODING_ERRORS + DECRYPT_ERRORS)
        raise Errors::Decryption
      end

decrypt

Related methods

Options