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

Improve crypto provider API documentation #1608

Merged
merged 3 commits into from
Nov 21, 2023
Merged

Conversation

ctz
Copy link
Member

@ctz ctz commented Nov 21, 2023

Some misc docs clean ups, but mainly trying to improve matters around CryptoProvider

Copy link
Member

@djc djc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

rustls/src/crypto/mod.rs Outdated Show resolved Hide resolved
rustls/src/crypto/mod.rs Show resolved Hide resolved
rustls/src/crypto/mod.rs Show resolved Hide resolved
rustls/src/client/builder.rs Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
rustls/src/crypto/mod.rs Outdated Show resolved Hide resolved
rustls/src/crypto/mod.rs Outdated Show resolved Hide resolved
rustls/src/crypto/mod.rs Outdated Show resolved Hide resolved
rustls/src/crypto/mod.rs Show resolved Hide resolved
rustls/src/server/common.rs Outdated Show resolved Hide resolved
@ctz
Copy link
Member Author

ctz commented Nov 21, 2023

Thinking about Jsha's feedback from #1603, should we also mention what the crate has typically provided to help guide what a provider should offer in a minimal support set to avoid confusion?

For whatever reason I can't reply to this in-thread.

I'm not sure. I think I probably want to avoid prescribing some mandatory-to-implement key types / parameters here, and just concentrate on making the link 100% crystal clear and leave people to it.

If we were to write some MTI suggestions, I guess most people would put RSA in there, and probably ECDSA. But I think that disavows a completely reasonable CryptoProvider which deliberately don't have or want to support those.

Copy link

codecov bot commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (b8b1327) 95.90% compared to head (fd2d01f) 95.77%.
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1608      +/-   ##
==========================================
- Coverage   95.90%   95.77%   -0.14%     
==========================================
  Files          77       79       +2     
  Lines       15742    16312     +570     
==========================================
+ Hits        15098    15623     +525     
- Misses        644      689      +45     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cpu
Copy link
Member

cpu commented Nov 21, 2023

If we were to write some MTI suggestions, I guess most people would put RSA in there, and probably ECDSA. But I think that disavows a completely reasonable CryptoProvider which deliberately don't have or want to support those.

That seems like a reasonable justification to avoid it 👍

@ctz ctz added this pull request to the merge queue Nov 21, 2023
Merged via the queue into main with commit 1db4506 Nov 21, 2023
40 of 42 checks passed
@ctz ctz deleted the jbp-crypto-provider-docs branch November 21, 2023 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants