Make configuration doc more prominent and point out surprising behavior on MAC-based protection #98
Conversation
DDvO
force-pushed
the
improve_config_doc
branch
from
333fb65 to
b6d2ad2
Compare
…sponses to requests with MAC-based protection
DDvO
force-pushed
the
improve_config_doc
branch
from
b6d2ad2 to
271904e
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation by making the configuration section more prominent in the main README and documenting potentially surprising behavior related to MAC-based protection in CMP responses.
- Moved the Configuration section earlier in the README for better visibility
- Updated RFC references to more recent versions throughout the documentation
- Added detailed explanation of MAC-based protection behavior for response messages
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Moved Configuration section up and enhanced its description |
| doc/config/README.md | Updated RFC references and added MAC-based protection behavior documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
doc/config/README.md
Outdated
| and the respective type of the outgoing response message (e.g., `IP`) | ||
| is configured to be reprotected, any given configuration of outgoing |
There was a problem hiding this comment.
Note that this documents the behavior before the changes now being done!
This needs to be updated.
doc/config/README.md
Outdated
| responses to MAC-based requests at Downstream are always reprotected using the | ||
| same credentials. |
There was a problem hiding this comment.
Now the documenting text looks to me current w.r.t. the latest behavior and rather correct.
Still I propose improving the wording for more preciseness and clarity, e.g., like this:
When responding to request messages that include successfully verified MAC-based protection, the corresponding response messages are protected using the same MAC-based algorithm, credentials, and parameters — regardless of the configuration related to reprotection or output credentials.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
README.md: move Configuration section to make it more visible and slightly extend itdoc/config/README.md: document the partly surprising protection of responses to requests with MAC-based protectionThis came up while handling siemens/gencmpclient#66.