Skip to content
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

docs: update CIPHERS.md #14460

Closed
wants to merge 1 commit into from
Closed

docs: update CIPHERS.md #14460

wants to merge 1 commit into from

Conversation

jan2000
Copy link
Contributor

@jan2000 jan2000 commented Aug 8, 2024

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
Copy link
Contributor Author

jan2000 commented Aug 8, 2024

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
Copy link
Member

bagder commented Aug 9, 2024

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
Copy link
Member

bagder commented Aug 12, 2024

Thanks!

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