aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2015-11-27 14:19:27 +0100
committerRichard Levitte <levitte@openssl.org>2015-12-07 17:36:57 +0100
commit9b6c00707eae2cbce79479f4b1a5dc11019abca0 (patch)
treeddaa53f667c326bf9a78dad8ef023d8297740729 /doc
parentfa0c23de83efaf92da17cffce12444adbca48c89 (diff)
downloadopenssl-9b6c00707eae2cbce79479f4b1a5dc11019abca0.tar.gz
Document the changed HMAC API.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/hmac.pod10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/crypto/hmac.pod b/doc/crypto/hmac.pod
index 753617a4f1..203540f524 100644
--- a/doc/crypto/hmac.pod
+++ b/doc/crypto/hmac.pod
@@ -12,7 +12,7 @@ HMAC, HMAC_CTX_init, HMAC_Init, HMAC_Init_ex, HMAC_Update, HMAC_Final, HMAC_CTX_
int key_len, const unsigned char *d, int n,
unsigned char *md, unsigned int *md_len);
- void HMAC_CTX_init(HMAC_CTX *ctx);
+ int HMAC_CTX_init(HMAC_CTX *ctx);
int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
const EVP_MD *md);
@@ -74,10 +74,10 @@ must have space for the hash function output.
HMAC() returns a pointer to the message authentication code or NULL if
an error occurred.
-HMAC_Init_ex(), HMAC_Update() and HMAC_Final() return 1 for success or 0 if
-an error occurred.
+HMAC_CTX_init(), HMAC_Init_ex(), HMAC_Update() and HMAC_Final() return 1
+for success or 0 if an error occurred.
-HMAC_CTX_init() and HMAC_CTX_cleanup() do not return values.
+HMAC_CTX_cleanup() do not return values.
=head1 CONFORMING TO
@@ -89,6 +89,8 @@ L<sha(3)>, L<evp(3)>
=head1 HISTORY
+HMAC_CTX_init() did not return a value in OpenSSL versions before 1.1.
+
HMAC_Init_ex(), HMAC_Update() and HMAC_Final() did not return values in
versions of OpenSSL before 1.0.0.