Skip to content

Commit eba75fb

Browse files
authored
doc: write about integrity check in tcm (#5409)
* doc: write about integrity check in tcm
1 parent b15c69d commit eba75fb

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

doc/tooling/tcm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,5 @@ to read data. LDAP authorization is supported as well.
4646
tcm_backend_store
4747
tcm_dev_mode
4848
tcm_configuration_reference
49+
tcm_integrity_check
4950
Releases <tcm_releases/index>
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _tcm_integrity_check:
2+
3+
Integrity check
4+
================
5+
6+
.. include:: index.rst
7+
:start-after: ee_note_tcm_start
8+
:end-before: ee_note_tcm_end
9+
10+
|tcm| supports the integrity check mechanism.
11+
The integrity check mechanism in TCM verifies the digital signature of centralized configuration files.
12+
It ensures that TCM only applies configurations that are signed with a trusted private key.
13+
14+
This mechanism allows TCM to:
15+
16+
* Update the configuration with integrity check support.
17+
* Detect unauthorized changes in centralized configuration.
18+
19+
.. _tcm_integrity_check_configure:
20+
21+
Configure integrity check
22+
-------------------------
23+
24+
Configuration parameters
25+
~~~~~~~~~~~~~~~~~~~~~~~~
26+
27+
.. list-table::
28+
:header-rows: 1
29+
:widths: 35 45 10 10
30+
31+
* - Parameter
32+
- Description
33+
- Type
34+
- Default
35+
* - :ref:`security.integrity-check <tcm_configuration_reference_security_integrity-check>`
36+
- Enables signature validation
37+
- ``bool``
38+
- ``false``
39+
* - :ref:`security.signature-private-key-file <tcm_configuration_reference_security_signature-private-key-file>`
40+
- Path to the private key for signing configuration
41+
- ``string``
42+
- ``""``
43+
44+
45+
Example configuration
46+
~~~~~~~~~~~~~~~~~~~~~
47+
48+
Integrity check can be enabled directly in the |tcm| configuration file:
49+
50+
.. code-block:: yaml
51+
52+
# tcm.yaml
53+
security:
54+
integrity-check: true
55+
signature-private-key-file: /etc/tcm/private_key.pem

0 commit comments

Comments
 (0)