o ] N@sdZddlZddlZddlZddlZddlZz"ddlmZddlm Z ddl m Z ddl m Z ddlmZdZWn eyEd ZeZYnwdd lmZmZmZdd lmZdd lmZmZmZdd lmZddlm Z m!Z!m"Z"ddl#m$Z$ddl%m&Z&m'Z'm(Z(m)Z)ddl*m+Z+ddl,m-Z-m.Z.ddl/m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8dZ9dZ:dZ;ee$edZddZ?GdddeZ@Gd d!d!eZAGd"d#d#eZBGd$d%d%eZCdS)&z8Support for explicit client-side field level encryption.N) AutoEncrypter)MongoCryptError)ExplicitEncrypter)MongoCryptOptions)MongoCryptCallbackTF) _dict_to_bsondecodeencode) CodecOptions)BinarySTANDARD UUID_SUBTYPE) BSONError)DEFAULT_RAW_BSON_OPTIONSRawBSONDocument _inflate_bson)SON)ConfigurationErrorEncryptionErrorInvalidOperationServerSelectionTimeoutError) MongoClient)_configured_socket PoolOptions) ReadConcern)get_ssl_context) parse_host) WriteConcern) _spawn_daemoni i)document_classuuid_representationc cs>zdVWdStyty}zt|d}~ww)z2Context manager to wrap encryption related errors.N)r Exceptionr)excr$D/var/www/html/env/lib/python3.10/site-packages/pymongo/encryption.py_wrap_encryption_errorsEs  r&c@sTeZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ dS) _EncryptionIOcCsP|dur t||_nd|_|jttddtddd|_||_||_ d|_ dS)z8Internal class to perform I/O on behalf of pymongocrypt.Nmajority)level)w) codec_options read_concern write_concernF) weakrefref client_ref with_options_KEY_VAULT_OPTSrrkey_vault_collmongocryptd_clientopts_spawned)selfclientr3r4r5r$r$r%__init__Ss z_EncryptionIO.__init__c Cs|j}|j}t|t\}}tddddddd}ttt|d}t||f|}z(|||j dkrG| |j } | | |j dks0W| dSW| dS| w)zComplete a KMS request. :Parameters: - `kms_context`: A :class:`MongoCryptKmsContext`. :Returns: None NT)connect_timeoutsocket_timeout ssl_contextr) endpointmessager _HTTPS_PORTrr_KMS_CONNECT_TIMEOUTrsendall bytes_neededrecvfeedclose) r7 kms_contextr=r>hostportctxr5conndatar$r$r% kms_requestbs$      z_EncryptionIO.kms_requestcCsd||jt|d}|D]}t|dtWdSWddS1s+wYdS)aGet the collection info for a namespace. The returned collection info is passed to libmongocrypt which reads the JSON schema. :Parameters: - `database`: The database on which to run listCollections. - `filter`: The filter to pass to listCollections. :Returns: The first document from the listCollections command response as BSON. )filterFN)r0list_collectionsrr_DATA_KEY_OPTS)r7databaserMcursordocr$r$r%collection_info{s "z_EncryptionIO.collection_infocCs.d|_|jjpdg}||jjt|dS)z~Spawn mongocryptd. Note this method is thread safe; at most one mongocryptd will start successfully. T mongocryptdN)r6r5_mongocryptd_spawn_pathextend_mongocryptd_spawn_argsr)r7argsr$r$r%spawns z_EncryptionIO.spawncCsz|js |jjs |t|t}z|j|j|td}W|j Sty<|jjr*||j|j|td}Y|j Sw)zMark a command for encryption. :Parameters: - `database`: The database on which to run this command. - `cmd`: The BSON command to run. :Returns: The marked command response from mongocryptd. r+) r6r5_mongocryptd_bypass_spawnrYrrr4commandrraw)r7rPcmd inflated_cmdresr$r$r% mark_commands&     z_EncryptionIO.mark_commandccsJ|jt|}|D]}|jVq WddS1swYdS)zYields one or more keys from the key vault. :Parameters: - `filter`: The filter to pass to find. :Returns: A generator which yields the requested keys from the key vault. N)r3findrr])r7rMrQkeyr$r$r% fetch_keyss   "z_EncryptionIO.fetch_keyscCs@t|}|d}t|tjstd|j|t|j t dS)zInsert a data key into the key vault. :Parameters: - `data_key`: The data key document to insert. :Returns: The _id of the inserted data key document. _idzdata_key _id must be a UUID)subtype) rget isinstanceuuidUUID TypeErrorr3 insert_oner bytesr )r7data_keyraw_doc data_key_idr$r$r%insert_data_keys    z_EncryptionIO.insert_data_keycCst|S)zEncode a document to BSON. A document can be any mapping type (like :class:`dict`). :Parameters: - `doc`: mapping type representing a document :Returns: The encoded BSON bytes. )r )r7rRr$r$r% bson_encodes z_EncryptionIO.bson_encodecCs*d|_d|_|jr|jd|_dSdS)zjRelease resources. Note it is not safe to call this method from __del__ or any GC hooks. N)r0r3r4rEr7r$r$r%rEs   z_EncryptionIO.closeN) __name__ __module__ __qualname__r9rLrSrYrardrqrrrEr$r$r$r%r'Rs   r'c@s@eZdZddZddZddZddZd d Zed d Z d S) _EncryptercCsD|jdurd}nt|jdt}t|t|j||_|j|_d|_dS)a1Encrypts and decrypts MongoDB commands. This class is used to support automatic encryption and decryption of MongoDB commands. :Parameters: - `io_callbacks`: A :class:`MongoCryptCallback`. - `opts`: The encrypted client's :class:`AutoEncryptionOpts`. NF) _schema_maprrOrr_kms_providers_auto_encrypter_bypass_auto_encryption_closed)r7 io_callbacksr5 schema_mapr$r$r%r9s  z_Encrypter.__init__c Csv||o |dd}t|||}t|j||}t|t}|r(||d<|WdS1s4wYdS)abEncrypt a MongoDB command. :Parameters: - `database`: The database for this command. - `cmd`: A command document. - `check_keys`: If True, check `cmd` for invalid keys. - `codec_options`: The CodecOptions to use while encoding `cmd`. :Returns: The encrypted command to execute. z $clusterTimeN) _check_closedpoprr&rzencryptrr) r7rPr^ check_keysr+ cluster_time encoded_cmd encrypted_cmd encrypt_cmdr$r$r%rs  $z_Encrypter.encryptcCs>|t|j|WdS1swYdS)zDecrypt a MongoDB command response. :Parameters: - `response`: A MongoDB command response as BSON. :Returns: The decrypted command response. N)rr&rzdecrypt)r7responser$r$r%rs  $z_Encrypter.decryptcCs|jrtddS)Nz"Cannot use MongoClient after close)r|rrsr$r$r%r&sz_Encrypter._check_closedcCsd|_|jdS)zCleanup resources.TN)r|rzrErsr$r$r%rE*sz_Encrypter.closecCsP|jp|}|jdd\}}|||}t|jdtd}t||||}t||S)a Create a _CommandEncyptor for a client. :Parameters: - `client`: The encrypted MongoClient. - `opts`: The encrypted client's :class:`AutoEncryptionOpts`. :Returns: A :class:`_CommandEncrypter` for this client. .F)connectserverSelectionTimeoutMS)_key_vault_client_key_vault_namespacesplitr_mongocryptd_uri_MONGOCRYPTD_TIMEOUT_MSr'rw)r8r5key_vault_clientdbcollr3r4r}r$r$r%create/s   z_Encrypter.createN) rtrurvr9rrrrE staticmethodrr$r$r$r%rws rwc@seZdZdZdZdZdS) Algorithmz9An enum that defines the supported encryption algorithms.z+AEAD_AES_256_CBC_HMAC_SHA_512-Deterministicz$AEAD_AES_256_CBC_HMAC_SHA_512-RandomN)rtrurv__doc__+AEAD_AES_256_CBC_HMAC_SHA_512_Deterministic$AEAD_AES_256_CBC_HMAC_SHA_512_Randomr$r$r$r%rGs rc@sXeZdZdZddZ  dddZdddZd d Zd d Zd dZ ddZ ddZ dS)ClientEncryptionz,Explicit client-side field level encryption.cCsztstdt|tstd||_||_||_||_| dd\}}|||}t d|dd|_ t |j t |d|_dS)aExplicit client-side field level encryption. The ClientEncryption class encapsulates explicit operations on a key vault collection that cannot be done directly on a MongoClient. Similar to configuring auto encryption on a MongoClient, it is constructed with a MongoClient (to a MongoDB cluster containing the key vault collection), KMS provider configuration, and keyVaultNamespace. It provides an API for explicitly encrypting and decrypting values, and creating data keys. It does not provide an API to query keys from the key vault collection, as this can be done directly on the MongoClient. See :ref:`explicit-client-side-encryption` for an example. :Parameters: - `kms_providers`: Map of KMS provider options. Two KMS providers are supported: "aws" and "local". The kmsProviders map values differ by provider: - `aws`: Map with "accessKeyId" and "secretAccessKey" as strings. These are the AWS access key ID and AWS secret access key used to generate KMS messages. - `local`: Map with "key" as a 96-byte array or string. "key" is the master key used to encrypt/decrypt data keys. This key should be generated and stored as securely as possible. - `key_vault_namespace`: The namespace for the key vault collection. The key vault collection contains all data keys used for encryption and decryption. Data keys are stored as documents in this MongoDB collection. Data keys are protected with encryption by a KMS provider. - `key_vault_client`: A MongoClient connected to a MongoDB cluster containing the `key_vault_namespace` collection. - `codec_options`: An instance of :class:`~bson.codec_options.CodecOptions` to use when encoding a value for encryption and decoding the decrypted BSON value. This should be the same CodecOptions instance configured on the MongoClient, Database, or Collection used to access application data. .. versionadded:: 3.9 zclient-side field level encryption requires the pymongocrypt library: install a compatible version with: python -m pip install 'pymongo[encryption]'zDcodec_options must be an instance of bson.codec_options.CodecOptionsrrN)_HAVE_PYMONGOCRYPTrrhr rkryrr_codec_optionsrr' _io_callbacksrr _encryption)r7 kms_providerskey_vault_namespacerr+rrr3r$r$r%r9Rs +    zClientEncryption.__init__NcCsD|t|jj|||dWdS1swYdS)aCreate and insert a new data key into the key vault collection. :Parameters: - `kms_provider`: The KMS provider to use. Supported values are "aws" and "local". - `master_key`: Identifies a KMS-specific key used to encrypt the new data key. If the kmsProvider is "local" the `master_key` is not applicable and may be omitted. If the `kms_provider` is "aws" it is required and has the following fields:: - `region` (string): Required. The AWS region, e.g. "us-east-1". - `key` (string): Required. The Amazon Resource Name (ARN) to the AWS customer. - `endpoint` (string): Optional. An alternate host to send KMS requests to. May include port number, e.g. "kms.us-east-1.amazonaws.com:443". - `key_alt_names` (optional): 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 ``key_id``. The following example shows creating and referring to a data key by alternate name:: client_encryption.create_data_key("local", keyAltNames=["name1"]) # reference the key with the alternate name client_encryption.encrypt("457-55-5462", keyAltName="name1", algorithm=Algorithm.Random) :Returns: The ``_id`` of the created data key document as a :class:`~bson.binary.Binary` with subtype :data:`~bson.binary.UUID_SUBTYPE`. ) master_key key_alt_namesN)rr&rcreate_data_key)r7 kms_providerrrr$r$r%rs#$z ClientEncryption.create_data_keycCs||durt|tr|jtkstdtd|i|jd}t|j j ||||d}t |dWdS1s=wYdS)aEncrypt a BSON value with a given key and algorithm. Note that exactly one of ``key_id`` or ``key_alt_name`` must be provided. :Parameters: - `value`: The BSON value to encrypt. - `algorithm` (string): The encryption algorithm to use. See :class:`Algorithm` for some valid options. - `key_id`: Identifies a data key by ``_id`` which must be a :class:`~bson.binary.Binary` with subtype 4 ( :attr:`~bson.binary.UUID_SUBTYPE`). - `key_alt_name`: Identifies a key vault document by 'keyAltName'. :Returns: The encrypted value, a :class:`~bson.binary.Binary` with subtype 6. Nz2key_id must be a bson.binary.Binary with subtype 4vrZ)key_id key_alt_name) rrhr rfr rkr rr&rrr)r7value algorithmrrrR encrypted_docr$r$r%rs  $zClientEncryption.encryptcCsx|t|tr|jdkstdttd|i}|j|}t ||j ddWdS1s5wYdS)zDecrypt an encrypted value. :Parameters: - `value` (Binary): The encrypted value, a :class:`~bson.binary.Binary` with subtype 6. :Returns: The decrypted BSON value. zsZ                  \