Class: ActiveSupport::MessageEncryptor

Inherits:
ActiveSupport::Messages::Codec show all
Defined in:
activesupport/lib/active_support/message_encryptor.rb

Overview

MessageEncryptor is a simple way to encrypt values which get stored somewhere you don’t trust.

The cipher text and initialization vector are base64 encoded and returned to you.

This can be used in situations similar to the MessageVerifier, but where you don’t want users to be able to determine the value of the payload.

len   = ActiveSupport::MessageEncryptor.key_len
salt  = SecureRandom.random_bytes(len)
key   = ActiveSupport::KeyGenerator.new('password').generate_key(salt, len) # => "\x89\xE0\x156\xAC..."
crypt = ActiveSupport::MessageEncryptor.new(key)                            # => #<ActiveSupport::MessageEncryptor ...>
encrypted_data = crypt.encrypt_and_sign('my secret data')                   # => "NlFBTTMwOUV5UlA1QlNEN2xkY2d6eThYWWh..."
crypt.decrypt_and_verify(encrypted_data)                                    # => "my secret data"

The decrypt_and_verify method will raise an ActiveSupport::MessageEncryptor::InvalidMessage exception if the data provided cannot be decrypted or verified.

crypt.decrypt_and_verify('not encrypted data') # => ActiveSupport::MessageEncryptor::InvalidMessage

Confining messages to a specific purpose

By default any message can be used throughout your app. But they can also be confined to a specific :purpose.

token = crypt.encrypt_and_sign("this is the chair", purpose: :login)

Then that same purpose must be passed when verifying to get the data back out:

crypt.decrypt_and_verify(token, purpose: :login)    # => "this is the chair"
crypt.decrypt_and_verify(token, purpose: :shipping) # => nil
crypt.decrypt_and_verify(token)                     # => nil

Likewise, if a message has no purpose it won’t be returned when verifying with a specific purpose.

token = crypt.encrypt_and_sign("the conversation is lively")
crypt.decrypt_and_verify(token, purpose: :scare_tactics) # => nil
crypt.decrypt_and_verify(token)                          # => "the conversation is lively"

Making messages expire

By default messages last forever and verifying one year from now will still return the original value. But messages can be set to expire at a given time with :expires_in or :expires_at.

crypt.encrypt_and_sign(parcel, expires_in: 1.month)
crypt.encrypt_and_sign(doowad, expires_at: Time.now.end_of_year)

Then the messages can be verified and returned up to the expire time. Thereafter, verifying returns nil.

Rotating keys

MessageEncryptor also supports rotating out old configurations by falling back to a stack of encryptors. Call rotate to build and add an encryptor so decrypt_and_verify will also try the fallback.

By default any rotated encryptors use the values of the primary encryptor unless specified otherwise.

You’d give your encryptor the new defaults:

crypt = ActiveSupport::MessageEncryptor.new(@secret, cipher: "aes-256-gcm")

Then gradually rotate the old values out by adding them as fallbacks. Any message generated with the old values will then work until the rotation is removed.

crypt.rotate old_secret            # Fallback to an old secret instead of @secret.
crypt.rotate cipher: "aes-256-cbc" # Fallback to an old cipher instead of aes-256-gcm.

Though if both the secret and the cipher was changed at the same time, the above should be combined into:

crypt.rotate old_secret, cipher: "aes-256-cbc"

Defined Under Namespace

Modules: NullSerializer Classes: InvalidMessage

Constant Summary collapse

OpenSSLCipherError = 
OpenSSL::Cipher::CipherError
AUTH_TAG_LENGTH =

:nodoc:

16
SEPARATOR =

:nodoc:

"--"

Constants included from ActiveSupport::Messages::Metadata

ActiveSupport::Messages::Metadata::ENVELOPE_SERIALIZERS

Instance Attribute Summary

Attributes included from ActiveSupport::Messages::Metadata

#use_message_serializer_for_metadata

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret, sign_secret = nil, cipher: nil, digest: nil, serializer: nil, url_safe: false) ⇒ MessageEncryptor

Initialize a new MessageEncryptor. secret must be at least as long as the cipher key size. For the default ‘aes-256-gcm’ cipher, this is 256 bits. If you are using a user-entered secret, you can generate a suitable key by using ActiveSupport::KeyGenerator or a similar key derivation function.

First additional parameter is used as the signature key for MessageVerifier. This allows you to specify keys to encrypt and sign data.

ActiveSupport::MessageEncryptor.new('secret', 'signature_secret')

Options:

  • :cipher - Cipher to use. Can be any cipher returned by OpenSSL::Cipher.ciphers. Default is ‘aes-256-gcm’.

  • :digest - String of digest to use for signing. Default is SHA1. Ignored when using an AEAD cipher like ‘aes-256-gcm’.

  • :serializer - Object serializer to use. Default is JSON.

  • :url_safe - Whether to encode messages using a URL-safe encoding. Default is false for backward compatibility.



139
140
141
142
143
144
145
146
147
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 139

def initialize(secret, sign_secret = nil, cipher: nil, digest: nil, serializer: nil, url_safe: false)
  super(serializer: serializer || @@default_message_encryptor_serializer, url_safe: url_safe)
  @secret = secret
  @cipher = cipher || self.class.default_cipher
  @aead_mode = new_cipher.authenticated?
  @verifier = if !@aead_mode
    MessageVerifier.new(sign_secret || secret, digest: digest || "SHA1", serializer: NullSerializer, url_safe: url_safe)
  end
end

Class Method Details

.default_cipher ⇒ Object

:nodoc:



95
96
97
98
99
100
101
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 95

def default_cipher # :nodoc:
  if use_authenticated_message_encryption
    "aes-256-gcm"
  else
    "aes-256-cbc"
  end
end

.key_len(cipher = default_cipher) ⇒ Object

Given a cipher, returns the key length of the cipher to help generate the key of desired size



208
209
210
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 208

def self.key_len(cipher = default_cipher)
  OpenSSL::Cipher.new(cipher).key_len
end

Instance Method Details

#create_message(value, **options) ⇒ Object

:nodoc:



212
213
214
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 212

def create_message(value, **options) # :nodoc:
  sign(encrypt(serialize_with_metadata(value, **options)))
end

#decrypt_and_verify(message, **options) ⇒ Object

Decrypt and verify a message. We need to verify the message in order to avoid padding attacks. Reference: www.limited-entropy.com/padding-oracle-attacks/.

Options

:purpose

The purpose that the message was generated with. If the purpose does not match, decrypt_and_verify will return nil.

message = encryptor.encrypt_and_sign("hello", purpose: "greeting")
encryptor.decrypt_and_verify(message, purpose: "greeting") # => "hello"
encryptor.decrypt_and_verify(message)                      # => nil

message = encryptor.encrypt_and_sign("bye")
encryptor.decrypt_and_verify(message)                      # => "bye"
encryptor.decrypt_and_verify(message, purpose: "greeting") # => nil



197
198
199
200
201
202
203
204
205
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 197

def decrypt_and_verify(message, **options)
  catch_and_raise :invalid_message_format, as: InvalidMessage do
    catch_and_raise :invalid_message_serialization, as: InvalidMessage do
      catch_and_ignore :invalid_message_content do
        read_message(message, **options)
      end
    end
  end
end

#encrypt_and_sign(value, **options) ⇒ Object

Encrypt and sign a message. We need to sign the message in order to avoid padding attacks. Reference: www.limited-entropy.com/padding-oracle-attacks/.

Options

:expires_at

The datetime at which the message expires. After this datetime, verification of the message will fail.

message = encryptor.encrypt_and_sign("hello", expires_at: Time.now.tomorrow)
encryptor.decrypt_and_verify(message) # => "hello"
# 24 hours later...
encryptor.decrypt_and_verify(message) # => nil
:expires_in

The duration for which the message is valid. After this duration has elapsed, verification of the message will fail.

message = encryptor.encrypt_and_sign("hello", expires_in: 24.hours)
encryptor.decrypt_and_verify(message) # => "hello"
# 24 hours later...
encryptor.decrypt_and_verify(message) # => nil
:purpose

The purpose of the message. If specified, the same purpose must be specified when verifying the message; otherwise, verification will fail. (See #decrypt_and_verify.)



176
177
178
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 176

def encrypt_and_sign(value, **options)
  create_message(value, **options)
end

#read_message(message, **options) ⇒ Object

:nodoc:



216
217
218
 
# File 'activesupport/lib/active_support/message_encryptor.rb', line 216

def read_message(message, **options) # :nodoc:
  deserialize_with_metadata(decrypt(verify(message)), **options)
end