mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-3315 Remove index_key_id option from ClientEncryption encrypt method (#989)

Browse Source
This commit is contained in:
Julius Park 2022-07-01 12:36:12 -07:00 committed by GitHub
parent b37b146ac8
commit 6d916d68c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
pymongo/encryption.py
View File

@ -636,7 +636,6 @@ class ClientEncryption(object):
algorithm: str,
key_id: Optional[Binary] = None,
key_alt_name: Optional[str] = None,
index_key_id: Optional[Binary] = None,
query_type: Optional[str] = None,
contention_factor: Optional[int] = None,
) -> Binary:
@ -653,8 +652,6 @@ class ClientEncryption(object):
:class:`~bson.binary.Binary` with subtype 4 (
:attr:`~bson.binary.UUID_SUBTYPE`).
- `key_alt_name`: Identifies a key vault document by 'keyAltName'.
- `index_key_id`: **(BETA)** The index key id to use for Queryable Encryption. Must be
a :class:`~bson.binary.Binary` with subtype 4 (:attr:`~bson.binary.UUID_SUBTYPE`).
- `query_type` (str): **(BETA)** The query type to execute. See
:class:`QueryType` for valid options.
- `contention_factor` (int): **(BETA)** The contention factor to use
@ -662,7 +659,7 @@ class ClientEncryption(object):
*must* be given when the :attr:`Algorithm.INDEXED` algorithm is
used.
.. note:: `index_key_id`, `query_type`, and `contention_factor` are part of the
.. note:: `query_type` and `contention_factor` are part of the
Queryable Encryption beta. Backwards-breaking changes may be made before the
final release.
@ -670,17 +667,14 @@ class ClientEncryption(object):
The encrypted value, a :class:`~bson.binary.Binary` with subtype 6.
.. versionchanged:: 4.2
Added the `index_key_id`, `query_type`, and `contention_factor` parameters.
Added the `query_type` and `contention_factor` parameters.
"""
self._check_closed()
if key_id is not None and not (
isinstance(key_id, Binary) and key_id.subtype == UUID_SUBTYPE
):
raise TypeError("key_id must be a bson.binary.Binary with subtype 4")
if index_key_id is not None and not (
isinstance(index_key_id, Binary) and index_key_id.subtype == UUID_SUBTYPE
):
raise TypeError("index_key_id must be a bson.binary.Binary with subtype 4")
doc = encode({"v": value}, codec_options=self._codec_options)
with _wrap_encryption_errors():
@ -689,7 +683,6 @@ class ClientEncryption(object):
algorithm,
key_id=key_id,
key_alt_name=key_alt_name,
index_key_id=index_key_id,
query_type=query_type,
contention_factor=contention_factor,
)

7
test/test_encryption.py
View File

@ -462,13 +462,6 @@ class TestExplicitSimple(EncryptionIntegrationTest):
with self.assertRaisesRegex(TypeError, msg):
client_encryption.encrypt("str", algo, key_id=Binary(b"123"))
msg = "index_key_id must be a bson.binary.Binary with subtype 4"
algo = Algorithm.INDEXED
with self.assertRaisesRegex(TypeError, msg):
client_encryption.encrypt("str", algo, index_key_id=uid) # type: ignore[arg-type]
with self.assertRaisesRegex(TypeError, msg):
client_encryption.encrypt("str", algo, index_key_id=Binary(b"123"))
def test_bson_errors(self):
client_encryption = ClientEncryption(
KMS_PROVIDERS, "keyvault.datakeys", client_context.client, OPTS