method

encrypt

v7.1.3.4 - 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?

encrypt(clear_text, key_provider: default_key_provider, cipher_options: {}) public

Encrypts clean_text and returns the encrypted result

Internally, it will:

Create a new ActiveRecord::Encryption::Message
Compress and encrypt clean_text as the message payload
Serialize it with +ActiveRecord::Encryption.message_serializer+ (+ActiveRecord::Encryption::SafeMarshal+ by default)
Encode the result with Base 64

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 34
      def encrypt(clear_text, key_provider: default_key_provider, cipher_options: {})
        clear_text = force_encoding_if_needed(clear_text) if cipher_options[:deterministic]

        validate_payload_type(clear_text)
        serialize_message build_encrypted_message(clear_text, key_provider: key_provider, cipher_options: cipher_options)
      end

encrypt

Related methods

Options