openssl: Adjust manual pages for 1.0.1n.
[dragonfly.git] / secure / lib / libcrypto / man / hmac.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "hmac 3"
136 .TH hmac 3 "2015-06-11" "1.0.1n" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup \- HMAC message
143 authentication code
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 .Vb 1
147 \& #include <openssl/hmac.h>
148 \&
149 \& unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
150 \&               int key_len, const unsigned char *d, int n,
151 \&               unsigned char *md, unsigned int *md_len);
152 \&
153 \& void HMAC_CTX_init(HMAC_CTX *ctx);
154 \&
155 \& int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
156 \&               const EVP_MD *md);
157 \& int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
158 \&                   const EVP_MD *md, ENGINE *impl);
159 \& int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
160 \& int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
161 \&
162 \& void HMAC_CTX_cleanup(HMAC_CTX *ctx);
163 \& void HMAC_cleanup(HMAC_CTX *ctx);
164 .Ve
165 .SH "DESCRIPTION"
166 .IX Header "DESCRIPTION"
167 \&\s-1HMAC\s0 is a \s-1MAC \s0(message authentication code), i.e. a keyed hash
168 function used for message authentication, which is based on a hash
169 function.
170 .PP
171 \&\s-1\fIHMAC\s0()\fR computes the message authentication code of the \fBn\fR bytes at
172 \&\fBd\fR using the hash function \fBevp_md\fR and the key \fBkey\fR which is
173 \&\fBkey_len\fR bytes long.
174 .PP
175 It places the result in \fBmd\fR (which must have space for the output of
176 the hash function, which is no more than \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes).
177 If \fBmd\fR is \s-1NULL,\s0 the digest is placed in a static array.  The size of
178 the output is placed in \fBmd_len\fR, unless it is \fB\s-1NULL\s0\fR.
179 .PP
180 \&\fBevp_md\fR can be \fIEVP_sha1()\fR, \fIEVP_ripemd160()\fR etc.
181 .PP
182 \&\fIHMAC_CTX_init()\fR initialises a \fB\s-1HMAC_CTX\s0\fR before first use. It must be
183 called.
184 .PP
185 \&\fIHMAC_CTX_cleanup()\fR erases the key and other data from the \fB\s-1HMAC_CTX\s0\fR
186 and releases any associated resources. It must be called when an
187 \&\fB\s-1HMAC_CTX\s0\fR is no longer required.
188 .PP
189 \&\fIHMAC_cleanup()\fR is an alias for \fIHMAC_CTX_cleanup()\fR included for back
190 compatibility with 0.9.6b, it is deprecated.
191 .PP
192 The following functions may be used if the message is not completely
193 stored in memory:
194 .PP
195 \&\fIHMAC_Init()\fR initializes a \fB\s-1HMAC_CTX\s0\fR structure to use the hash
196 function \fBevp_md\fR and the key \fBkey\fR which is \fBkey_len\fR bytes
197 long. It is deprecated and only included for backward compatibility
198 with OpenSSL 0.9.6b.
199 .PP
200 \&\fIHMAC_Init_ex()\fR initializes or reuses a \fB\s-1HMAC_CTX\s0\fR structure to use
201 the function \fBevp_md\fR and key \fBkey\fR. Either can be \s-1NULL,\s0 in which
202 case the existing one will be reused. \fIHMAC_CTX_init()\fR must have been
203 called before the first use of an \fB\s-1HMAC_CTX\s0\fR in this
204 function. \fBN.B. \f(BIHMAC_Init()\fB had this undocumented behaviour in
205 previous versions of OpenSSL \- failure to switch to \f(BIHMAC_Init_ex()\fB in
206 programs that expect it will cause them to stop working\fR.
207 .PP
208 \&\fIHMAC_Update()\fR can be called repeatedly with chunks of the message to
209 be authenticated (\fBlen\fR bytes at \fBdata\fR).
210 .PP
211 \&\fIHMAC_Final()\fR places the message authentication code in \fBmd\fR, which
212 must have space for the hash function output.
213 .SH "RETURN VALUES"
214 .IX Header "RETURN VALUES"
215 \&\s-1\fIHMAC\s0()\fR returns a pointer to the message authentication code or \s-1NULL\s0 if
216 an error occurred.
217 .PP
218 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR return 1 for success or 0 if
219 an error occurred.
220 .PP
221 \&\fIHMAC_CTX_init()\fR and \fIHMAC_CTX_cleanup()\fR do not return values.
222 .SH "CONFORMING TO"
223 .IX Header "CONFORMING TO"
224 \&\s-1RFC 2104\s0
225 .SH "SEE ALSO"
226 .IX Header "SEE ALSO"
227 \&\fIsha\fR\|(3), \fIevp\fR\|(3)
228 .SH "HISTORY"
229 .IX Header "HISTORY"
230 \&\s-1\fIHMAC\s0()\fR, \fIHMAC_Init()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and \fIHMAC_cleanup()\fR
231 are available since SSLeay 0.9.0.
232 .PP
233 \&\fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR and \fIHMAC_CTX_cleanup()\fR are available
234 since OpenSSL 0.9.7.
235 .PP
236 \&\fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR and \fIHMAC_Final()\fR did not return values in
237 versions of OpenSSL before 1.0.0.