PHP 8.4.1 Released!

MongoDB\Driver\ClientEncryption::encrypt

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encryptChiffre une valeur

Description

final public MongoDB\Driver\ClientEncryption::encrypt(mixed $value, ?array $options = null): MongoDB\BSON\Binary

Chiffre la valeur.

Liste de paramètres

value

La valeur à chiffrer. Toute valeur qui peut être insérée dans MongoDB peut être chiffrée en utilisant cette méthode.

options

Options de chiffrement
Option Type Description
algorithm string

L'algorithme de chiffrement à utiliser. Cette option est requise. Spécifiez l'une des constantes suivantes de ClientEncryption :

contentionFactor int

Le facteur de contention pour évaluer les requêtes avec des charges utiles chiffrées indexées.

Cette option s'applique uniquement et ne peut être spécifiée que lorsque algorithm est MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED ou MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.

keyAltName string

Identifie un document de collection de coffre à clés par keyAltName. Cette option est mutuellement exclusive avec keyId et l'une des deux est requise.

keyId MongoDB\BSON\Binary

Identifie une clé de données par _id. La valeur est un UUID (sous-type binaire 4). Cette option est mutuellement exclusive avec keyAltName et l'une des deux est requise.

queryType string

Le type de requête pour évaluer les requêtes avec des charges utiles chiffrées indexées. Spécifiez l'une des constantes suivantes de ClientEncryption :

Cette option s'applique uniquement et ne peut être spécifiée que lorsque algorithm est MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED ou MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.

rangeOpts array

Options d'index pour un champ de chiffrement interrogeable prenant en charge les requêtes "range". Les options ci-dessous doivent correspondre aux valeurs définies dans encryptedFields de la collection cible. Pour les types de champ BSON double et decimal128, min, max et precision doivent être tous définis ou tous non définis.

Options d'index de plage
Option Type Description
min mixed Requis si precision est défini. La valeur BSON minimale de la plage.
max mixed Requis si precision est défini. La valeur BSON maximale de la plage.
sparsity int Optionnel.Entier positif sur 64 bits.
precision int Facultatif. Entier positif sur 32 bits spécifiant la précision à utiliser pour le chiffrement explicite. Peut uniquement être défini pour les types de champ BSON double ou decimal128.
trimFactor int Optionnel. Entier positif sur 32 bits.

Valeurs de retour

Renvoie la valeur chiffrée en tant qu'un objet MongoDB\Driver\ClientEncryption::decrypt() de sous-type 6.

Erreurs / Exceptions

  • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
  • Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du chiffrement de la valeur

Historique

Version Description
PECL mongodb 1.20.0 Ajouté l'option de plage "trimFactor". L'option de plage "sparsity" est désormais optionnelle.
PECL mongodb 1.16.0 Ajouté l'option "rangeOpts".
PECL mongodb 1.14.0 Ajout des options "contentionFactor" et "queryType".

Voir aussi

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top