Skip to content

Commit 7f9b910

Browse files
committed
add docs
1 parent 741c6a7 commit 7f9b910

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

pymongo/encryption.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,17 @@ def __init__(self, kms_providers, key_vault_namespace, key_vault_client,
358358
- `aws`: Map with "accessKeyId" and "secretAccessKey" as strings.
359359
These are the AWS access key ID and AWS secret access key used
360360
to generate KMS messages.
361+
- `azure`: Map with "tenantId", "clientId", and "clientSecret" as
362+
strings. Additionally, "identityPlatformEndpoint" may also be
363+
specified as a string (defaults to 'login.microsoftonline.com').
364+
These are the Azure Active Directory credentials used to
365+
generate Azure Key Vault messages.
366+
- `gcp`: Map with "email" as a string and "privateKey" as a
367+
base64 encoded string or `bytes`. Python 2 users must specify
368+
"privateKey" as a base64 encoded string. Additionally,
369+
"endpoint" may also be specified as a string (defaults to
370+
'oauth2.googleapis.com'). These are the credentials used to
371+
generate Google Cloud KMS messages.
361372
- `local`: Map with "key" as a 96-byte array or string. "key"
362373
is the master key used to encrypt/decrypt data keys. This key
363374
should be generated and stored as securely as possible.

pymongo/encryption_options.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ def __init__(self, kms_providers, key_vault_namespace,
5959
- `aws`: Map with "accessKeyId" and "secretAccessKey" as strings.
6060
These are the AWS access key ID and AWS secret access key used
6161
to generate KMS messages.
62+
- `azure`: Map with "tenantId", "clientId", and "clientSecret" as
63+
strings. Additionally, "identityPlatformEndpoint" may also be
64+
specified as a string (defaults to 'login.microsoftonline.com').
65+
These are the Azure Active Directory credentials used to
66+
generate Azure Key Vault messages.
67+
- `gcp`: Map with "email" as a string and "privateKey" as a
68+
base64 encoded string or `bytes`. Python 2 users must specify
69+
"privateKey" as a base64 encoded string. Additionally,
70+
"endpoint" may also be specified as a string (defaults to
71+
'oauth2.googleapis.com'). These are the credentials used to
72+
generate Google Cloud KMS messages.
6273
- `local`: Map with "key" as a 96-byte array or string. "key"
6374
is the master key used to encrypt/decrypt data keys. This key
6475
should be generated and stored as securely as possible.

0 commit comments

Comments
 (0)