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