MongoDB\Driver\ClientEncryption::createDataKey

Liste de paramètres

kmsProvider

Le fournisseur KMS (par exemple "local", "aws") qui sera utilisé pour chiffrer le nouveau document clé.

options

Options de données de clé

Option	Type	Description
masterKey	array	Le document masterKey identifie une clé spécifique à KMS utilisée pour chiffrer le nouveau document clé. Cette option est requise à moins que kmsProvider soit "local". Options du fournisseur "aws" Option Type Description region string Requis. key string Requis. Le nom de ressource Amazon (ARN) de la clé maîtresse du client AWS (CMK). endpoint string Optionnel. Un identifiant d'hôte alternatif pour envoyer les demandes KMS. Peut inclure le numéro de port. Options du fournisseur "azure" Option Type Description keyVaultEndpoint string Requis. Hôte avec port optionnel (par exemple, "example.vault.azure.net"). keyName string Requis. keyVersion string Optionnel. Une version spécifique de la clé nommée. Par défaut, la version primaire de la clé est utilisée. Options du fournisseur "gcp" Option Type Description projectId string Requis. location string Requis. keyRing string Requis. keyName string Requis. keyVersion string Optionnel. Une version spécifique de la clé nommée. Par défaut, la version primaire de la clé est utilisée. endpoint string Optionnel. Hôte avec port optionnel. La valeur par défaut est "cloudkms.googleapis.com". Options du fournisseur "kmip" Option Type Description keyId string Optionnel. Identifiant unique d'un objet géré de 96 octets de données secrètes KMIP. S'il n'est pas spécifié, le pilote crée un objet géré aléatoire de 96 octets de données secrètes KMIP. endpoint string Optionnel. Hôte avec port optionnel. delegated bool Optionnel. Si vrai, cette clé devrait être déchiffrer par le serveur KMIP.
keyAltNames	array	Une liste optionnelle de noms alternatifs de chaîne utilisés pour référencer une clé. Si une clé est créée avec des noms alternatifs, alors le chiffrement peut se référer à la clé par le nom alternatif unique au lieu de par _id.
keyMaterial	MongoDB\BSON\Binary	Une valeur optionnelle de 96 octets à utiliser comme matériel de clé pour le document clé en cours de création. Si keyMaterial est donné, le matériel de clé personnalisé est utilisé pour chiffrer et déchiffrer les données. Sinon, le matériel de clé pour le nouveau document clé est généré à partir d'un dispositif aléatoire cryptographiquement sécurisé.