1MONGOC_CLIENT_ENCRYPTION_OPTSM_OSNEGTO_CK_MlCSiL_bIPmERoNOnTVg_IoEDcNECRRSY(P3T)ION_OPTS_SET_KMS_PROVIDERS(3)
2
3
4

NAME

6       mongoc_client_encryption_opts_set_kms_providers - mongoc_client_encryp‐
7       tion_opts_set_kms_providers()
8

SYNOPSIS

10          void
11          mongoc_client_encryption_opts_set_kms_providers (
12             mongoc_client_encryption_opts_t *opts, const bson_t *kms_providers);
13

PARAMETERS

15       • opts: The mongoc_client_encryption_opts_t
16
17       • kms_providers: A bson_t containing configuration for an external  Key
18         Management Service (KMS).
19
20       kms_providers  is a BSON document containing configuration for each KMS
21       provider. Currently aws, local, azure, gcp, and kmip are supported.  At
22       least one must be specified.
23
24       The format for "aws" is as follows:
25
26          aws: {
27             accessKeyId: String,
28             secretAccessKey: String
29          }
30
31       The format for "local" is as follows:
32
33          local: {
34             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. */
35          }
36
37       The format for "azure" is as follows:
38
39          azure: {
40             tenantId: String,
41             clientId: String,
42             clientSecret: String,
43             identityPlatformEndpoint: Optional<String> /* Defaults to login.microsoftonline.com */
44          }
45
46       The format for "gcp" is as follows:
47
48          gcp: {
49             email: String,
50             privateKey: byte[] or String, /* May be passed as a base64 encoded string. */
51             endpoint: Optional<String> /* Defaults to oauth2.googleapis.com */
52          }
53
54       The format for "kmip" is as follows:
55
56          kmip: {
57             endpoint: String
58          }
59
60       SEE ALSO:
61          mongoc_client_encryption_new()
62
63          The guide for Using Client-Side Field Level Encryption
64
65

AUTHOR

67       MongoDB, Inc
68

70       2017-present, MongoDB, Inc
71
72
73
74
751.23.1                      MONGOOCc_tCL2I0E,NT2_0E2N2CRYPTION_OPTS_SET_KMS_PROVIDERS(3)
Impressum