Commit d0048e4
authored
docs: refresh stale TLS security recommendations in remoting docs (#3489)
Motivation:
remote-security.md and remoting.md both cited RFC 7525 (2015) as the
current source for recommended TLS cipher suites, but RFC 7525 was
obsoleted by RFC 9325 (Nov 2022). Both docs also linked to the Java
8-specific JSSE Reference Guide as "the official" documentation, even
though Pekko 2.0.x requires JDK 17+ as a minimum. remote-security.md
additionally carried a dead caveat about Java 8 runtime support for a
TLS 1.3 cipher suite. The classic (legacy) remoting.md TLS section had
also drifted out of sync with remote-security.md, which recently
gained TLS 1.3 cipher guidance, post-handshake session verification,
a random-number-generator recommendation, and mTLS-rotation-in-
Kubernetes guidance that remoting.md never received.
Modification:
- remote-security.md, remoting.md: cite RFC 9325 instead of the
obsoleted RFC 7525, noting that it obsoletes RFC 7525.
- remote-security.md, remoting.md: point the JSSE documentation link
at the current (Java SE 25) JSSE Reference Guide instead of the
Java 8 version.
- remote-security.md: drop the "(may not be supported on Java 8
runtimes)" caveat on TLS_CHACHA20_POLY1305_SHA256, which no longer
applies now that Java 8 isn't a supported runtime.
- remoting.md: add a note pointing to remote-security.md for the
additional current TLS guidance that isn't duplicated into the
deprecated classic-remoting doc, instead of letting the two pages
keep drifting out of sync.
Result:
The remoting security docs cite current IETF guidance and JDK
documentation instead of a decade-old RFC and Java 8-era links, and
classic remoting users are pointed at the fuller, current guidance
instead of being left with silently weaker advice.
Tests:
- Not run - docs only.
References:
None - identified while auditing docs/src/main/paradox for content
out of date relative to the current Pekko version and JDK support.1 parent 80477d3 commit d0048e4
2 files changed
Lines changed: 14 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
56 | | - | |
57 | | - | |
| 56 | + | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
479 | 479 | | |
480 | 480 | | |
481 | 481 | | |
482 | | - | |
| 482 | + | |
483 | 483 | | |
484 | 484 | | |
485 | 485 | | |
| |||
488 | 488 | | |
489 | 489 | | |
490 | 490 | | |
| 491 | + | |
| 492 | + | |
| 493 | + | |
| 494 | + | |
| 495 | + | |
| 496 | + | |
| 497 | + | |
| 498 | + | |
| 499 | + | |
491 | 500 | | |
492 | 501 | | |
493 | 502 | | |
494 | | - | |
| 503 | + | |
495 | 504 | | |
496 | 505 | | |
497 | 506 | | |
| |||
0 commit comments