-
Notifications
You must be signed in to change notification settings - Fork 43
doc: write about integrity check in tcm #5409
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
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
ab2bf3f
doc: write about integrity check in tcm
b2ae6fb
doc: write about integrity check in tcm
0f0e502
doc: write about integrity check in tcm
597c909
doc: write about integrity check in tcm
dd369e6
doc: write about integrity check in tcm
261e68a
doc: write about integrity check in tcm
c656a36
doc: write about integrity check in tcm
ad643bc
doc: write about integrity check in tcm
08e7d09
doc: write about integrity check in tcm
42ef231
doc: write about integrity check in tcm
514ed10
doc: write about integrity check in tcm
f0373ca
doc: write about integrity check in tcm
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
| * Allows updating 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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the configuration with integrity check support.