(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::createDataKey — Create a new encryption data key
$kmsProvider
, array $options
= ?): MongoDB\BSON\BinaryCreates a new key document and inserts it into the key vault collection.
kmsProvider
The KMS provider (e.g. "local"
,
"aws"
, "azure"
,
"gcp"
) that will be used to encrypt the new encryption
key.
options
Option | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
masterKey | array |
The masterKey identifies a KMS-specific key used to encrypt the new
data key. This option is required unless
If
If
If
|
|||||||||||||||||||||||||||||||||||||||||||||
keyAltNames | array |
An optional list of string alternate names used to reference a key.
If a key is created with alternate names, then encryption may refer
to the key by the unique alternate name instead of by
|
Returns the identifier of the new key as a MongoDB\BSON\Binary object with subtype 4 (UUID).
バージョン | 説明 |
---|---|
PECL mongodb 1.10.0 | Azure and GCP are now supported as KMS providers for client-side encryption. |