Class: Mongo::Crypt::Binding Private

Inherits:
Object
  • Object
show all
Extended by:
FFI::Library
Defined in:
build/ruby-driver-master/lib/mongo/crypt/binding.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A Ruby binding for the libmongocrypt C library

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.check_ctx_status(context) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raise a Mongo::Error::CryptError based on the status of the underlying mongocrypt_ctx_t object.

Returns:

  • (nil) —

    Always nil.



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1196

def self.check_ctx_status(context)
  if block_given?
    do_raise = !yield
  else
    do_raise = true
  end

  if do_raise
    status = Status.new

    mongocrypt_ctx_status(context.ctx_p, status.ref)
    status.raise_crypt_error
  end
end

.check_kms_ctx_status(kms_context) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

If the provided block returns false, raise a CryptError with the status information from the provided KmsContext object.

Parameters:

Raises:



932
933
934
935
936
937
938
939
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 932

def self.check_kms_ctx_status(kms_context)
  unless yield
    status = Status.new

    mongocrypt_kms_ctx_status(kms_context.kms_ctx_p, status.ref)
    status.raise_crypt_error
  end
end

.check_status(handle) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raise a Mongo::Error::CryptError based on the status of the underlying mongocrypt_t object.

Returns:

  • (nil) —

    Always nil.



1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1183

def self.check_status(handle)
  unless yield
    status = Status.new

    mongocrypt_status(handle.ref, status.ref)
    status.raise_crypt_error
  end
end

.ctx_datakey_init(context) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Context to create a data key

Parameters:

Raises:



519
520
521
522
523
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 519

def self.ctx_datakey_init(context)
  check_ctx_status(context) do
    mongocrypt_ctx_datakey_init(context.ctx_p)
  end
end

.ctx_decrypt_init(context, command) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Context for auto-decryption

Parameters:

Raises:



612
613
614
615
616
617
618
619
620
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 612

def self.ctx_decrypt_init(context, command)
  validate_document(command)
  data = command.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_decrypt_init(context.ctx_p, data_p)
    end
  end
end

.ctx_encrypt_init(context, db_name, command) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Context for auto-encryption

Parameters:

  • context (Mongo::Crypt::Context)
  • db_name (String) —

    The name of the database against which the encrypted command is being performed

  • command (Hash) —

    The command to be encrypted

Raises:



552
553
554
555
556
557
558
559
560
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 552

def self.ctx_encrypt_init(context, db_name, command)
  validate_document(command)
  data = command.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_encrypt_init(context.ctx_p, db_name, -1, data_p)
    end
  end
end

.ctx_explicit_decrypt_init(context, doc) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Context for explicit decryption

Parameters:

Raises:



642
643
644
645
646
647
648
649
650
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 642

def self.ctx_explicit_decrypt_init(context, doc)
  validate_document(doc)
  data = doc.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_explicit_decrypt_init(context.ctx_p, data_p)
    end
  end
end

.ctx_explicit_encrypt_init(context, doc) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Context for explicit encryption

Parameters:

Raises:



586
587
588
589
590
591
592
593
594
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 586

def self.ctx_explicit_encrypt_init(context, doc)
  validate_document(doc)
  data = doc.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_explicit_encrypt_init(context.ctx_p, data_p)
    end
  end
end

.ctx_finalize(context) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Finalize the state machine represented by the Context

Parameters:

Raises:



978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 978

def self.ctx_finalize(context)
  binary = Binary.new

  check_ctx_status(context) do
    mongocrypt_ctx_finalize(context.ctx_p, binary.ref)
  end

  # TODO since the binary references a C pointer, and ByteBuffer is
  # written in C in MRI, we could omit a copy of the data by making
  # ByteBuffer reference the string that is owned by libmongocrypt.
  BSON::Document.from_bson(BSON::ByteBuffer.new(binary.to_s), mode: :bson)
end

.ctx_kms_done(context) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicate to libmongocrypt that it will receive no more KMS replies.

Parameters:

Raises:



955
956
957
958
959
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 955

def self.ctx_kms_done(context)
  check_ctx_status(context) do
    mongocrypt_ctx_kms_done(context.ctx_p)
  end
end

.ctx_mongo_feed(context, doc) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Feed a response from the driver back to libmongocrypt

Parameters:

Raises:



722
723
724
725
726
727
728
729
730
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 722

def self.ctx_mongo_feed(context, doc)
  validate_document(doc)
  data = doc.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_mongo_feed(context.ctx_p, data_p)
    end
  end
end

.ctx_mongo_op(context) ⇒ BSON::Document

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a BSON::Document representing an operation that the driver must perform on behalf of libmongocrypt to get the information it needs in order to continue with encryption/decryption (for example, a filter for a key vault query).

Parameters:

Returns:

  • (BSON::Document) —

    The operation that the driver must perform

Raises:

  • (Mongo::Crypt) —

    If there is an error getting the operation



693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 693

def self.ctx_mongo_op(context)
  binary = Binary.new

  check_ctx_status(context) do
    mongocrypt_ctx_mongo_op(context.ctx_p, binary.ref)
  end

  # TODO since the binary references a C pointer, and ByteBuffer is
  # written in C in MRI, we could omit a copy of the data by making
  # ByteBuffer reference the string that is owned by libmongocrypt.
  BSON::Document.from_bson(BSON::ByteBuffer.new(binary.to_s), mode: :bson)
end

.ctx_next_kms_ctx(context) ⇒ Mongo::Crypt::KmsContext | nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return a new KmsContext object needed by a Context object.

Parameters:

Returns:

  • (Mongo::Crypt::KmsContext | nil) —

    The KmsContext needed to fetch an AWS master key or nil, if no KmsContext is needed



754
755
756
757
758
759
760
761
762
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 754

def self.ctx_next_kms_ctx(context)
  kms_ctx_p = mongocrypt_ctx_next_kms_ctx(context.ctx_p)

  if kms_ctx_p.null?
    nil
  else
    KmsContext.new(kms_ctx_p)
  end
end

.ctx_setopt_algorithm(context, name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set the algorithm on the context

Parameters:

  • context (Mongo::Crypt::Context)
  • name (String) —

    The algorithm name. Valid values are:

    • “AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic”

    • “AEAD_AES_256_CBC_HMAC_SHA_512-Random”

Raises:



463
464
465
466
467
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 463

def self.ctx_setopt_algorithm(context, name)
  check_ctx_status(context) do
    mongocrypt_ctx_setopt_algorithm(context.ctx_p, name, -1)
  end
end

.ctx_setopt_key_alt_names(context, key_alt_names) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set multiple alternate key names on data key creation

Parameters:

  • context (Mongo::Crypt::Context) —

    A DataKeyContext

  • key_alt_names (Array) —

    An array of alternate key names as strings

Raises:



426
427
428
429
430
431
432
433
434
435
436
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 426

def self.ctx_setopt_key_alt_names(context, key_alt_names)
  key_alt_names.each do |key_alt_name|
    key_alt_name_bson = { :keyAltName => key_alt_name }.to_bson.to_s

    Binary.wrap_string(key_alt_name_bson) do |key_alt_name_p|
      check_ctx_status(context) do
        mongocrypt_ctx_setopt_key_alt_name(context.ctx_p, key_alt_name_p)
      end
    end
  end
end

.ctx_setopt_key_encryption_key(context, key_document) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set key encryption key document for creating a data key.

Parameters:

  • context (Mongo::Crypt::Context)
  • key_document (BSON::Document) —

    BSON document representing the key encryption key document with an additional “provider” field.

Raises:



492
493
494
495
496
497
498
499
500
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 492

def self.ctx_setopt_key_encryption_key(context, key_document)
  validate_document(key_document)
  data = key_document.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_ctx_status(context) do
      mongocrypt_ctx_setopt_key_encryption_key(context.ctx_p, data_p)
    end
  end
end

.ctx_setopt_key_id(context, key_id) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets the key id option on an explicit encryption context.

Parameters:

Raises:



393
394
395
396
397
398
399
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 393

def self.ctx_setopt_key_id(context, key_id)
  Binary.wrap_string(key_id) do |key_id_p|
    check_ctx_status(context) do
      mongocrypt_ctx_setopt_key_id(context.ctx_p, key_id_p)
    end
  end
end

.init(handle) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the Mongo::Crypt::Handle object

Parameters:

Raises:



333
334
335
336
337
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 333

def self.init(handle)
  check_status(handle) do
    mongocrypt_init(handle.ref)
  end
end

.kms_ctx_bytes_needed(kms_context) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the number of bytes needed by the KmsContext.

Parameters:

Returns:

  • (Integer) —

    The number of bytes needed



888
889
890
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 888

def self.kms_ctx_bytes_needed(kms_context)
  mongocrypt_kms_ctx_bytes_needed(kms_context.kms_ctx_p)
end

.kms_ctx_endpoint(kms_context) ⇒ String | nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the hostname with which to connect over TLS to get information about the AWS master key.

Parameters:

Returns:

  • (String | nil) —

    The hostname, or nil if none exists

Raises:



864
865
866
867
868
869
870
871
872
873
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 864

def self.kms_ctx_endpoint(kms_context)
  ptr = FFI::MemoryPointer.new(:pointer, 1)

  check_kms_ctx_status(kms_context) do
    mongocrypt_kms_ctx_endpoint(kms_context.kms_ctx_p, ptr)
  end

  str_ptr = ptr.read_pointer
  str_ptr.null? ? nil : str_ptr.read_string.force_encoding('UTF-8')
end

.kms_ctx_feed(kms_context, bytes) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Feed replies from the KMS back to libmongocrypt.

Parameters:

Raises:



908
909
910
911
912
913
914
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 908

def self.kms_ctx_feed(kms_context, bytes)
  check_kms_ctx_status(kms_context) do
    Binary.wrap_string(bytes) do |bytes_p|
      mongocrypt_kms_ctx_feed(kms_context.kms_ctx_p, bytes_p)
    end
  end
end

.kms_ctx_get_kms_provider(kms_context) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the KMS provider identifier associated with this KMS request.

This is used to conditionally configure TLS connections based on the KMS request. It is useful for KMIP, which authenticates with a client certificate.

Parameters:

  • kms (FFI::Pointer) —

    Pointer mongocrypt_kms_ctx_t object.



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 795

def self.kms_ctx_get_kms_provider(kms_context)
  len_ptr = FFI::MemoryPointer.new(:uint32, 1)
  provider = mongocrypt_kms_ctx_get_kms_provider(
    kms_context.kms_ctx_p,
    len_ptr
  )
  if len_ptr.nil?
    nil
  else
    len = if BSON::Environment.jruby?
      # JRuby FFI implementation does not have `read(type)` method, but it
      # has this `get_uint32`.
      len_ptr.get_uint32
    else
      # For MRI we use a documented `read` method - https://www.rubydoc.info/github/ffi/ffi/FFI%2FPointer:read
      len_ptr.read(:uint32)
    end
    provider.read_string(len).to_sym
  end
end

.kms_ctx_message(kms_context) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the HTTP message needed to fetch the AWS KMS master key from a KmsContext object.

Parameters:

Returns:

  • (String) —

    The HTTP message

Raises:



835
836
837
838
839
840
841
842
843
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 835

def self.kms_ctx_message(kms_context)
  binary = Binary.new

  check_kms_ctx_status(kms_context) do
    mongocrypt_kms_ctx_message(kms_context.kms_ctx_p, binary.ref)
  end

  return binary.to_s
end

.mongocrypt_binary_data(binary) ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the pointer to the underlying data for the mongocrypt_binary_t.

Parameters:

  • binary (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object.

Returns:

  • (FFI::Pointer) —

    A pointer to the data array.



105
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 105

attach_function :mongocrypt_binary_data, [:pointer], :pointer

.mongocrypt_binary_destroy(binary) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Destroy the mongocrypt_binary_t object.

Parameters:

  • binary (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object.

Returns:

  • (nil) —

    Always nil.



121
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 121

attach_function :mongocrypt_binary_destroy, [:pointer], :void

.mongocrypt_binary_len(binary) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the length of the underlying data array.

Parameters:

  • binary (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object.

Returns:

  • (Integer) —

    The length of the data array.



113
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 113

attach_function :mongocrypt_binary_len, [:pointer], :int

.mongocrypt_binary_new ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new mongocrypt_binary_t object (a non-owning view of a byte

array).

Returns:

  • (FFI::Pointer) —

    A pointer to the newly-created mongocrypt_binary_t object.



81
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 81

attach_function :mongocrypt_binary_new, [], :pointer

.mongocrypt_binary_new_from_data(data, len) ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a new mongocrypt_binary_t object that maintains a pointer to

the specified byte array.

Parameters:

  • data (FFI::Pointer) —

    A pointer to an array of bytes; the data is not copied and must outlive the mongocrypt_binary_t object.

  • len (Integer) —

    The length of the array argument.

Returns:

  • (FFI::Pointer) —

    A pointer to the newly-created mongocrypt_binary_t object.



93
94
95
96
97
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 93

attach_function(
  :mongocrypt_binary_new_from_data,
  [:pointer, :int],
  :pointer
)

.mongocrypt_ctx_datakey_init(ctx) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Before calling this method, master key options must be set. Set AWS master key by calling mongocrypt_ctx_setopt_masterkey_aws and mongocrypt_ctx_setopt_masterkey_aws_endpoint. Set local master key by calling mongocrypt_ctx_setopt_masterkey_local.

Initializes the ctx to create a data key.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (Boolean) —

    Whether the initialization was successful.



512
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 512

attach_function :mongocrypt_ctx_datakey_init, [:pointer], :bool

.mongocrypt_ctx_decrypt_init(ctx, doc) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the ctx for auto-decryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • doc (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the document to be decrypted as a BSON binary string.

Returns:

  • (Boolean) —

    Whether the initialization was successful.



604
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 604

attach_function :mongocrypt_ctx_decrypt_init, [:pointer, :pointer], :bool

.mongocrypt_ctx_destroy(ctx) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Destroy the reference to the mongocrypt_ctx_t object.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (nil) —

    Always nil.



997
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 997

attach_function :mongocrypt_ctx_destroy, [:pointer], :void

.mongocrypt_ctx_encrypt_init(ctx, db, db_len, cmd) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This method expects the passed-in BSON to be in the format: { “v”: BSON value to decrypt }.

Initializes the ctx for auto-encryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • db (String) —

    The database name.

  • db_len (Integer) —

    The length of the database name argument (or -1 for a null-terminated string).

  • cmd (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the database command as a binary string.

Returns:

  • (Boolean) —

    Whether the initialization was successful.



538
539
540
541
542
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 538

attach_function(
  :mongocrypt_ctx_encrypt_init,
  [:pointer, :string, :int, :pointer],
  :bool
)

.mongocrypt_ctx_explicit_decrypt_init(ctx, msg) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the ctx for explicit decryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • msg (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the message to be decrypted as a BSON binary string.

Returns:

  • (Boolean) —

    Whether the initialization was successful.



630
631
632
633
634
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 630

attach_function(
  :mongocrypt_ctx_explicit_decrypt_init,
  [:pointer, :pointer],
  :bool
)

.mongocrypt_ctx_explicit_encrypt_init(ctx, msg) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Before calling this method, set a key_id, key_alt_name (optional), and encryption algorithm using the following methods: mongocrypt_ctx_setopt_key_id, mongocrypt_ctx_setopt_key_alt_name, and mongocrypt_ctx_setopt_algorithm.

Initializes the ctx for explicit encryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • msg (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the message to be encrypted as a binary string.

Returns:

  • (Boolean) —

    Whether the initialization was successful.



574
575
576
577
578
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 574

attach_function(
  :mongocrypt_ctx_explicit_encrypt_init,
  [:pointer, :pointer],
  :bool
)

.mongocrypt_ctx_finalize(ctx, op_bson) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Perform the final encryption or decryption and return a BSON document.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • op_bson (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object that will have a reference to the final encrypted BSON document.

Returns:

  • (Boolean) —

    A boolean indicating the success of the operation.



970
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 970

attach_function :mongocrypt_ctx_finalize, [:pointer, :pointer], :void

.mongocrypt_ctx_mongo_done(ctx) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicate to libmongocrypt that the driver is done feeding replies.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (Boolean) —

    A boolean indicating the success of the operation.



738
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 738

attach_function :mongocrypt_ctx_mongo_done, [:pointer], :bool

.mongocrypt_ctx_mongo_feed(ctx, reply) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Feed a BSON reply to libmongocrypt.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • reply (FFI::Pointer) —

    A mongocrypt_binary_t object that references the BSON reply to feed to libmongocrypt.

Returns:

  • (Boolean) —

    A boolean indicating the success of the operation.



714
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 714

attach_function :mongocrypt_ctx_mongo_feed, [:pointer, :pointer], :bool

.mongocrypt_ctx_mongo_next_kms_ctx(ctx) ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return a pointer to a mongocrypt_kms_ctx_t object or NULL.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (FFI::Pointer) —

    A pointer to a mongocrypt_kms_ctx_t object.



746
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 746

attach_function :mongocrypt_ctx_next_kms_ctx, [:pointer], :pointer

.mongocrypt_ctx_mongo_op(ctx, op_bson) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get a BSON operation for the driver to run against the MongoDB

collection, the key vault database, or mongocryptd.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • op_bson (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object that will have a reference to the BSON operation written to it by libmongocrypt.

Returns:

  • (Boolean) —

    A boolean indicating the success of the operation.



682
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 682

attach_function :mongocrypt_ctx_mongo_op, [:pointer, :pointer], :bool

.mongocrypt_ctx_new(crypt) ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a new mongocrypt_ctx_t object (a wrapper for the libmongocrypt

state machine).

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

Returns:

  • (FFI::Pointer) —

    A new mongocrypt_ctx_t object.



364
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 364

attach_function :mongocrypt_ctx_new, [:pointer], :pointer

.mongocrypt_ctx_setopt_algorithm(ctx, algorithm, len) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Do not initialize ctx before calling this method.

Set the algorithm used for explicit encryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • algorithm (String) —

    The algorithm name. Valid values are:

    • “AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic”

    • “AEAD_AES_256_CBC_HMAC_SHA_512-Random”

  • len (Integer) —

    The length of the algorithm string.

Returns:

  • (Boolean) —

    Whether the option was successfully set.



449
450
451
452
453
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 449

attach_function(
  :mongocrypt_ctx_setopt_algorithm,
  [:pointer, :string, :int],
  :bool
)

.mongocrypt_ctx_setopt_key_alt_name(ctx, binary) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Do not initialize ctx before calling this method.

When creating a data key, set an alternate name on that key. When

performing explicit encryption, specifying which data key to use for
encryption based on its keyAltName field.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • binary (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references a BSON document in the format { “keyAltName”: <BSON UTF8 value> }.

Returns:

  • (Boolean) —

    Whether the alternative name was successfully set.



413
414
415
416
417
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 413

attach_function(
  :mongocrypt_ctx_setopt_key_alt_name,
  [:pointer, :pointer],
  :bool
)

.mongocrypt_ctx_setopt_key_encryption_key(ctx) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Do not initialize ctx before calling this method.

Set key encryption key document for creating a data key.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • bin (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references a BSON document representing the key encryption key document with an additional “provider” field.

Returns:

  • (Boolean) —

    Whether the option was successfully set.



479
480
481
482
483
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 479

attach_function(
  :mongocrypt_ctx_setopt_key_encryption_key,
  [:pointer, :pointer],
  :bool
)

.mongocrypt_ctx_setopt_key_id(ctx, key_id) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Do not initialize ctx before calling this method.

Set the key id used for explicit encryption.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • key_id (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the 16-byte key-id.

Returns:

  • (Boolean) —

    Whether the option was successfully set.



385
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 385

attach_function :mongocrypt_ctx_setopt_key_id, [:pointer, :pointer], :bool

.mongocrypt_ctx_state(ctx) ⇒ Symbol

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the current state of the ctx.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (Symbol) —

    The current state, will be one of the values defined by the mongocrypt_ctx_state enum.



670
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 670

attach_function :mongocrypt_ctx_state, [:pointer], :mongocrypt_ctx_state

.mongocrypt_ctx_status(ctx, status) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set the status information from the mongocrypt_ctx_t object on the

mongocrypt_status_t object.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object.

Returns:

  • (Boolean) —

    Whether the status was successfully set.



374
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 374

attach_function :mongocrypt_ctx_status, [:pointer, :pointer], :bool

.mongocrypt_destroy(crypt) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Destroy the reference the mongocrypt_t object.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

Returns:

  • (nil) —

    Always nil.



355
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 355

attach_function :mongocrypt_destroy, [:pointer], :void

.mongocrypt_init(crypt) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize the mongocrypt_t object.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

Returns:

  • (Boolean) —

    Returns whether the crypt was initialized successfully.



326
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 326

attach_function :mongocrypt_init, [:pointer], :bool

.mongocrypt_kms_ctx_bytes_needed(kms) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the number of bytes needed by the KMS context.

Parameters:

  • kms (FFI::Pointer) —

    The mongocrypt_kms_ctx_t object.

Returns:

  • (Integer) —

    The number of bytes needed.



881
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 881

attach_function :mongocrypt_kms_ctx_bytes_needed, [:pointer], :int

.mongocrypt_kms_ctx_done(ctx) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicate to libmongocrypt that it will receive no more replies from

mongocrypt_kms_ctx_t objects.

Parameters:

  • ctx (FFI::Pointer) —

    A pointer to a mongocrypt_ctx_t object.

Returns:

  • (Boolean) —

    Whether the operation was successful.



948
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 948

attach_function :mongocrypt_ctx_kms_done, [:pointer], :bool

.mongocrypt_kms_ctx_endpoint(kms, endpoint) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the hostname with which to connect over TLS to get information about

the AWS master key.

Parameters:

  • kms (FFI::Pointer) —

    A pointer to a mongocrypt_kms_ctx_t object.

  • endpoint (FFI::Pointer) —

    (out param) A pointer to which the endpoint string will be written by libmongocrypt.

Returns:

  • (Boolean) —

    Whether the operation was successful.



854
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 854

attach_function :mongocrypt_kms_ctx_endpoint, [:pointer, :pointer], :bool

.mongocrypt_kms_ctx_feed(kms, bytes) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Feed replies from the KMS back to libmongocrypt.

Parameters:

  • kms (FFI::Pointer) —

    A pointer to the mongocrypt_kms_ctx_t object.

  • bytes (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the response from the KMS.

Returns:

  • (Boolean) —

    Whether the operation was successful.



900
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 900

attach_function :mongocrypt_kms_ctx_feed, [:pointer, :pointer], :bool

.mongocrypt_kms_ctx_get_kms_provider(crypt, kms_providers) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



780
781
782
783
784
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 780

attach_function(
  :mongocrypt_kms_ctx_get_kms_provider,
  [:pointer, :pointer],
  :pointer
)

.mongocrypt_kms_ctx_message(kms, msg) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the message needed to fetch the AWS KMS master key.

Parameters:

  • kms (FFI::Pointer) —

    Pointer to the mongocrypt_kms_ctx_t object

  • msg (FFI::Pointer) —

    (outparam) Pointer to a mongocrypt_binary_t object that will have the location of the message written to it by libmongocrypt.

Returns:

  • (Boolean) —

    Whether the operation is successful.



825
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 825

attach_function :mongocrypt_kms_ctx_message, [:pointer, :pointer], :bool

.mongocrypt_kms_ctx_status(kms, status) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Write status information about the mongocrypt_kms_ctx_t object

to the mongocrypt_status_t object.

Parameters:

  • kms (FFI::Pointer) —

    A pointer to the mongocrypt_kms_ctx_t object.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object.

Returns:

  • (Boolean) —

    Whether the operation was successful.



924
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 924

attach_function :mongocrypt_kms_ctx_status, [:pointer, :pointer], :bool

.mongocrypt_setopt_crypto_hook_sign_rsaes_pkcs1_v1_5(crypt, sign_rsaes_pkcs1_v1_5, ctx = nil) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set a crypto hook for the RSASSA-PKCS1-v1_5 algorithm with a SHA-256 hash.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • sign_rsaes_pkcs1_v1_5 (Proc) —

    A RSASSA-PKCS1-v1_5 signing method.

  • ctx (FFI::Pointer | nil) (defaults to: nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

Returns:

  • (Boolean) —

    Whether setting this option succeeded.



1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1149

attach_function(
  :mongocrypt_setopt_crypto_hook_sign_rsaes_pkcs1_v1_5,
  [
    :pointer,
    :mongocrypt_hmac_fn,
    :pointer
  ],
  :bool
)

.mongocrypt_setopt_crypto_hooks(crypt, aes_enc_fn, aes_dec_fn, random_fn, sha_512_fn, sha_256_fn, hash_fn, ctx = nil) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set crypto hooks on the provided mongocrypt object.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • aes_enc_fn (Proc) —

    An AES encryption method.

  • aes_dec_fn (Proc) —

    An AES decryption method.

  • random_fn (Proc) —

    A random method.

  • sha_512_fn (Proc) —

    A HMAC SHA-512 method.

  • sha_256_fn (Proc) —

    A HMAC SHA-256 method.

  • hash_fn (Proc) —

    A SHA-256 hash method.

  • ctx (FFI::Pointer | nil) (defaults to: nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

Returns:

  • (Boolean) —

    Whether setting this option succeeded.



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1102

attach_function(
  :mongocrypt_setopt_crypto_hooks,
  [
    :pointer,
    :mongocrypt_crypto_fn,
    :mongocrypt_crypto_fn,
    :mongocrypt_random_fn,
    :mongocrypt_hmac_fn,
    :mongocrypt_hmac_fn,
    :mongocrypt_hash_fn,
    :pointer
  ],
  :bool
)

.mongocrypt_setopt_kms_providers(crypt, kms_providers) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Do not initialize ctx before calling this method.

Configure KMS providers with a BSON document.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • kms_providers (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references a BSON document mapping the KMS provider names to credentials.



270
271
272
273
274
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 270

attach_function(
  :mongocrypt_setopt_kms_providers,
  [:pointer, :pointer],
  :bool
)

.mongocrypt_setopt_log_handler(crypt, log_fn, log_ctx = nil) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set the handler on the mongocrypt_t object to be called every time

libmongocrypt logs a message.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • log_fn (Method) —

    A logging callback method.

  • log_ctx (FFI::Pointer | nil) (defaults to: nil) —

    An optional pointer to a context to be passed into the log callback on every invocation.

Returns:

  • (Boolean) —

    Whether setting the callback was successful.



241
242
243
244
245
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 241

attach_function(
  :mongocrypt_setopt_log_handler,
  [:pointer, :mongocrypt_log_fn_t, :pointer],
  :bool
)

.mongocrypt_setopt_schema_map(crypt, schema_map) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets a local schema map for encryption.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • schema_map (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t. object that references the schema map as a BSON binary string.

Returns:

  • (Boolean) —

    Returns whether the option was set successfully.



301
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 301

attach_function :mongocrypt_setopt_schema_map, [:pointer, :pointer], :bool

.mongocrypt_status(crypt, status) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set the status information from the mongocrypt_t object on the

mongocrypt_status_t object.

Parameters:

  • crypt (FFI::Pointer) —

    A pointer to a mongocrypt_t object.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object.

Returns:

  • (Boolean) —

    Whether the status was successfully set.



347
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 347

attach_function :mongocrypt_status, [:pointer, :pointer], :bool

.mongocrypt_status_code(status) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return the status error code.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

Returns:

  • (Integer) —

    The status code.



169
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 169

attach_function :mongocrypt_status_code, [:pointer], :int

.mongocrypt_status_destroy(status) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Destroys the reference to the mongocrypt_status_t object.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

Returns:

  • (nil) —

    Always nil.



195
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 195

attach_function :mongocrypt_status_destroy, [:pointer], :void

.mongocrypt_status_message(status, len = nil) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the status message.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

  • len (FFI::Pointer | nil) (defaults to: nil) —

    (out param) An optional pointer to a uint32, where the length of the retun string will be written.

Returns:

  • (String) —

    The status message.



179
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 179

attach_function :mongocrypt_status_message, [:pointer, :pointer], :string

.mongocrypt_status_new ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a new mongocrypt_status_t object.

Returns:

  • (FFI::Pointer) —

    A pointer to the new mongocrypt_status_ts.



135
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 135

attach_function :mongocrypt_status_new, [], :pointer

.mongocrypt_status_ok(status) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns whether the status is ok or an error.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

Returns:

  • (Boolean) —

    Whether the status is ok.



187
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 187

attach_function :mongocrypt_status_ok, [:pointer], :bool

.mongocrypt_status_set(status, type, code, message, len) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set a message, type, and code on an existing status.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

  • type (Symbol) —

    The status type; possible values are defined by the status_type enum.

  • code (Integer) —

    The status code.

  • message (String) —

    The status message.

  • len (Integer) —

    The length of the message argument (or -1 for a null-terminated string).

Returns:

  • (nil) —

    Always nil.



149
150
151
152
153
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 149

attach_function(
  :mongocrypt_status_set,
  [:pointer, :status_type, :int, :string, :int],
  :void
)

.mongocrypt_status_type(status) ⇒ Symbol

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Indicates the status type.

Parameters:

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t.

Returns:

  • (Symbol) —

    The status type (as defined by the status_type enum).



161
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 161

attach_function :mongocrypt_status_type, [:pointer], :status_type

.mongocrypt_version(len) ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the version string of the libmongocrypt library.

Parameters:

  • len (FFI::Pointer | nil) —

    (out param) An optional pointer to a uint8 that will reference the length of the returned string.

Returns:

  • (String) —

    A version string for libmongocrypt.



72
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 72

attach_function :mongocrypt_version, [:pointer], :string

.ongocrypt_new ⇒ FFI::Pointer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new mongocrypt_t object.

Returns:

  • (FFI::Pointer) —

    A pointer to a new mongocrypt_t object.



229
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 229

attach_function :mongocrypt_new, [], :pointer

.setopt_crypto_hook_sign_rsaes_pkcs1_v1_5(handle, rsaes_pkcs_signature_cb) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set a crypto hook for the RSASSA-PKCS1-v1_5 algorithm with

a SHA-256 hash oh the Handle.

Parameters:

  • handle (Mongo::Crypt::Handle)
  • rsaes_pkcs_signature_cb (Method) —

    A RSASSA-PKCS1-v1_5 signing method.

Raises:



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1166

def self.setopt_crypto_hook_sign_rsaes_pkcs1_v1_5(
  handle,
  rsaes_pkcs_signature_cb
)
  check_status(handle) do
    mongocrypt_setopt_crypto_hook_sign_rsaes_pkcs1_v1_5(
      handle.ref,
      rsaes_pkcs_signature_cb,
      nil
    )
  end
end

.setopt_crypto_hooks(handle, aes_encrypt_cb, aes_decrypt_cb, random_cb, hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set crypto callbacks on the Handle

Parameters:

  • handle (Mongo::Crypt::Handle)
  • aes_encrypt_cb (Method) —

    An AES encryption method

  • aes_decrypt_cb (Method) —

    A AES decryption method

  • random_cb (Method) —

    A method that returns a string of random bytes

  • hmac_sha_512_cb (Method) —

    A HMAC SHA-512 method

  • hmac_sha_256_cb (Method) —

    A HMAC SHA-256 method

  • hmac_hash_cb (Method) —

    A SHA-256 hash method

Raises:



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1128

def self.setopt_crypto_hooks(handle,
  aes_encrypt_cb, aes_decrypt_cb, random_cb,
  hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb
)
  check_status(handle) do
    mongocrypt_setopt_crypto_hooks(handle.ref,
      aes_encrypt_cb, aes_decrypt_cb, random_cb,
      hmac_sha_512_cb, hmac_sha_256_cb, hmac_hash_cb, nil
    )
  end
end

.setopt_kms_providers(handle, kms_providers) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set KMS providers options on the Mongo::Crypt::Handle object

Parameters:

  • handle (Mongo::Crypt::Handle)
  • kms_providers (BSON::Document) —

    BSON document mapping the KMS provider names to credentials.

Raises:



283
284
285
286
287
288
289
290
291
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 283

def self.setopt_kms_providers(handle, kms_providers)
  validate_document(kms_providers)
  data = kms_providers.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_status(handle) do
      mongocrypt_setopt_kms_providers(handle.ref, data_p)
    end
  end
end

.setopt_log_handler(handle, log_callback) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set the logger callback function on the Mongo::Crypt::Handle object

Parameters:

Raises:



253
254
255
256
257
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 253

def self.setopt_log_handler(handle, log_callback)
  check_status(handle) do
    mongocrypt_setopt_log_handler(handle, log_callback, nil)
  end
end

.setopt_schema_map(handle, schema_map_doc) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Set schema map on the Mongo::Crypt::Handle object

Parameters:

  • handle (Mongo::Crypt::Handle)
  • schema_map_doc (BSON::Document) —

    The schema map as a BSON::Document object

Raises:



310
311
312
313
314
315
316
317
318
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 310

def self.setopt_schema_map(handle, schema_map_doc)
  validate_document(schema_map_doc)
  data = schema_map_doc.to_bson.to_s
  Binary.wrap_string(data) do |data_p|
    check_status(handle) do
      mongocrypt_setopt_schema_map(handle.ref, data_p)
    end
  end
end

.validate_document(data) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

All BSON::Document instances are also Hash instances

Checks that the specified data is a Hash before serializing it to BSON to prevent errors from libmongocrypt

Parameters:

  • data (Object) —

    The data to be passed to libmongocrypt

Raises:



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1219

def self.validate_document(data)
  return if data.is_a?(Hash)

  if data.nil?
    message = "Attempted to pass nil data to libmongocrypt. " +
      "Data must be a Hash"
  else
    message = "Attempted to pass invalid data to libmongocrypt: #{data} " +
      "Data must be a Hash"
  end

  raise Error::CryptError.new(message)
end

Instance Method Details

#mongocrypt_crypto_fn(ctx, key, iv, input, output, status) ⇒ Bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This defines a method signature for an FFI callback; it is not an instance method on the Binding class.

A callback to a function that performs AES encryption or decryption.

Parameters:

  • ctx (FFI::Pointer | nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

  • key (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the 32-byte AES encryption key.

  • iv (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the 16-byte AES IV.

  • input (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the value to be encrypted/decrypted.

  • output (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object will have a reference to the encrypted/ decrypted value written to it by libmongocrypt.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object to which an error message will be written if encryption fails.

Returns:

  • (Bool) —

    Whether encryption/decryption was successful.



1020
1021
1022
1023
1024
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1020

callback(
  :mongocrypt_crypto_fn,
  [:pointer, :pointer, :pointer, :pointer, :pointer, :pointer, :pointer],
  :bool
)

#mongocrypt_hash_fn(ctx, input, output, status) ⇒ Bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This defines a method signature for an FFI callback; it is not an instance method on the Binding class.

A callback to a SHA-256 hash function.

Parameters:

  • ctx (FFI::Pointer | nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

  • input (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the value to be hashed.

  • output (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object will have a reference to the output value written to it by libmongocrypt.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object to which an error message will be written if encryption fails.

Returns:

  • (Bool) —

    Whether hashing was successful.



1068
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1068

callback :mongocrypt_hash_fn, [:pointer, :pointer, :pointer, :pointer], :bool

#mongocrypt_hmac_fn(ctx, key, input, output, status) ⇒ Bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This defines a method signature for an FFI callback; it is not an instance method on the Binding class.

A callback to a function that performs HMAC SHA-512 or SHA-256.

Parameters:

  • ctx (FFI::Pointer | nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

  • key (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the 32-byte HMAC SHA encryption key.

  • input (FFI::Pointer) —

    A pointer to a mongocrypt_binary_t object that references the input value.

  • output (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object will have a reference to the output value written to it by libmongocrypt.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object to which an error message will be written if encryption fails.

Returns:

  • (Bool) —

    Whether HMAC-SHA was successful.



1045
1046
1047
1048
1049
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1045

callback(
  :mongocrypt_hmac_fn,
  [:pointer, :pointer, :pointer, :pointer, :pointer],
  :bool
)

#mongocrypt_log_fn_t(level, message, len, ctx) ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This defines a method signature for an FFI callback; it is not an instance method on the Binding class.

A callback to the mongocrypt log function. Set a custom log callback

with the mongocrypt_setopt_log_handler method

Parameters:

  • level (Symbol) —

    The log level; possible values defined by the log_level enum

  • message (String) —

    The log message

  • len (Integer) —

    The length of the message param, or -1 if the string is null terminated

  • ctx (FFI::Pointer | nil) —

    An optional pointer to a context object when this callback was set

Returns:

  • (nil) —

    Always nil.



222
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 222

callback :mongocrypt_log_fn_t, [:log_level, :string, :int, :pointer], :void

#mongocrypt_random_fn(ctx, output, count, status) ⇒ Bool

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

This defines a method signature for an FFI callback; it is not an instance method on the Binding class.

A callback to a crypto secure random function.

Parameters:

  • ctx (FFI::Pointer | nil) —

    An optional pointer to a context object that may have been set when hooks were enabled.

  • output (FFI::Pointer) —

    (out param) A pointer to a mongocrypt_binary_t object will have a reference to the output value written to it by libmongocrypt.

  • count (Integer) —

    The number of random bytes to return.

  • status (FFI::Pointer) —

    A pointer to a mongocrypt_status_t object to which an error message will be written if encryption fails.

Returns:

  • (Bool) —

    Whether hashing was successful.



1086
 
# File 'build/ruby-driver-master/lib/mongo/crypt/binding.rb', line 1086

callback :mongocrypt_random_fn, [:pointer, :pointer, :int, :pointer], :bool