yggdrasil/ring
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Take BoringSSL 1ab133a: Fix some style guide samples.

Browse Source
This commit is contained in:
Brian Smith 2018-04-29 19:49:28 -10:00
commit e533b55882
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
STYLE.md
View File

@ -378,23 +378,23 @@ behavior of the function. Pay special note to success/failure behaviors
and caller obligations on object lifetimes. If this sacrifices and caller obligations on object lifetimes. If this sacrifices
conciseness, consider simplifying the function's behavior. conciseness, consider simplifying the function's behavior.
/* EVP_DigestVerifyUpdate appends |len| bytes from |data| to the data which // EVP_DigestVerifyUpdate appends |len| bytes from |data| to the data which
* will be verified by |EVP_DigestVerifyFinal|. It returns one on success and // will be verified by |EVP_DigestVerifyFinal|. It returns one on success and
* zero otherwise. */ // zero otherwise.
OPENSSL_EXPORT int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data, OPENSSL_EXPORT int EVP_DigestVerifyUpdate(EVP_MD_CTX *ctx, const void *data,
size_t len); size_t len);
Explicitly mention any surprising edge cases or deviations from common Explicitly mention any surprising edge cases or deviations from common
return value patterns in legacy functions. return value patterns in legacy functions.
/* RSA_private_encrypt encrypts |flen| bytes from |from| with the private key in // RSA_private_encrypt encrypts |flen| bytes from |from| with the private key in
* |rsa| and writes the encrypted data to |to|. The |to| buffer must have at // |rsa| and writes the encrypted data to |to|. The |to| buffer must have at
* least |RSA_size| bytes of space. It returns the number of bytes written, or // least |RSA_size| bytes of space. It returns the number of bytes written, or
* -1 on error. The |padding| argument must be one of the |RSA_*_PADDING| // -1 on error. The |padding| argument must be one of the |RSA_*_PADDING|
* values. If in doubt, |RSA_PKCS1_PADDING| is the most common. // values. If in doubt, |RSA_PKCS1_PADDING| is the most common.
* //
* WARNING: this function is dangerous because it breaks the usual return value // WARNING: this function is dangerous because it breaks the usual return value
* convention. Use |RSA_sign_raw| instead. */ // convention. Use |RSA_sign_raw| instead.
OPENSSL_EXPORT int RSA_private_encrypt(int flen, const uint8_t *from, OPENSSL_EXPORT int RSA_private_encrypt(int flen, const uint8_t *from,
uint8_t *to, RSA *rsa, int padding); uint8_t *to, RSA *rsa, int padding);