Skip to content

Commit 6c973ab

Browse files
jason-price-mongodbjason-price-mongodb
andauthored
DOCSP-21757 audit log removal from 5 3 (#1155)
* DOCSP-21757-audit-log-removal-from-5-3 * DOCSP-21757-audit-log-removal-from-5-3 * DOCSP-21757-audit-log-removal-from-5-3 * DOCSP-21757-audit-log-removal-from-5-3 * DOCSP-21757-audit-log-removal-from-5-3 Co-authored-by: jason-price-mongodb <[email protected]>
1 parent f1f6808 commit 6c973ab

File tree

3 files changed

+9
-97
lines changed

3 files changed

+9
-97
lines changed

source/core/security-encryption-at-rest.txt

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -109,49 +109,13 @@ transport encryption.
109109

110110
For details, see :ref:`rotate-encryption-keys`.
111111

112+
.. _security-encryption-at-rest-audit-log:
113+
112114
Audit Log
113115
~~~~~~~~~
114116

115117
Available in MongoDB Enterprise only.
116118

117-
.. _security-encryption-at-rest-audit-log:
118-
119-
Use KMIP Server to Manage Keys for Encrypting the MongoDB Audit Log
120-
```````````````````````````````````````````````````````````````````
121-
122-
Starting in MongoDB 5.3 Enterprise, you can use an external Key
123-
Management Interoperability Protocol (KMIP) server to securely manage
124-
the keys for encrypting the MongoDB audit log.
125-
126-
To use a KMIP server with audit log encryption, configure these settings
127-
and parameters:
128-
129-
- :setting:`auditLog.auditEncryptionKeyIdentifier` setting
130-
- :setting:`auditLog.compressionMode` setting
131-
- :parameter:`auditEncryptionHeaderMetadataFile` parameter
132-
- :parameter:`auditEncryptKeyWithKMIPGet` parameter
133-
134-
For testing audit log encryption, you can also use the
135-
:setting:`auditLog.localAuditKeyFile` setting.
136-
137-
If you need to downgrade MongoDB, you must first disable audit log
138-
encryption by removing :setting:`auditLog.auditEncryptionKeyIdentifier`
139-
or :setting:`auditLog.localAuditKeyFile`. Existing audit logs remain
140-
encrypted, and you can keep any procedures you have developed for
141-
storage and ingestion of encrypted logs.
142-
143-
.. note::
144-
145-
For audit log encryption, the audit log destination must be a
146-
file. :term:`syslog` cannot be used as the destination.
147-
148-
Unencrypted Audit Log and Process Log
149-
`````````````````````````````````````
150-
151-
This section applies if you are not using an external Key Management
152-
Interoperability Protocol (KMIP) server to manage keys for encrypting
153-
the audit log as shown in the previous section.
154-
155119
The audit log file is not encrypted as a part of MongoDB's encrypted
156120
storage engine. A :binary:`~bin.mongod` running with :ref:`logging
157121
<monitoring-standard-loggging>` may output potentially sensitive

source/reference/parameters.txt

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4398,58 +4398,6 @@ Auditing Parameters
43984398
Using the default value of 300 seconds, non-config nodes may lag up
43994399
to 5 minutes behind a setAuditConfig command.
44004400

4401-
.. parameter:: auditEncryptionHeaderMetadataFile
4402-
4403-
.. versionadded:: 5.3
4404-
4405-
*Type*: string
4406-
4407-
.. include:: /includes/note-audit-in-enterprise.rst
4408-
4409-
|both|
4410-
4411-
Path and file name for logging metadata audit headers for :ref:`audit
4412-
log encryption <security-encryption-at-rest-audit-log>`. A header is
4413-
placed at the top of each audit log file and contains metadata for
4414-
decrypting the audit log. The headers are also stored in the
4415-
:doc:`audit log </core/auditing>`.
4416-
4417-
You can only set :parameter:`auditEncryptionHeaderMetadataFile`
4418-
during startup in the :setting:`configuration file <setParameter>` or
4419-
with the ``--setParameter`` option on the command line. For example,
4420-
the following sets the path and file for
4421-
:parameter:`auditEncryptionHeaderMetadataFile`:
4422-
4423-
.. code-block:: bash
4424-
4425-
mongod --setParameter auditEncryptionHeaderMetadataFile=/auditFiles/auditHeadersMetadataFile.log
4426-
4427-
.. parameter:: auditEncryptKeyWithKMIPGet
4428-
4429-
.. versionadded:: 5.3
4430-
4431-
*Type*: boolean
4432-
4433-
*Default*: false
4434-
4435-
.. include:: /includes/note-audit-in-enterprise.rst
4436-
4437-
|both|
4438-
4439-
Enables :ref:`audit log encryption
4440-
<security-encryption-at-rest-audit-log>` for Key Management
4441-
Interoperability Protocol (KMIP) servers that only support KMIP
4442-
protocol version 1.0 or 1.1.
4443-
4444-
You can only set :parameter:`auditEncryptKeyWithKMIPGet` during
4445-
startup in the :setting:`configuration file <setParameter>` or with
4446-
the ``--setParameter`` option on the command line. For example, the
4447-
following sets :parameter:`auditEncryptKeyWithKMIPGet` to ``true``:
4448-
4449-
.. code-block:: bash
4450-
4451-
mongod --setParameter auditEncryptKeyWithKMIPGet=true
4452-
44534401
Transaction Parameters
44544402
~~~~~~~~~~~~~~~~~~~~~~
44554403

source/release-notes/5.3.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ defragmented.
115115
General Improvements
116116
--------------------
117117

118+
Time Series Collection Improvements
119+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
120+
121+
Starting in MongoDB 5.3, you can use the :pipeline:`$geoNear` pipeline
122+
operator on any field in a :ref:`time series collection
123+
<manual-timeseries-collection>`.
124+
118125
Clustered Collections
119126
~~~~~~~~~~~~~~~~~~~~~
120127

@@ -168,13 +175,6 @@ Starting in MongoDB 5.3, the :parameter:`fassertOnLockTimeoutForStepUpDown`
168175
parameter allows a server that receives a request to step up or down to
169176
terminate if it is unable to comply within the timeout.
170177

171-
Time Series Collection Improvements
172-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173-
174-
Starting in MongoDB 5.3, you can use the :pipeline:`$geoNear` pipeline
175-
operator on any field in a :ref:`time series collection
176-
<manual-timeseries-collection>`.
177-
178178
Multiple Arbiters
179179
~~~~~~~~~~~~~~~~~~
180180

0 commit comments

Comments
 (0)