1MONGOC_AUTO_ENCRYPTION_OPTS_SETM_OKNMGSO_lCPi_RbAOmUVoTInODg_EoERcNSC(R3Y)PTION_OPTS_SET_KMS_PROVIDERS(3)
2
3
4

SYNOPSIS

6          void
7          mongoc_auto_encryption_opts_set_kms_providers (
8             mongoc_auto_encryption_opts_t *opts, const bson_t *kms_providers);
9

PARAMETERS

11       • opts: The mongoc_auto_encryption_opts_t
12
13       • kms_providers:  A bson_t containing configuration for an external Key
14         Management Service (KMS).
15
16       kms_providers is a BSON document containing configuration for each  KMS
17       provider.  Currently aws, local, azure, gcp, and kmip are supported. At
18       least one must be specified.
19
20       The format for "aws" is as follows:
21
22          aws: {
23             accessKeyId: String,
24             secretAccessKey: String
25          }
26
27       The format for "local" is as follows:
28
29          local: {
30             key: <96 byte BSON binary of subtype 0> or String /* The master key used to encrypt/decrypt data keys. May be passed as a base64 encoded string. */
31          }
32
33       The format for "azure" is as follows:
34
35          azure: {
36             tenantId: String,
37             clientId: String,
38             clientSecret: String,
39             identityPlatformEndpoint: Optional<String> /* Defaults to login.microsoftonline.com */
40          }
41
42       The format for "gcp" is as follows:
43
44          gcp: {
45             email: String,
46             privateKey: byte[] or String, /* May be passed as a base64 encoded string. */
47             endpoint: Optional<String> /* Defaults to oauth2.googleapis.com */
48          }
49
50       The format for "kmip" is as follows:
51
52          kmip: {
53             endpoint: String
54          }
55
56       SEE ALSO:
57          mongoc_client_enable_auto_encryption()
58
59          In-Use Encryption
60
61

AUTHOR

63       MongoDB, Inc
64

66       2017-present, MongoDB, Inc
67
68
69
70
711.25.1                        MONNGoOvC_0A8U,TO2_0E2N3CRYPTION_OPTS_SET_KMS_PROVIDERS(3)
Impressum