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