#include <mongocxx/v_noabi/mongocxx/options/client_encryption.hpp>
|
using | ns_pair = std::pair<std::string, std::string> |
| Represents the name of a database and a collection.
|
|
◆ ns_pair
Represents the name of a database and a collection.
◆ key_vault_client() [1/2]
Gets the key vault client.
- Returns
- An optional pointer to the key vault client.
◆ key_vault_client() [2/2]
When the key vault collection is on a separate MongoDB cluster, sets the optional client to use to route data key queries to that cluster.
- Parameters
-
client | A client to use for routing queries to the key vault collection. |
- Returns
- A reference to this object to facilitate method chaining.
- See also
-
◆ key_vault_namespace() [1/2]
Gets the key vault namespace.
- Returns
- An optional pair of strings representing the namespace of the key vault collection.
◆ key_vault_namespace() [2/2]
Sets the namespace to use to access the key vault collection, which contains all data keys used for encryption and decryption. This option must be set:
client_encryption.key_vault_namespace({ "db", "coll" });
- Parameters
-
ns | A std::pair of strings representing the db and collection to use to access the key vault. |
- Returns
- A reference to this object to facilitate method chaining.
- See also
-
◆ kms_providers() [1/2]
Gets the KMS providers.
- Returns
- An optional document containing the KMS providers.
◆ kms_providers() [2/2]
Sets the KMS providers to use for client side encryption.
Multiple KMS providers may be specified. Supported KMS providers are "aws", "azure", "gcp", "kmip", and "local". The kmsProviders map values differ by provider:
aws: {
accessKeyId: String,
secretAccessKey: String
}
azure: {
tenantId: String,
clientId: String,
clientSecret: String,
identityPlatformEndpoint: Optional<String>
}
gcp: {
email: String,
privateKey: byte[] or String,
endpoint: Optional<String>
}
kmip: {
endpoint: String
}
local: {
key: byte[96]
}
- Parameters
-
kms_providers | A document containing the KMS providers. |
- Returns
- A reference to this object to facilitate method chaining.
- See also
-
◆ tls_opts() [1/2]
Gets the TLS options.
- Returns
- An optional document containing the TLS options.
◆ tls_opts() [2/2]
Sets the TLS options to use for client side encryption with a given KMS provider.
Multiple KMS providers may be specified. Supported KMS providers are "aws", "azure", "gcp", and "kmip". The map value has the same form for all supported providers:
<KMS provider name>: {
tlsCaFile: Optional<String>
tlsCertificateKeyFile: Optional<String>
tlsCertificateKeyFilePassword: Optional<String>
}
- Parameters
-
tls_opts | A document containing the TLS options. |
- Returns
- A reference to this object to facilitate method chaining.
- See also
-
The documentation for this class was generated from the following file: