52b5a103aad9c2adad7a86206d7270d4d2080e85
[dragonfly.git] / secure / lib / libcrypto / man / EVP_DigestInit.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
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
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
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'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
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
107 .    \" corrections for vroff
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'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
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
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "EVP_DigestInit 3"
127 .TH EVP_DigestInit 3 "2014-06-05" "1.0.1h" "OpenSSL"
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
132 .SH "NAME"
133 EVP_MD_CTX_init, EVP_MD_CTX_create, EVP_DigestInit_ex, EVP_DigestUpdate,
134 EVP_DigestFinal_ex, EVP_MD_CTX_cleanup, EVP_MD_CTX_destroy, EVP_MAX_MD_SIZE,
135 EVP_MD_CTX_copy_ex, EVP_MD_CTX_copy, EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size,
136 EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size, EVP_MD_CTX_block_size, EVP_MD_CTX_type,
137 EVP_md_null, EVP_md2, EVP_md5, EVP_sha, EVP_sha1, EVP_sha224, EVP_sha256,
138 EVP_sha384, EVP_sha512, EVP_dss, EVP_dss1, EVP_mdc2,
139 EVP_ripemd160, EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj \-
140 EVP digest routines
141 .SH "SYNOPSIS"
142 .IX Header "SYNOPSIS"
143 .Vb 1
144 \& #include <openssl/evp.h>
145 \&
146 \& void EVP_MD_CTX_init(EVP_MD_CTX *ctx);
147 \& EVP_MD_CTX *EVP_MD_CTX_create(void);
148 \&
149 \& int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
150 \& int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
151 \& int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md,
152 \&        unsigned int *s);
153 \&
154 \& int EVP_MD_CTX_cleanup(EVP_MD_CTX *ctx);
155 \& void EVP_MD_CTX_destroy(EVP_MD_CTX *ctx);
156 \&
157 \& int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out,const EVP_MD_CTX *in);
158 \&
159 \& int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
160 \& int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
161 \&        unsigned int *s);
162 \&
163 \& int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
164 \&
165 \& #define EVP_MAX_MD_SIZE 64     /* SHA512 */
166 \&
167 \& int EVP_MD_type(const EVP_MD *md);
168 \& int EVP_MD_pkey_type(const EVP_MD *md);        
169 \& int EVP_MD_size(const EVP_MD *md);
170 \& int EVP_MD_block_size(const EVP_MD *md);
171 \&
172 \& const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
173 \& #define EVP_MD_CTX_size(e)             EVP_MD_size(EVP_MD_CTX_md(e))
174 \& #define EVP_MD_CTX_block_size(e)       EVP_MD_block_size((e)\->digest)
175 \& #define EVP_MD_CTX_type(e)             EVP_MD_type((e)\->digest)
176 \&
177 \& const EVP_MD *EVP_md_null(void);
178 \& const EVP_MD *EVP_md2(void);
179 \& const EVP_MD *EVP_md5(void);
180 \& const EVP_MD *EVP_sha(void);
181 \& const EVP_MD *EVP_sha1(void);
182 \& const EVP_MD *EVP_dss(void);
183 \& const EVP_MD *EVP_dss1(void);
184 \& const EVP_MD *EVP_mdc2(void);
185 \& const EVP_MD *EVP_ripemd160(void);
186 \&
187 \& const EVP_MD *EVP_sha224(void);
188 \& const EVP_MD *EVP_sha256(void);
189 \& const EVP_MD *EVP_sha384(void);
190 \& const EVP_MD *EVP_sha512(void);
191 \&
192 \& const EVP_MD *EVP_get_digestbyname(const char *name);
193 \& #define EVP_get_digestbynid(a) EVP_get_digestbyname(OBJ_nid2sn(a))
194 \& #define EVP_get_digestbyobj(a) EVP_get_digestbynid(OBJ_obj2nid(a))
195 .Ve
196 .SH "DESCRIPTION"
197 .IX Header "DESCRIPTION"
198 The \s-1EVP\s0 digest routines are a high level interface to message digests.
199 .PP
200 \&\fIEVP_MD_CTX_init()\fR initializes digest context \fBctx\fR.
201 .PP
202 \&\fIEVP_MD_CTX_create()\fR allocates, initializes and returns a digest context.
203 .PP
204 \&\fIEVP_DigestInit_ex()\fR sets up digest context \fBctx\fR to use a digest
205 \&\fBtype\fR from \s-1ENGINE\s0 \fBimpl\fR. \fBctx\fR must be initialized before calling this
206 function. \fBtype\fR will typically be supplied by a functionsuch as \fIEVP_sha1()\fR.
207 If \fBimpl\fR is \s-1NULL\s0 then the default implementation of digest \fBtype\fR is used.
208 .PP
209 \&\fIEVP_DigestUpdate()\fR hashes \fBcnt\fR bytes of data at \fBd\fR into the
210 digest context \fBctx\fR. This function can be called several times on the
211 same \fBctx\fR to hash additional data.
212 .PP
213 \&\fIEVP_DigestFinal_ex()\fR retrieves the digest value from \fBctx\fR and places
214 it in \fBmd\fR. If the \fBs\fR parameter is not \s-1NULL\s0 then the number of
215 bytes of data written (i.e. the length of the digest) will be written
216 to the integer at \fBs\fR, at most \fB\s-1EVP_MAX_MD_SIZE\s0\fR bytes will be written.
217 After calling \fIEVP_DigestFinal_ex()\fR no additional calls to \fIEVP_DigestUpdate()\fR
218 can be made, but \fIEVP_DigestInit_ex()\fR can be called to initialize a new
219 digest operation.
220 .PP
221 \&\fIEVP_MD_CTX_cleanup()\fR cleans up digest context \fBctx\fR, it should be called
222 after a digest context is no longer needed.
223 .PP
224 \&\fIEVP_MD_CTX_destroy()\fR cleans up digest context \fBctx\fR and frees up the
225 space allocated to it, it should be called only on a context created
226 using \fIEVP_MD_CTX_create()\fR.
227 .PP
228 \&\fIEVP_MD_CTX_copy_ex()\fR can be used to copy the message digest state from
229 \&\fBin\fR to \fBout\fR. This is useful if large amounts of data are to be
230 hashed which only differ in the last few bytes. \fBout\fR must be initialized
231 before calling this function.
232 .PP
233 \&\fIEVP_DigestInit()\fR behaves in the same way as \fIEVP_DigestInit_ex()\fR except
234 the passed context \fBctx\fR does not have to be initialized, and it always
235 uses the default digest implementation.
236 .PP
237 \&\fIEVP_DigestFinal()\fR is similar to \fIEVP_DigestFinal_ex()\fR except the digest
238 context \fBctx\fR is automatically cleaned up.
239 .PP
240 \&\fIEVP_MD_CTX_copy()\fR is similar to \fIEVP_MD_CTX_copy_ex()\fR except the destination
241 \&\fBout\fR does not have to be initialized.
242 .PP
243 \&\fIEVP_MD_size()\fR and \fIEVP_MD_CTX_size()\fR return the size of the message digest
244 when passed an \fB\s-1EVP_MD\s0\fR or an \fB\s-1EVP_MD_CTX\s0\fR structure, i.e. the size of the
245 hash.
246 .PP
247 \&\fIEVP_MD_block_size()\fR and \fIEVP_MD_CTX_block_size()\fR return the block size of the
248 message digest when passed an \fB\s-1EVP_MD\s0\fR or an \fB\s-1EVP_MD_CTX\s0\fR structure.
249 .PP
250 \&\fIEVP_MD_type()\fR and \fIEVP_MD_CTX_type()\fR return the \s-1NID\s0 of the \s-1OBJECT\s0 \s-1IDENTIFIER\s0
251 representing the given message digest when passed an \fB\s-1EVP_MD\s0\fR structure.
252 For example EVP_MD_type(\fIEVP_sha1()\fR) returns \fBNID_sha1\fR. This function is
253 normally used when setting \s-1ASN1\s0 OIDs.
254 .PP
255 \&\fIEVP_MD_CTX_md()\fR returns the \fB\s-1EVP_MD\s0\fR structure corresponding to the passed
256 \&\fB\s-1EVP_MD_CTX\s0\fR.
257 .PP
258 \&\fIEVP_MD_pkey_type()\fR returns the \s-1NID\s0 of the public key signing algorithm associated
259 with this digest. For example \fIEVP_sha1()\fR is associated with \s-1RSA\s0 so this will
260 return \fBNID_sha1WithRSAEncryption\fR. Since digests and signature algorithms
261 are no longer linked this function is only retained for compatibility
262 reasons.
263 .PP
264 \&\fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_sha224()\fR, \fIEVP_sha256()\fR,
265 \&\fIEVP_sha384()\fR, \fIEVP_sha512()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR return \fB\s-1EVP_MD\s0\fR
266 structures for the \s-1MD2\s0, \s-1MD5\s0, \s-1SHA\s0, \s-1SHA1\s0, \s-1SHA224\s0, \s-1SHA256\s0, \s-1SHA384\s0, \s-1SHA512\s0, \s-1MDC2\s0
267 and \s-1RIPEMD160\s0 digest algorithms respectively.
268 .PP
269 \&\fIEVP_dss()\fR and \fIEVP_dss1()\fR return \fB\s-1EVP_MD\s0\fR structures for \s-1SHA\s0 and \s-1SHA1\s0 digest
270 algorithms but using \s-1DSS\s0 (\s-1DSA\s0) for the signature algorithm. Note: there is
271 no need to use these pseudo-digests in OpenSSL 1.0.0 and later, they are
272 however retained for compatibility.
273 .PP
274 \&\fIEVP_md_null()\fR is a \*(L"null\*(R" message digest that does nothing: i.e. the hash it
275 returns is of zero length.
276 .PP
277 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
278 return an \fB\s-1EVP_MD\s0\fR structure when passed a digest name, a digest \s-1NID\s0 or
279 an \s-1ASN1_OBJECT\s0 structure respectively. The digest table must be initialized
280 using, for example, \fIOpenSSL_add_all_digests()\fR for these functions to work.
281 .SH "RETURN VALUES"
282 .IX Header "RETURN VALUES"
283 \&\fIEVP_DigestInit_ex()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal_ex()\fR return 1 for
284 success and 0 for failure.
285 .PP
286 \&\fIEVP_MD_CTX_copy_ex()\fR returns 1 if successful or 0 for failure.
287 .PP
288 \&\fIEVP_MD_type()\fR, \fIEVP_MD_pkey_type()\fR and \fIEVP_MD_type()\fR return the \s-1NID\s0 of the
289 corresponding \s-1OBJECT\s0 \s-1IDENTIFIER\s0 or NID_undef if none exists.
290 .PP
291 \&\fIEVP_MD_size()\fR, \fIEVP_MD_block_size()\fR, \fIEVP_MD_CTX_size()\fR and
292 \&\fIEVP_MD_CTX_block_size()\fR return the digest or block size in bytes.
293 .PP
294 \&\fIEVP_md_null()\fR, \fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR, \fIEVP_dss()\fR,
295 \&\fIEVP_dss1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR return pointers to the
296 corresponding \s-1EVP_MD\s0 structures.
297 .PP
298 \&\fIEVP_get_digestbyname()\fR, \fIEVP_get_digestbynid()\fR and \fIEVP_get_digestbyobj()\fR
299 return either an \fB\s-1EVP_MD\s0\fR structure or \s-1NULL\s0 if an error occurs.
300 .SH "NOTES"
301 .IX Header "NOTES"
302 The \fB\s-1EVP\s0\fR interface to message digests should almost always be used in
303 preference to the low level interfaces. This is because the code then becomes
304 transparent to the digest used and much more flexible.
305 .PP
306 New applications should use the \s-1SHA2\s0 digest algorithms such as \s-1SHA256\s0.
307 The other digest algorithms are still in common use.
308 .PP
309 For most applications the \fBimpl\fR parameter to \fIEVP_DigestInit_ex()\fR will be
310 set to \s-1NULL\s0 to use the default digest implementation.
311 .PP
312 The functions \fIEVP_DigestInit()\fR, \fIEVP_DigestFinal()\fR and \fIEVP_MD_CTX_copy()\fR are
313 obsolete but are retained to maintain compatibility with existing code. New
314 applications should use \fIEVP_DigestInit_ex()\fR, \fIEVP_DigestFinal_ex()\fR and
315 \&\fIEVP_MD_CTX_copy_ex()\fR because they can efficiently reuse a digest context
316 instead of initializing and cleaning it up on each call and allow non default
317 implementations of digests to be specified.
318 .PP
319 In OpenSSL 0.9.7 and later if digest contexts are not cleaned up after use
320 memory leaks will occur.
321 .PP
322 Stack allocation of \s-1EVP_MD_CTX\s0 structures is common, for example:
323 .PP
324 .Vb 2
325 \& EVP_MD_CTX mctx;
326 \& EVP_MD_CTX_init(&mctx);
327 .Ve
328 .PP
329 This will cause binary compatibility issues if the size of \s-1EVP_MD_CTX\s0
330 structure changes (this will only happen with a major release of OpenSSL).
331 Applications wishing to avoid this should use \fIEVP_MD_CTX_create()\fR instead:
332 .PP
333 .Vb 2
334 \& EVP_MD_CTX *mctx;
335 \& mctx = EVP_MD_CTX_create();
336 .Ve
337 .SH "EXAMPLE"
338 .IX Header "EXAMPLE"
339 This example digests the data \*(L"Test Message\en\*(R" and \*(L"Hello World\en\*(R", using the
340 digest name passed on the command line.
341 .PP
342 .Vb 2
343 \& #include <stdio.h>
344 \& #include <openssl/evp.h>
345 \&
346 \& main(int argc, char *argv[])
347 \& {
348 \& EVP_MD_CTX *mdctx;
349 \& const EVP_MD *md;
350 \& char mess1[] = "Test Message\en";
351 \& char mess2[] = "Hello World\en";
352 \& unsigned char md_value[EVP_MAX_MD_SIZE];
353 \& int md_len, i;
354 \&
355 \& OpenSSL_add_all_digests();
356 \&
357 \& if(!argv[1]) {
358 \&        printf("Usage: mdtest digestname\en");
359 \&        exit(1);
360 \& }
361 \&
362 \& md = EVP_get_digestbyname(argv[1]);
363 \&
364 \& if(!md) {
365 \&        printf("Unknown message digest %s\en", argv[1]);
366 \&        exit(1);
367 \& }
368 \&
369 \& mdctx = EVP_MD_CTX_create();
370 \& EVP_DigestInit_ex(mdctx, md, NULL);
371 \& EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
372 \& EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
373 \& EVP_DigestFinal_ex(mdctx, md_value, &md_len);
374 \& EVP_MD_CTX_destroy(mdctx);
375 \&
376 \& printf("Digest is: ");
377 \& for(i = 0; i < md_len; i++)
378 \&        printf("%02x", md_value[i]);
379 \& printf("\en");
380 \&
381 \& /* Call this once before exit. */
382 \& EVP_cleanup();
383 \& exit(0);
384 \& }
385 .Ve
386 .SH "SEE ALSO"
387 .IX Header "SEE ALSO"
388 \&\fIdgst\fR\|(1),
389 \&\fIevp\fR\|(3)
390 .SH "HISTORY"
391 .IX Header "HISTORY"
392 \&\fIEVP_DigestInit()\fR, \fIEVP_DigestUpdate()\fR and \fIEVP_DigestFinal()\fR are
393 available in all versions of SSLeay and OpenSSL.
394 .PP
395 \&\fIEVP_MD_CTX_init()\fR, \fIEVP_MD_CTX_create()\fR, \fIEVP_MD_CTX_copy_ex()\fR,
396 \&\fIEVP_MD_CTX_cleanup()\fR, \fIEVP_MD_CTX_destroy()\fR, \fIEVP_DigestInit_ex()\fR
397 and \fIEVP_DigestFinal_ex()\fR were added in OpenSSL 0.9.7.
398 .PP
399 \&\fIEVP_md_null()\fR, \fIEVP_md2()\fR, \fIEVP_md5()\fR, \fIEVP_sha()\fR, \fIEVP_sha1()\fR,
400 \&\fIEVP_dss()\fR, \fIEVP_dss1()\fR, \fIEVP_mdc2()\fR and \fIEVP_ripemd160()\fR were
401 changed to return truely const \s-1EVP_MD\s0 * in OpenSSL 0.9.7.
402 .PP
403 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
404 later, so now \fIEVP_sha1()\fR can be used with \s-1RSA\s0 and \s-1DSA\s0; there is no need to
405 use \fIEVP_dss1()\fR any more.
406 .PP
407 OpenSSL 1.0 and later does not include the \s-1MD2\s0 digest algorithm in the
408 default configuration due to its security weaknesses.