diff options
| author | PW Hu <jlu.hpw@foxmail.com> | 2021-10-07 11:40:49 +0800 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2021-10-22 11:54:32 +0200 |
| commit | d641ad51326e96b41f0490e2e3398d08e8f87557 (patch) | |
| tree | c174999a3d0e37e9f74f99ec3676d9a724f957e9 /doc/man3/BIO_f_cipher.pod | |
| parent | ef3889e7a2e21e9acea3bc0927c22f962da36eed (diff) | |
Fix documentation errors, mainly caused by return values of BIO_ctrl
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16767)
(cherry picked from commit 5001287c0dcd8ca4ffc564b360f86df79bba40c1)
Diffstat (limited to 'doc/man3/BIO_f_cipher.pod')
| -rw-r--r-- | doc/man3/BIO_f_cipher.pod | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/man3/BIO_f_cipher.pod b/doc/man3/BIO_f_cipher.pod index 48f5536039..cb6b14a0c0 100644 --- a/doc/man3/BIO_f_cipher.pod +++ b/doc/man3/BIO_f_cipher.pod @@ -12,8 +12,8 @@ BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher #include <openssl/evp.h> const BIO_METHOD *BIO_f_cipher(void); - void BIO_set_cipher(BIO *b, const EVP_CIPHER *cipher, - unsigned char *key, unsigned char *iv, int enc); + int BIO_set_cipher(BIO *b, const EVP_CIPHER *cipher, + const unsigned char *key, const unsigned char *iv, int enc); int BIO_get_cipher_status(BIO *b); int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx); @@ -62,12 +62,12 @@ be achieved by preceding the cipher BIO with a buffering BIO. BIO_f_cipher() returns the cipher BIO method. -BIO_set_cipher() does not return a value. +BIO_set_cipher() returns 1 for success and 0 for failure. -BIO_get_cipher_status() returns 1 for a successful decrypt and 0 +BIO_get_cipher_status() returns 1 for a successful decrypt and <=0 for failure. -BIO_get_cipher_ctx() currently always returns 1. +BIO_get_cipher_ctx() returns 1 for success and <=0 for failure. =head1 COPYRIGHT |