Skip to content

PYTHON-4164 Document support for KMIP delegated master_key #1830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ PyMongo 4.9 brings a number of improvements including:
- Added support for In-Use Encryption range queries with MongoDB 8.0.
Added :attr:`~pymongo.encryption.Algorithm.RANGE`.
``sparsity`` and ``trim_factor`` are now optional in :class:`~pymongo.encryption_options.RangeOpts`.
- Added support for the "delegated" option for the KMIP ``master_key`` in
:meth:`~pymongo.encryption.ClientEncryption.create_data_key`.
- pymongocrypt>=1.10 is now required for :ref:`In-Use Encryption` support.
- Added :meth:`~pymongo.cursor.Cursor.to_list` to :class:`~pymongo.cursor.Cursor`,
:class:`~pymongo.command_cursor.CommandCursor`,
Expand Down
3 changes: 3 additions & 0 deletions pymongo/asynchronous/encryption.py
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,9 @@ async def create_data_key(
Secret Data managed object.
- `endpoint` (string): Optional. Host with optional
port, e.g. "example.vault.azure.net:".
- `delegated` (bool): Optional. If True (recommended), the
KMIP server will perform encryption and decryption. If
delegated is not provided, defaults to false.

:param key_alt_names: An optional list of string alternate
names used to reference a key. If a key is created with alternate
Expand Down
3 changes: 3 additions & 0 deletions pymongo/synchronous/encryption.py
Original file line number Diff line number Diff line change
Expand Up @@ -762,6 +762,9 @@ def create_data_key(
Secret Data managed object.
- `endpoint` (string): Optional. Host with optional
port, e.g. "example.vault.azure.net:".
- `delegated` (bool): Optional. If True (recommended), the
KMIP server will perform encryption and decryption. If
delegated is not provided, defaults to false.

:param key_alt_names: An optional list of string alternate
names used to reference a key. If a key is created with alternate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"replicaset",
"sharded",
"load-balanced"
]
],
"serverless": "forbid"
}
],
"database_name": "default",
Expand Down
Loading