Class: Mongo::ClientEncryption

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/client_encryption.rb

Overview

ClientEncryption encapsulates explicit operations on a key vault collection that cannot be done directly on a MongoClient. It provides an API for explicitly encrypting and decrypting values, and creating data keys.

Instance Method Summary collapse

Constructor Details

#initialize(key_vault_client, options = {}) ⇒ ClientEncryption

Create a new ClientEncryption object with the provided options.

Parameters:

  • key_vault_client (Mongo::Client) —

    A Mongo::Client that is connected to the MongoDB instance where the key vault collection is stored.

  • options (Hash) (defaults to: {}) —

    The ClientEncryption options.

Options Hash (options):

  • :key_vault_namespace (String) —

    The name of the key vault collection in the format “database.collection”.

  • :kms_providers (Hash) —

    A hash of key management service configuration information. @see Mongo::Crypt::KMS::Credentials for list of options for every supported provider. @note There may be more than one KMS provider specified.

  • :kms_tls_options (Hash) —

    TLS options to connect to KMS providers. Keys of the hash should be KSM provider names; values should be hashes of TLS connection options. The options are equivalent to TLS connection options of Mongo::Client. @see Mongo::Client#initialize for list of TLS options.

Raises:

  • (ArgumentError) —

    If required options are missing or incorrectly formatted.



46
47
48
49
50
51
52
53
 
# File 'lib/mongo/client_encryption.rb', line 46

def initialize(key_vault_client, options = {})
  @encrypter = Crypt::ExplicitEncrypter.new(
    key_vault_client,
    options[:key_vault_namespace],
    Crypt::KMS::Credentials.new(options[:kms_providers]),
    Crypt::KMS::Validations.validate_tls_options(options[:kms_tls_options])
  )
end

Instance Method Details

#add_key_alt_name(id, key_alt_name) ⇒ BSON::Document | nil

Adds a key_alt_name for the key in the key vault collection with the given id.

Parameters:

  • id (BSON::Binary) —

    Id of the key to add new key alt name.

  • key_alt_name (String) —

    New key alt name to add.

Returns:

  • (BSON::Document | nil) —

    Document describing the identified key before adding the key alt name, or nil if no such key.



140
141
142
 
# File 'lib/mongo/client_encryption.rb', line 140

def add_key_alt_name(id, key_alt_name)
  @encrypter.add_key_alt_name(id, key_alt_name)
end

#create_data_key(kms_provider, options = {}) ⇒ BSON::Binary

Generates a data key used for encryption/decryption and stores that key in the KMS collection. The generated key is encrypted with the KMS master key.

Parameters:

  • kms_provider (String) —

    The KMS provider to use. Valid values are “aws” and “local”.

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :master_key (Hash) —

    Information about the AWS master key. Required if kms_provider is “aws”.

    • :region [ String ] The The AWS region of the master key (required).

    • :key [ String ] The Amazon Resource Name (ARN) of the master key (required).

    • :endpoint [ String ] An alternate host to send KMS requests to (optional). endpoint should be a host name with an optional port number separated by a colon (e.g. “kms.us-east-1.amazonaws.com” or “kms.us-east-1.amazonaws.com:443”). An endpoint in any other format will not be properly parsed.

  • :key_alt_names (Array<String>) —

    An optional array of strings specifying alternate names for the new data key.

  • :key_material (String | nil) —

    Optional 96 bytes to use as custom key material for the data key being created. If :key_material option is given, the custom key material is used for encrypting and decrypting data.

Returns:

  • (BSON::Binary) —

    The 16-byte UUID of the new data key as a BSON::Binary object with type :uuid.



81
82
83
84
85
86
87
 
# File 'lib/mongo/client_encryption.rb', line 81

def create_data_key(kms_provider, options={})
  key_document = Crypt::KMS::MasterKeyDocument.new(kms_provider, options)

  key_alt_names = options[:key_alt_names]
  key_material = options[:key_material]
  @encrypter.create_and_insert_data_key(key_document, key_alt_names, key_material)
end

#decrypt(value) ⇒ Object

Decrypts a value that has already been encrypted.

Parameters:

  • value (BSON::Binary) —

    A BSON Binary object of subtype 6 (ciphertext) that will be decrypted.

Returns:

  • (Object) —

    The decrypted value.



129
130
131
 
# File 'lib/mongo/client_encryption.rb', line 129

def decrypt(value)
  @encrypter.decrypt(value)
end

#delete_key(id) ⇒ Operation::Result

Removes the key with the given id from the key vault collection.

Parameters:

  • id (BSON::Binary) —

    Id of the key to delete.

Returns:

  • (Operation::Result) —

    The response from the database for the delete_one operation that deletes the key.



150
151
152
 
# File 'lib/mongo/client_encryption.rb', line 150

def delete_key(id)
  @encrypter.delete_key(id)
end

#encrypt(value, options = {}) ⇒ BSON::Binary

Note:

The :key_id and :key_alt_name options are mutually exclusive. Only one is required to perform explicit encryption.

Encrypts a value using the specified encryption key and algorithm.

if encryption algorithm is set to “Indexed”. Query type should be set

only if encryption algorithm is set to "Indexed". The only allowed
value is "equality".

Parameters:

  • value (Object) —

    The value to encrypt.

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :key_id (BSON::Binary) —

    A BSON::Binary object of type :uuid representing the UUID of the encryption key as it is stored in the key vault collection.

  • :key_alt_name (String) —

    The alternate name for the encryption key.

  • :algorithm (String) —

    The algorithm used to encrypt the value. Valid algorithms are “AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic”, “AEAD_AES_256_CBC_HMAC_SHA_512-Random”, “Indexed”, “Unindexed”.

  • :contention_factor (Integer | nil) —

    Contention factor to be applied if encryption algorithm is set to “Indexed”. If not provided, it defaults to a value of 0. Contention factor should be set only if encryption algorithm is set to “Indexed”.

  • query_type (String | nil) —

    Query type to be applied

Returns:

  • (BSON::Binary) —

    A BSON Binary object of subtype 6 (ciphertext) representing the encrypted value.

Raises:

  • (ArgumentError) —

    if either contention_factor or query_type is set, and algorithm is not “Indexed”.



119
120
121
 
# File 'lib/mongo/client_encryption.rb', line 119

def encrypt(value, options={})
  @encrypter.encrypt(value, options)
end

#get_key(id) ⇒ BSON::Document | nil

Finds a single key with the given id.

Parameters:

  • id (BSON::Binary) —

    Id of the key to get.

Returns:

  • (BSON::Document | nil) —

    The found key document or nil if not found.



160
161
162
 
# File 'lib/mongo/client_encryption.rb', line 160

def get_key(id)
  @encrypter.get_key(id)
end

#get_key_by_alt_name(key_alt_name) ⇒ BSON::Document | nil

Returns a key in the key vault collection with the given key_alt_name.

Parameters:

  • key_alt_name (String) —

    Key alt name to find a key.

Returns:

  • (BSON::Document | nil) —

    The found key document or nil if not found.



170
171
172
 
# File 'lib/mongo/client_encryption.rb', line 170

def get_key_by_alt_name(key_alt_name)
  @encrypter.get_key_by_alt_name(key_alt_name)
end

#get_keys ⇒ Collection::View Also known as: keys

Returns all keys in the key vault collection.

Returns:



177
178
179
 
# File 'lib/mongo/client_encryption.rb', line 177

def get_keys
  @encrypter.get_keys
end

#remove_key_alt_name(id, key_alt_name) ⇒ BSON::Document | nil

Removes a key_alt_name from a key in the key vault collection with the given id.

Parameters:

  • id (BSON::Binary) —

    Id of the key to remove key alt name.

  • key_alt_name (String) —

    Key alt name to remove.

Returns:

  • (BSON::Document | nil) —

    Document describing the identified key before removing the key alt name, or nil if no such key.



189
190
191
 
# File 'lib/mongo/client_encryption.rb', line 189

def remove_key_alt_name(id, key_alt_name)
  @encrypter.remove_key_alt_name(id, key_alt_name)
end

#rewrap_many_data_key(filter, opts = {}) ⇒ Crypt::RewrapManyDataKeyResult

Decrypts multiple data keys and (re-)encrypts them with a new master_key,

or with their current master_key if a new one is not given.

Parameters:

  • filter (Hash) —

    Filter used to find keys to be updated.

  • options (Hash)

Returns:



204
205
206
 
# File 'lib/mongo/client_encryption.rb', line 204

def rewrap_many_data_key(filter, opts = {})
  @encrypter.rewrap_many_data_key(filter, opts)
end