Document the HMAC changes
[openssl.git] / doc / crypto / hmac.pod
1 =pod
2
3 =head1 NAME
4
5 HMAC, HMAC_CTX_new, HMAC_CTX_reset, HMAC_CTX_free, HMAC_Init, HMAC_Init_ex, HMAC_Update, HMAC_Final - HMAC message authentication code
6
7 =head1 SYNOPSIS
8
9  #include <openssl/hmac.h>
10
11  unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
12                int key_len, const unsigned char *d, int n,
13                unsigned char *md, unsigned int *md_len);
14
15  HMAC_CTX *HMAC_CTX_new(void);
16  int HMAC_CTX_reset(HMAC_CTX *ctx);
17
18  int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
19                const EVP_MD *md);
20  int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
21                    const EVP_MD *md, ENGINE *impl);
22  int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
23  int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
24
25  void HMAC_CTX_free(HMAC_CTX *ctx);
26
27 =head1 DESCRIPTION
28
29 HMAC is a MAC (message authentication code), i.e. a keyed hash
30 function used for message authentication, which is based on a hash
31 function.
32
33 HMAC() computes the message authentication code of the B<n> bytes at
34 B<d> using the hash function B<evp_md> and the key B<key> which is
35 B<key_len> bytes long.
36
37 It places the result in B<md> (which must have space for the output of
38 the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes).
39 If B<md> is NULL, the digest is placed in a static array.  The size of
40 the output is placed in B<md_len>, unless it is B<NULL>.
41
42 B<evp_md> can be EVP_sha1(), EVP_ripemd160() etc.
43
44 HMAC_CTX_new() creates a new HMAC_CTX in heap memory.
45
46 HMAC_CTX_reset() zeroes an existing B<HMAC_CTX> and associated
47 resources, making it suitable for new computations as if it was newly
48 created with HMAC_CTX_new().
49
50 HMAC_CTX_free() erases the key and other data from the B<HMAC_CTX>,
51 releases any associated resources and finally frees the B<HMAC_CTX>
52 itself.
53
54 The following functions may be used if the message is not completely
55 stored in memory:
56
57 HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash
58 function B<evp_md> and the key B<key> which is B<key_len> bytes
59 long. It is deprecated and only included for backward compatibility
60 with OpenSSL 0.9.6b.
61
62 HMAC_Init_ex() initializes or reuses a B<HMAC_CTX> structure to use
63 the function B<evp_md> and key B<key>. Either can be NULL, in which
64 case the existing one will be reused. B<ctx> must have been created
65 with HMAC_CTX_new() before the first use of an B<HMAC_CTX> in this
66 function. B<N.B. HMAC_Init() had this undocumented behaviour in
67 previous versions of OpenSSL - failure to switch to HMAC_Init_ex() in
68 programs that expect it will cause them to stop working>.
69
70 HMAC_Update() can be called repeatedly with chunks of the message to
71 be authenticated (B<len> bytes at B<data>).
72
73 HMAC_Final() places the message authentication code in B<md>, which
74 must have space for the hash function output.
75
76 =head1 RETURN VALUES
77
78 HMAC() returns a pointer to the message authentication code or NULL if
79 an error occurred.
80
81 HMAC_CTX_new() returns a pointer to a new B<HMAC_CTX> on success or
82 B<NULL> if an error occurred.
83
84 HMAC_CTX_reset(), HMAC_Init_ex(), HMAC_Update() and HMAC_Final() return 1
85 for success or 0 if an error occurred.
86
87 HMAC_CTX_free() do not return values.
88
89 =head1 CONFORMING TO
90
91 RFC 2104
92
93 =head1 SEE ALSO
94
95 L<sha(3)>, L<evp(3)>
96
97 =head1 HISTORY
98
99 HMAC_CTX_init() was replaced with HMAC_CTX_reset() in OpenSSL versions 1.1.
100
101 HMAC_CTX_cleanup() existed in OpenSSL versions before 1.1.
102
103 HMAC_CTX_new() and HMAC_CTX_free() are new in OpenSSL version 1.1.
104
105 HMAC_Init_ex(), HMAC_Update() and HMAC_Final() did not return values in
106 versions of OpenSSL before 1.0.0.
107
108 =cut