docs: align RFC + IEC 62443 compliance docs with shipped features#565
Conversation
The compliance docs drifted from the implementation in three places:
- IEC 62443 under-claimed at-rest crypto: E17 shipped mbedTLS AES-256-GCM
(S17.04) alongside the OpenSSL variant, but CR 2.12 / CR 3.9 and the
SL3/SL4 recipes only listed SolidSyslogOpenSslAesGcmPolicy. Now offers
SolidSyslog{OpenSsl,MbedTls}AesGcmPolicy and reframes the E17 refs as
shipped rather than in-progress.
- IEC 62443 over-claimed SolidSyslogFormatter as an SL1 wiring component;
S14.08 made the formatter library-private, so application code never
touches it. Dropped from the SL1 recipe and CR 2.8.
- RFC 5425 §4.1 omitted SolidSyslogLwipRawTcpStream (E28) from the list of
TLS-capable byte transports; added it. Also updated the RFC 5424 §6.2.3
note to reference the public SolidSyslogHeaderField sink rather than the
now-private formatter entry point.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 43 minutes and 20 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
☀️ Quality Summary 🚦 build-linux-gcc: 100% successful (✔️ 1521 passed) Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result. |
1 participant
Summary
Audit of
docs/rfc-compliance.mdanddocs/iec62443.mdagainst the implemented codebase, fixing both over- and under-claims.IEC 62443 (
docs/iec62443.md)SolidSyslogOpenSslAesGcmPolicy. Now offersSolidSyslog{OpenSsl,MbedTls}AesGcmPolicy, and reframes theE17 #105references as shipped rather than in-progress. (Embedded/FreeRTOS SL4 integrators were being told AEAD-at-rest was OpenSSL-only.)SolidSyslogFormatter. S14.08 made the formatter library-private (header moved toCore/Source/), so application code can't reference it. Removed from the SL1 recipe and softened CR 2.8.RFC compliance (
docs/rfc-compliance.md)SolidSyslogLwipRawTcpStream(E28) from the TLS-capable byte transports; added it.SolidSyslogFormatter_PrintUsAsciiString; updated to the publicSolidSyslogHeaderFieldsink. The?substitution behaviour itself was verified accurate.Everything else in both docs reconciled with the code (summary row counts, substitution char, MSGID bound, UTF-8/BOM, keepalive/connect-timeout behaviour, mTLS, etc.).
Docs-only — no code or test changes.
🤖 Generated with Claude Code