Skip to content
1 change: 1 addition & 0 deletions doc/tooling/tcm/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,5 @@ to read data. LDAP authorization is supported as well.
tcm_backend_store
tcm_dev_mode
tcm_configuration_reference
tcm_integrity_check
Releases <tcm_releases/index>
55 changes: 55 additions & 0 deletions doc/tooling/tcm/tcm_integrity_check.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
.. _tcm_integrity_check:

Integrity check
================

.. include:: index.rst
:start-after: ee_note_tcm_start
:end-before: ee_note_tcm_end

|tcm| supports the integrity check mechanism.
The integrity check mechanism in TCM verifies the digital signature of centralized configuration files.
It ensures that TCM only applies configurations that are signed with a trusted private key.

This mechanism allows TCM to:

* Update the configuration with integrity check support.
* Detect unauthorized changes in centralized configuration.

.. _tcm_integrity_check_configure:

Configure integrity check
-------------------------

Configuration parameters
~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
:widths: 35 45 10 10

* - Parameter
- Description
- Type
- Default
* - :ref:`security.integrity-check <tcm_configuration_reference_security_integrity-check>`
- Enables signature validation
- ``bool``
- ``false``
* - :ref:`security.signature-private-key-file <tcm_configuration_reference_security_signature-private-key-file>`
- Path to the private key for signing configuration
- ``string``
- ``""``


Example configuration
~~~~~~~~~~~~~~~~~~~~~

Integrity check can be enabled directly in the |tcm| configuration file:

.. code-block:: yaml

# tcm.yaml
security:
integrity-check: true
signature-private-key-file: /etc/tcm/private_key.pem