Added warning about SHA1 being used for response signing in ocsp.rst #10204
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added warning about SHA1 being used for sign()
Fixed spelling issues, at least according to en-GB dictionary.
Spell checker didn't catch "algorithim" somehow.
|
Apparently dictionary didn't catch "algorithim" somehow... Should be all good now. |
|
FYI the rust nightly failure is unrelated to this PR and we're identifying a fix. |
alex
reviewed
Jan 18, 2024
docs/x509/ocsp.rst
Outdated
Comment on lines
343
to
347
| otherwise. This should not be the same algorithm used to add | ||
| a certificate to the response, as | ||
| :class:`~cryptography.hazmat.primitives.hashes.SHA1` can't be used | ||
| for signing, despite its compatibility requirement for certain | ||
| applications. |
There was a problem hiding this comment.
I'd suggest rephrasing to state that this does not need to be the same algorithm used in add_response (i.e., link to it) and separately that SHA1 is disallowed here even though it's allowed here.
We don't want people to think that if they pass SHA256 to add_response that they shouldn't use it here.
There was a problem hiding this comment.
Edited it, I think I rephrased it well enough? Decided to be more direct.
Attempting to rephrase the warning.
Removing rouge space.
alex
approved these changes
Jan 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While SHA1 can't be used for signing requests/responses, it can still be used for adding certificates to the request/response. I am guessing this is allowable due to the fact that we're signing with a stronger algorithm (SHA256), preventing modification of digest made with a weaker algorithm (SHA1)
Despite this, there is not enough clarity to indicate this, as someone may see the SHA1 algorithm being used in the "add_response" function and thinking "Oh! We can use SHA1 here", despite that not being the case. This commits adds the needed clarity.