PYTHON-1993 Use dochub for stable CSFLE documentation links

This commit is contained in:
Shane Harvey 2019-11-21 12:14:06 -08:00
parent e31a0ef95f
commit ec4b02052d

View File

@ -4,9 +4,9 @@ Client-Side Field Level Encryption
New in MongoDB 4.2, client-side field level encryption allows an application
to encrypt specific data fields in addition to pre-existing MongoDB
encryption features such as `Encryption at Rest
<https://docs.mongodb.com/manual/core/security-encryption-at-rest/>`_ and
<https://dochub.mongodb.org/core/security-encryption-at-rest>`_ and
`TLS/SSL (Transport Encryption)
<https://docs.mongodb.com/manual/core/security-transport-encryption/>`_.
<https://dochub.mongodb.org/core/security-tls-transport-encryption>`_.
With field level encryption, applications can encrypt fields in documents
*prior* to transmitting data over the wire to the server. Client-side field
@ -14,8 +14,7 @@ level encryption supports workloads where applications must guarantee that
unauthorized parties, including server administrators, cannot read the
encrypted data.
.. seealso:: The MongoDB documentation for `Client-Side Field Level Encryption
<https://docs.mongodb.com/manual/core/security-client-side-encryption/>`_.
.. mongodoc:: client-side-field-level-encryption
Dependencies
------------
@ -38,10 +37,10 @@ mongocryptd
The ``mongocryptd`` binary is required for automatic client-side encryption
and is included as a component in the `MongoDB Enterprise Server package
<https://docs.mongodb.com/manual/administration/install-enterprise/>`_.
<https://dochub.mongodb.org/core/install-mongodb-enterprise>`_.
For detailed installation instructions see
`the MongoDB documentation on mongocryptd
<https://docs.mongodb.com/manual/reference/security-client-side-encryption-appendix/#mongocryptd>`_.
<https://dochub.mongodb.org/core/client-side-field-level-encryption-mongocryptd>`_.
``mongocryptd`` performs the following:
@ -53,7 +52,7 @@ For detailed installation instructions see
- Rejects read/write operations that may return unexpected or incorrect results
when applied to an encrypted field. For supported and unsupported operations,
see `Read/Write Support with Automatic Field Level Encryption
<https://docs.mongodb.com/manual/reference/security-client-side-query-aggregation-support/>`_.
<https://dochub.mongodb.org/core/client-side-field-level-encryption-read-write-support>`_.
A MongoClient configured with auto encryption will automatically spawn the
``mongocryptd`` process from the application's ``PATH``. Applications can
@ -107,7 +106,7 @@ Providing Local Automatic Encryption Rules
The following example shows how to specify automatic encryption rules via the
``schema_map`` option. The automatic encryption rules are expressed using a
`strict subset of the JSON Schema syntax
<https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/>`_.
<https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules>`_.
Supplying a ``schema_map`` provides more security than relying on
JSON Schemas obtained from the server. It protects against a
@ -144,7 +143,7 @@ will result in an error.::
CodecOptions())
# Create a new data key and json schema for the encryptedField.
# https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/
# https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules
data_key_id = client_encryption.create_data_key(
'local', key_alt_names=['pymongo_encryption_example_1'])
schema = {
@ -234,7 +233,7 @@ encryption using
:class:`~pymongo.encryption.ClientEncryption` to create a new encryption
data key and create a collection with the
`Automatic Encryption JSON Schema Syntax
<https://docs.mongodb.com/manual/reference/security-client-side-automatic-json-schema/>`_::
<https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules>`_::
import os