Click or drag to resize

ClientEncryption Class

Explicit client encryption.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.EncryptionClientEncryption

Namespace:  MongoDB.Driver.Encryption
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public sealed class ClientEncryption : IDisposable

The ClientEncryption type exposes the following members.

Constructors
  NameDescription
Public methodClientEncryption
Initializes a new instance of the ClientEncryption class.
Top
Methods
  NameDescription
Public methodAddAlternateKeyName
Adds an alternate key name to the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
Public methodAddAlternateKeyNameAsync
Adds an alternate key name to the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
Public methodCreateDataKey
An alias function equivalent to createKey.
Public methodCreateDataKeyAsync
An alias function equivalent to createKey.
Public methodCreateEncryptedCollection(IMongoDatabase, String, CreateCollectionOptions, String, BsonDocument, CancellationToken)
Create encrypted collection.
Public methodCreateEncryptedCollection(IMongoDatabase, String, CreateCollectionOptions, String, DataKeyOptions, CancellationToken) Obsolete.
Create encrypted collection.
Public methodCreateEncryptedCollectionAsync(IMongoDatabase, String, CreateCollectionOptions, String, BsonDocument, CancellationToken)
Create encrypted collection.
Public methodCreateEncryptedCollectionAsync(IMongoDatabase, String, CreateCollectionOptions, String, DataKeyOptions, CancellationToken) Obsolete.
Create encrypted collection.
Public methodDecrypt
Decrypts the specified value.
Public methodDecryptAsync
Decrypts the specified value.
Public methodDeleteKey
Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault collection.
Public methodDeleteKeyAsync
Removes the key document with the given UUID (BSON binary subtype 0x04) from the key vault collection.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEncrypt
Encrypts the specified value.
Public methodEncryptAsync
Encrypts the specified value.
Public methodEncryptExpression
Encrypts a Match Expression or Aggregate Expression to query a range index.
Public methodEncryptExpressionAsync
Encrypts a Match Expression or Aggregate Expression to query a range index.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetKey
Finds a single key document with the given UUID (BSON binary subtype 0x04).
Public methodGetKeyAsync
Finds a single key document with the given UUID (BSON binary subtype 0x04).
Public methodGetKeyByAlternateKeyName
Finds a single key document with the given alter name.
Public methodGetKeyByAlternateKeyNameAsync
Finds a single key document with the given UUID (BSON binary subtype 0x04).
Public methodGetKeys
Finds all documents in the key vault collection.
Public methodGetKeysAsync
Finds all documents in the key vault collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemoveAlternateKeyName
Removes an alternateKeyName from the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
Public methodRemoveAlternateKeyNameAsync
Removes an alternateKeyName from the keyAltNames array of the key document in the key vault collection with the given UUID (BSON binary subtype 0x04).
Public methodRewrapManyDataKey
Decrypts multiple data keys and (re-)encrypts them with a new masterKey, or with their current masterKey if a new one is not given.
Public methodRewrapManyDataKeyAsync
Decrypts multiple data keys and (re-)encrypts them with a new masterKey, or with their current masterKey if a new one is not given.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also