Skip to content

docs: update CIPHERS.md - #14460

Closed
jan2000 wants to merge 1 commit into
curl:masterfrom
jan2000:ssl-ciphers-doc
Closed

jan2000 wants to merge 1 commit into
curl:masterfrom
jan2000:ssl-ciphers-doc

Conversation

@jan2000

@jan2000 jan2000 commented Aug 8, 2024

Copy link
Copy Markdown
Contributor

Give a more consice overview of curl's cipher options and cipher suites.

Removed long lists of ciphers that were directly copied from the SSL backends' documentation. Instead present the user a more common aproach acorss the SSL backends, with notes for backends that do not conform and/or provide alternate means.

Provide a shorter list of cipher suites that is more relevant for modern usage and should work mostly across all backends, provide a seperate list with all cipher suites, and provide links to the SSL backends' documentation for more information.

Also give examples with modern cipher suites.

@jan2000
jan2000 marked this pull request as draft August 8, 2024 15:29
@jan2000

jan2000 commented Aug 8, 2024

Copy link
Copy Markdown
Contributor Author

So I have added this TLS 1.2 ciphers list document, that serves as a reference for the updated CIPHERS.md doc. But I am not to sure about the location of this document. For now I put it in docs/CIPHERS-TLS12-ALL.md, but there it obviously fails the CI spell checker. Any suggestions?

@bagder

bagder commented Aug 9, 2024

Copy link
Copy Markdown
Member

I propose you drop ALL from the filename and make it: docs/CIPHERS-TLS12.md

Then I think we can skip this file in the spellcheck CI job:

--- a/.github/scripts/spellcheck.yaml
+++ b/.github/scripts/spellcheck.yaml
@@ -27,6 +27,6 @@ matrix:
             - 'code'
             - 'pre'
             - 'strong'
             - 'em'
     sources:
-      - '**/*.md|!docs/BINDINGS.md|!docs/DISTROS.md'
+      - '**/*.md|!docs/BINDINGS.md|!docs/DISTROS.md|!docs/CIPHERS-TLS12.md'

Give a more consice overview of curl's cipher options and cipher suites.

Removed long lists of ciphers that were directly copied from the SSL
backends' documentation. Instead present the user a more common aproach
acorss the SSL backends, with notes for backends that do not conform
and/or provide alternate means.

Provide a shorter list of cipher suites that is more relevant for
modern usage and should work mostly across all backends, provide a
seperate list with all cipher suites, and provide links to the SSL
backends' documentation for more information.

Also give examples with modern cipher suites.
@github-actions github-actions Bot added the CI Continuous Integration label Aug 9, 2024
@jan2000
jan2000 marked this pull request as ready for review August 9, 2024 12:54
@bagder bagder closed this in 77d722a Aug 12, 2024
@bagder

bagder commented Aug 12, 2024

Copy link
Copy Markdown
Member

Thanks!

@jan2000
jan2000 deleted the ssl-ciphers-doc branch August 13, 2024 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous Integration documentation

Development

Successfully merging this pull request may close these issues.

2 participants