MongoDB\Driver\ClientEncryption::encrypt

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encryptEncrypt a value

Description

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

Encrypts the value.

Liste de paramètres

value

The value to be encrypted. Any value that can be inserted into MongoDB can be encrypted using this method.

options

Encryption options
Option Type Description
algorithm string

The encryption algorithm to be used. This option is required. Specify one of the following ClientEncryption constants:

  • MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC
  • MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM
  • MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
  • MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED
contentionFactor int

The contention factor for evaluating queries with indexed, encrypted payloads.

This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.

Note: Queryable Encryption est en version publique et disponible à des fins d'évaluation. Il n'est pas encore recommandé pour les déploiements de production car des changements incompatibles peuvent être introduits. Voir l'article du blog » Queryable Encryption Preview pour plus d'informations.

keyAltName string

Identifies a key vault collection document by keyAltName. This option is mutually exclusive with keyId and exactly one is required.

keyId MongoDB\BSON\Binary

Identifies a data key by _id. The value is a UUID (binary subtype 4). This option is mutually exclusive with keyAltName and exactly one is required.

queryType int

The query type for evaluating queries with indexed, encrypted payloads. Specify one of the following ClientEncryption constants:

  • MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY

This option only applies and may only be specified when algorithm is MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.

Note: Queryable Encryption est en version publique et disponible à des fins d'évaluation. Il n'est pas encore recommandé pour les déploiements de production car des changements incompatibles peuvent être introduits. Voir l'article du blog » Queryable Encryption Preview pour plus d'informations.

Valeurs de retour

Returns the encrypted value as MongoDB\BSON\Binary object with subtype 6.

Erreurs / Exceptions

Historique

Version Description
PECL mongodb 1.14.0 Added the "contentionFactor" and "queryType" options.

Voir aussi

add a note

User Contributed Notes

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