Class: Mongo::Crypt::KMS::Local::Credentials Private

Do not use. This class is for internal use only.

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Forwardable
Instance Chain: self, `::Mongo::Crypt::KMS::Validations`
Inherits:	Object
Defined in:	lib/mongo/crypt/kms/local/credentials.rb

Overview

::Mongo::Crypt::KMS::Local KMS Credentials object contains credentials for using local ::Mongo::Crypt::KMS provider.

"Local KMS provider options must be in the format: " +
"{ key: 'MASTER-KEY' }"

.new(opts) ⇒ Credentials constructor Internal use only

Creates a local ::Mongo::Crypt::KMS credentials object form a parameters hash.

#validate_param	Validate if a `::Mongo::Crypt::KMS` parameter is valid.
#validate_tls_options	Validate KMS TLS options.

Returns:

[ GitHub ]

# File 'lib/mongo/crypt/kms/local/credentials.rb', line 30


attr_reader :key

Returns:

(BSON::Document) —

::Mongo::Crypt::KMS::Local KMS credentials in libmongocrypt format.

[ GitHub ]

# File 'lib/mongo/crypt/kms/local/credentials.rb', line 54


def to_document
  return BSON::Document.new({}) if empty?
  BSON::Document.new({
    key: BSON::Binary.new(@key, :generic),
  })
end