Skip to content

Commit

Permalink
Merge pull request #52633 from neilvcarvalho/nc-ar-encryption-docs
Browse files Browse the repository at this point in the history
Fix Active Record Encryption documentation [ci skip]
  • Loading branch information
kamipo committed Aug 18, 2024
1 parent 961ab4e commit 3802675
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion activerecord/lib/active_record/encryption/encryptor.rb
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def encrypt(clear_text, key_provider: default_key_provider, cipher_options: {})
serialize_message build_encrypted_message(clear_text, key_provider: key_provider, cipher_options: cipher_options)
end

# Decrypts a +clean_text+ and returns the result as clean text
# Decrypts an +encrypted_text+ and returns the result as clean text
#
# === Options
#
Expand Down
2 changes: 1 addition & 1 deletion guides/source/active_record_encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ end
Both methods return `ActiveRecord::Encryption::Key` objects:

- `encryption_key` returns the key used for encrypting some content
- `decryption keys` returns a list of potential keys for decrypting a given message
- `decryption_keys` returns a list of potential keys for decrypting a given message

A key can include arbitrary tags that will be stored unencrypted with the message. You can use `ActiveRecord::Encryption::Message#headers` to examine those values when decrypting.

Expand Down

0 comments on commit 3802675

Please sign in to comment.