Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / hmac.3
1 .rn '' }`
2 ''' $RCSfile$$Revision$$Date$
3 '''
4 ''' $Log$
5 '''
6 .de Sh
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve
30 .ft R
31
32 .fi
33 ..
34 '''
35 '''
36 '''     Set up \*(-- to give an unbreakable dash;
37 '''     string Tr holds user defined translation string.
38 '''     Bell System Logo is used as a dummy character.
39 '''
40 .tr \(*W-|\(bv\*(Tr
41 .ie n \{\
42 .ds -- \(*W-
43 .ds PI pi
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46 .ds L" ""
47 .ds R" ""
48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
50 '''   such as .IP and .SH, which do another additional levels of
51 '''   double-quote interpretation
52 .ds M" """
53 .ds S" """
54 .ds N" """""
55 .ds T" """""
56 .ds L' '
57 .ds R' '
58 .ds M' '
59 .ds S' '
60 .ds N' '
61 .ds T' '
62 'br\}
63 .el\{\
64 .ds -- \(em\|
65 .tr \*(Tr
66 .ds L" ``
67 .ds R" ''
68 .ds M" ``
69 .ds S" ''
70 .ds N" ``
71 .ds T" ''
72 .ds L' `
73 .ds R' '
74 .ds M' `
75 .ds S' '
76 .ds N' `
77 .ds T' '
78 .ds PI \(*p
79 'br\}
80 .\"     If the F register is turned on, we'll generate
81 .\"     index entries out stderr for the following things:
82 .\"             TH      Title 
83 .\"             SH      Header
84 .\"             Sh      Subsection 
85 .\"             Ip      Item
86 .\"             X<>     Xref  (embedded
87 .\"     Of course, you have to process the output yourself
88 .\"     in some meaninful fashion.
89 .if \nF \{
90 .de IX
91 .tm Index:\\$1\t\\n%\t"\\$2"
92 ..
93 .nr % 0
94 .rr F
95 .\}
96 .TH hmac 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97 .UC
98 .if n .hy 0
99 .if n .na
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101 .de CQ          \" put $1 in typewriter font
102 .ft CW
103 'if n "\c
104 'if t \\&\\$1\c
105 'if n \\&\\$1\c
106 'if n \&"
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108 '.ft R
109 ..
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111 .       \" AM - accent mark definitions
112 .bd B 3
113 .       \" fudge factors for nroff and troff
114 .if n \{\
115 .       ds #H 0
116 .       ds #V .8m
117 .       ds #F .3m
118 .       ds #[ \f1
119 .       ds #] \fP
120 .\}
121 .if t \{\
122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123 .       ds #V .6m
124 .       ds #F 0
125 .       ds #[ \&
126 .       ds #] \&
127 .\}
128 .       \" simple accents for nroff and troff
129 .if n \{\
130 .       ds ' \&
131 .       ds ` \&
132 .       ds ^ \&
133 .       ds , \&
134 .       ds ~ ~
135 .       ds ? ?
136 .       ds ! !
137 .       ds /
138 .       ds q
139 .\}
140 .if t \{\
141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150 .\}
151 .       \" troff and (daisy-wheel) nroff accents
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163 .ds ae a\h'-(\w'a'u*4/10)'e
164 .ds Ae A\h'-(\w'A'u*4/10)'E
165 .ds oe o\h'-(\w'o'u*4/10)'e
166 .ds Oe O\h'-(\w'O'u*4/10)'E
167 .       \" corrections for vroff
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170 .       \" for low resolution devices (crt and lpr)
171 .if \n(.H>23 .if \n(.V>19 \
172 \{\
173 .       ds : e
174 .       ds 8 ss
175 .       ds v \h'-1'\o'\(aa\(ga'
176 .       ds _ \h'-1'^
177 .       ds . \h'-1'.
178 .       ds 3 3
179 .       ds o a
180 .       ds d- d\h'-1'\(ga
181 .       ds D- D\h'-1'\(hy
182 .       ds th \o'bp'
183 .       ds Th \o'LP'
184 .       ds ae ae
185 .       ds Ae AE
186 .       ds oe oe
187 .       ds Oe OE
188 .\}
189 .rm #[ #] #H #V #F C
190 .SH "NAME"
191 HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup \- HMAC message
192 authentication code
193 .SH "SYNOPSIS"
194 .PP
195 .Vb 1
196 \& #include <openssl/hmac.h>
197 .Ve
198 .Vb 3
199 \& unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
200 \&               int key_len, const unsigned char *d, int n,
201 \&               unsigned char *md, unsigned int *md_len);
202 .Ve
203 .Vb 1
204 \& void HMAC_CTX_init(HMAC_CTX *ctx);
205 .Ve
206 .Vb 6
207 \& void HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
208 \&               const EVP_MD *md);
209 \& void HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
210 \&                   const EVP_MD *md);
211 \& void HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
212 \& void HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
213 .Ve
214 .Vb 2
215 \& void HMAC_CTX_cleanup(HMAC_CTX *ctx);
216 \& void HMAC_cleanup(HMAC_CTX *ctx);
217 .Ve
218 .SH "DESCRIPTION"
219 HMAC is a MAC (message authentication code), i.e. a keyed hash
220 function used for message authentication, which is based on a hash
221 function.
222 .PP
223 \fIHMAC()\fR computes the message authentication code of the \fBn\fR bytes at
224 \fBd\fR using the hash function \fBevp_md\fR and the key \fBkey\fR which is
225 \fBkey_len\fR bytes long.
226 .PP
227 It places the result in \fBmd\fR (which must have space for the output of
228 the hash function, which is no more than \fBEVP_MAX_MD_SIZE\fR bytes).
229 If \fBmd\fR is NULL, the digest is placed in a static array.  The size of
230 the output is placed in \fBmd_len\fR, unless it is \fBNULL\fR.
231 .PP
232 \fBevp_md\fR can be \fIEVP_sha1()\fR, \fIEVP_ripemd160()\fR etc.
233 \fBkey\fR and \fBevp_md\fR may be \fBNULL\fR if a key and hash function have
234 been set in a previous call to \fIHMAC_Init()\fR for that \fBHMAC_CTX\fR.
235 .PP
236 \fIHMAC_CTX_init()\fR initialises a \fBHMAC_CTX\fR before first use. It must be
237 called.
238 .PP
239 \fIHMAC_CTX_cleanup()\fR erases the key and other data from the \fBHMAC_CTX\fR
240 and releases any associated resources. It must be called when an
241 \fBHMAC_CTX\fR is no longer required.
242 .PP
243 \fIHMAC_cleanup()\fR is an alias for \fIHMAC_CTX_cleanup()\fR included for back
244 compatibility with 0.9.6b, it is deprecated.
245 .PP
246 The following functions may be used if the message is not completely
247 stored in memory:
248 .PP
249 \fIHMAC_Init()\fR initializes a \fBHMAC_CTX\fR structure to use the hash
250 function \fBevp_md\fR and the key \fBkey\fR which is \fBkey_len\fR bytes
251 long. It is deprecated and only included for backward compatibility
252 with OpenSSL 0.9.6b.
253 .PP
254 \fIHMAC_Init_ex()\fR initializes or reuses a \fBHMAC_CTX\fR structure to use
255 the function \fBevp_md\fR and key \fBkey\fR. Either can be NULL, in which
256 case the existing one will be reused. \fIHMAC_CTX_init()\fR must have been
257 called before the first use of an \fBHMAC_CTX\fR in this
258 function. \fBN.B. HMAC_Init() had this undocumented behaviour in
259 previous versions of OpenSSL \- failure to switch to HMAC_Init_ex() in
260 programs that expect it will cause them to stop working\fR.
261 .PP
262 \fIHMAC_Update()\fR can be called repeatedly with chunks of the message to
263 be authenticated (\fBlen\fR bytes at \fBdata\fR).
264 .PP
265 \fIHMAC_Final()\fR places the message authentication code in \fBmd\fR, which
266 must have space for the hash function output.
267 .SH "RETURN VALUES"
268 \fIHMAC()\fR returns a pointer to the message authentication code.
269 .PP
270 \fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and
271 \fIHMAC_CTX_cleanup()\fR do not return values.
272 .SH "CONFORMING TO"
273 RFC 2104
274 .SH "SEE ALSO"
275 sha(3), evp(3)
276 .SH "HISTORY"
277 \fIHMAC()\fR, \fIHMAC_Init()\fR, \fIHMAC_Update()\fR, \fIHMAC_Final()\fR and \fIHMAC_cleanup()\fR
278 are available since SSLeay 0.9.0.
279 .PP
280 \fIHMAC_CTX_init()\fR, \fIHMAC_Init_ex()\fR and \fIHMAC_CTX_cleanup()\fR are available
281 since OpenSSL 0.9.7.
282
283 .rn }` ''
284 .IX Title "hmac 3"
285 .IX Name "HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup - HMAC message
286 authentication code"
287
288 .IX Header "NAME"
289
290 .IX Header "SYNOPSIS"
291
292 .IX Header "DESCRIPTION"
293
294 .IX Header "RETURN VALUES"
295
296 .IX Header "CONFORMING TO"
297
298 .IX Header "SEE ALSO"
299
300 .IX Header "HISTORY"
301