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