Added OpenSSL::Cipher Documentation #9934
Merged
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
src/openssl/cipher.cr
Outdated
| @@ -1,6 +1,41 @@ | |||
| require "random/secure" | |||
| require "openssl" | |||
|
|
|||
| # A class which can be used to encrypt and decrypt string data using a specified cipher. | |||
There was a problem hiding this comment.
It's not only for string, is it?
There was a problem hiding this comment.
Sorry I wasn't sure what is allowed for input into OpenSSL::Cipher#update. I'm guessing it's anything that can be turned into Bytes, right?
There was a problem hiding this comment.
Yeah the only technical requirement seems to be having a #to_slice method. The practical idea is obviously to allow String | Bytes. Maybe that should be added as a type restriction to communicate this clearly. This would prevent you from passing any other type that implements #to_slice but that's not common and you can just convert it to a slice at the callsite.
Sija
reviewed
Nov 20, 2020
Co-authored-by: Sijawusz Pur Rahnama <[email protected]>
straight-shoota
approved these changes
Nov 21, 2020
Co-authored-by: Johannes Müller <[email protected]>
straight-shoota
approved these changes
Nov 21, 2020
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.
https://crystal-lang.org/api/0.35.1/OpenSSL/Cipher.html
There's no docs so I added them. Let me know if I need to be clearer.