On this page本页内容
New in version 4.2.版本4.2中的新功能。
ClientEncryption.
decrypt
(encryptedValue)¶ClientEncryption.decrypt
decrypts the encryptionValue
if
the current database connection was configured with access to the Key Management Service (KMS) and key vault used to encrypt encryptionValue
.
decrypt
has the following syntax:语法如下所示:
The encryptedValue
must be a binary data
object with subtype 6 created using client-side field level encryption.
returns: | The decrypted value. |
---|
Read operations issued from a database connection configured
with access to the correct Key Management Service (KMS) and Key Vault can automatically decrypt field values encrypted using ClientEncryption.encrypt()
. Clients only need to use decrypt()
to decrypt Binary
subtype 6 values not stored within a document field.
The mongo
client-side field level encryption methods require a database connection with client-side field level encryption enabled. If the current database connection was not initiated with client-side field level encryption enabled, either:
Mongo()
constructor from the mongo
shell to establish a connection with the required client-side field level encryption options. The Mongo()
method supports both Amazon Web Services and Local Key Management Service (KMS) providers for Customer Master Key (CMK) management.
or
mongo
shell command line options to establish a connection with the required options. The command line options only support the AWS KMS provider for CMK management.The following example uses a locally managed KMS for the client-side field level encryption configuration.
Configuring client-side field level encryption for a locally managed key requires specifying a base64-encoded 96-byte string with no line breaks. The following operation generates a key that meets the stated requirements and loads it into the mongo
shell:
Create the client-side field level encryption object using the generated local key string:
Use the Mongo()
constructor to create a database connection with the client-side field level encryption options. Replace the mongodb://myMongo.example.net
URI with the connection string URI of the target cluster.
Retrieve the ClientEncryption
object and use the ClientEncryption.decrypt()
method to decrypt a value encrypted by ClientEncryption.encrypt()
.
If successful, decrypt()
returns the decrypted value:
For complete documentation on initiating MongoDB connections with client-side field level encryption enabled, see Mongo()
.