diff options
author | Nick Mathewson <nickm@torproject.org> | 2018-05-16 11:07:48 -0400 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2018-05-26 08:36:42 +0200 |
commit | bbbf752a3c8b5a966bcb48fc71a3dc03832e7b27 (patch) | |
tree | c843bb59a3daa861762a4ed3228d0ef169b11448 | |
parent | 1bb829300a9a941b75e8d5ae6ea8f53b3845ac4c (diff) |
Update documentation for PEM callback: error is now -1.
In previous versions of OpenSSL, the documentation for PEM_read_*
said:
The callback B<must> return the number of characters in the
passphrase or 0 if an error occurred.
But since c82c3462267afdbbaa5, 0 is now treated as a non-error
return value. Applications that want to indicate an error need to
return -1 instead.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6271)
-rw-r--r-- | doc/man3/PEM_read_bio_PrivateKey.pod | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/man3/PEM_read_bio_PrivateKey.pod b/doc/man3/PEM_read_bio_PrivateKey.pod index 9f62140ce6..4fb4d1159a 100644 --- a/doc/man3/PEM_read_bio_PrivateKey.pod +++ b/doc/man3/PEM_read_bio_PrivateKey.pod @@ -295,7 +295,7 @@ for it twice) if B<rwflag> is 1. The B<u> parameter has the same value as the B<u> parameter passed to the PEM routine. It allows arbitrary data to be passed to the callback by the application (for example a window handle in a GUI application). The callback -B<must> return the number of characters in the passphrase or 0 if +B<must> return the number of characters in the passphrase or -1 if an error occurred. =head1 EXAMPLES |