5 EVP_MD_fetch, EVP_MD_up_ref, EVP_MD_free,
6 EVP_MD_get_params, EVP_MD_gettable_params,
7 EVP_MD_CTX_new, EVP_MD_CTX_reset, EVP_MD_CTX_free, EVP_MD_CTX_copy,
8 EVP_MD_CTX_copy_ex, EVP_MD_CTX_ctrl,
9 EVP_MD_CTX_set_params, EVP_MD_CTX_get_params,
10 EVP_MD_settable_ctx_params, EVP_MD_gettable_ctx_params,
11 EVP_MD_CTX_settable_params, EVP_MD_CTX_gettable_params,
12 EVP_MD_CTX_set_flags, EVP_MD_CTX_clear_flags, EVP_MD_CTX_test_flags,
13 EVP_Digest, EVP_DigestInit_ex, EVP_DigestInit, EVP_DigestUpdate,
14 EVP_DigestFinal_ex, EVP_DigestFinalXOF, EVP_DigestFinal,
15 EVP_MD_is_a, EVP_MD_name, EVP_MD_number, EVP_MD_names_do_all, EVP_MD_provider,
16 EVP_MD_type, EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size, EVP_MD_flags,
18 EVP_MD_CTX_md, EVP_MD_CTX_type, EVP_MD_CTX_size, EVP_MD_CTX_block_size,
19 EVP_MD_CTX_md_data, EVP_MD_CTX_update_fn, EVP_MD_CTX_set_update_fn,
21 EVP_get_digestbyname, EVP_get_digestbynid, EVP_get_digestbyobj,
22 EVP_MD_CTX_pkey_ctx, EVP_MD_CTX_set_pkey_ctx,
23 EVP_MD_do_all_provided
28 #include <openssl/evp.h>
30 EVP_MD *EVP_MD_fetch(OPENSSL_CTX *ctx, const char *algorithm,
31 const char *properties);
32 int EVP_MD_up_ref(EVP_MD *md);
33 void EVP_MD_free(EVP_MD *md);
34 int EVP_MD_get_params(const EVP_MD *digest, OSSL_PARAM params[]);
35 const OSSL_PARAM *EVP_MD_gettable_params(const EVP_MD *digest);
36 EVP_MD_CTX *EVP_MD_CTX_new(void);
37 int EVP_MD_CTX_reset(EVP_MD_CTX *ctx);
38 void EVP_MD_CTX_free(EVP_MD_CTX *ctx);
39 void EVP_MD_CTX_ctrl(EVP_MD_CTX *ctx, int cmd, int p1, void* p2);
40 int EVP_MD_CTX_get_params(EVP_MD_CTX *ctx, OSSL_PARAM params[]);
41 int EVP_MD_CTX_set_params(EVP_MD_CTX *ctx, const OSSL_PARAM params[]);
42 const OSSL_PARAM *EVP_MD_settable_ctx_params(const EVP_MD *md);
43 const OSSL_PARAM *EVP_MD_gettable_ctx_params(const EVP_MD *md);
44 const OSSL_PARAM *EVP_MD_CTX_settable_params(EVP_MD_CTX *ctx);
45 const OSSL_PARAM *EVP_MD_CTX_gettable_params(EVP_MD_CTX *ctx);
46 void EVP_MD_CTX_set_flags(EVP_MD_CTX *ctx, int flags);
47 void EVP_MD_CTX_clear_flags(EVP_MD_CTX *ctx, int flags);
48 int EVP_MD_CTX_test_flags(const EVP_MD_CTX *ctx, int flags);
50 int EVP_Digest(const void *data, size_t count, unsigned char *md,
51 unsigned int *size, const EVP_MD *type, ENGINE *impl);
52 int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
53 int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
54 int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);
55 int EVP_DigestFinalXOF(EVP_MD_CTX *ctx, unsigned char *md, size_t len);
57 int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
59 int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
60 int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md, unsigned int *s);
62 int EVP_MD_CTX_copy(EVP_MD_CTX *out, EVP_MD_CTX *in);
64 const char *EVP_MD_name(const EVP_MD *md);
65 int EVP_MD_number(const EVP_MD *md);
66 int EVP_MD_is_a(const EVP_MD *md, const char *name);
67 void EVP_MD_names_do_all(const EVP_MD *md,
68 void (*fn)(const char *name, void *data),
70 const OSSL_PROVIDER *EVP_MD_provider(const EVP_MD *md);
71 int EVP_MD_type(const EVP_MD *md);
72 int EVP_MD_pkey_type(const EVP_MD *md);
73 int EVP_MD_size(const EVP_MD *md);
74 int EVP_MD_block_size(const EVP_MD *md);
75 unsigned long EVP_MD_flags(const EVP_MD *md);
77 const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
78 const char *EVP_MD_CTX_name(const EVP_MD_CTX *ctx);
79 int EVP_MD_CTX_size(const EVP_MD_CTX *ctx);
80 int EVP_MD_CTX_block_size(const EVP_MD_CTX *ctx);
81 int EVP_MD_CTX_type(const EVP_MD_CTX *ctx);
82 void *EVP_MD_CTX_md_data(const EVP_MD_CTX *ctx);
83 int (*EVP_MD_CTX_update_fn(EVP_MD_CTX *ctx))(EVP_MD_CTX *ctx,
84 const void *data, size_t count);
85 void EVP_MD_CTX_set_update_fn(EVP_MD_CTX *ctx,
86 int (*update)(EVP_MD_CTX *ctx,
87 const void *data, size_t count));
89 const EVP_MD *EVP_md_null(void);
91 const EVP_MD *EVP_get_digestbyname(const char *name);
92 const EVP_MD *EVP_get_digestbynid(int type);
93 const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *o);
95 EVP_PKEY_CTX *EVP_MD_CTX_pkey_ctx(const EVP_MD_CTX *ctx);
96 void EVP_MD_CTX_set_pkey_ctx(EVP_MD_CTX *ctx, EVP_PKEY_CTX *pctx);
98 void EVP_MD_do_all_provided(OPENSSL_CTX *libctx,
99 void (*fn)(EVP_MD *mac, void *arg),
104 The EVP digest routines are a high level interface to message digests,
105 and should be used instead of the digest-specific functions.
107 The B<EVP_MD> type is a structure for digest method implementation.
113 Fetches the digest implementation for the given B<algorithm> from any
114 provider offering it, within the criteria given by the B<properties>.
115 See L<provider(7)/Fetching algorithms> for further information.
117 The returned value must eventually be freed with EVP_MD_free().
119 Fetched B<EVP_MD> structures are reference counted.
121 =item EVP_MD_up_ref()
123 Increments the reference count for an B<EVP_MD> structure.
127 Decrements the reference count for the fetched B<EVP_MD> structure.
128 If the reference count drops to 0 then the structure is freed.
130 =item EVP_MD_CTX_new()
132 Allocates and returns a digest context.
134 =item EVP_MD_CTX_reset()
136 Resets the digest context B<ctx>. This can be used to reuse an already
139 =item EVP_MD_CTX_free()
141 Cleans up digest context B<ctx> and frees up the space allocated to it.
143 =item EVP_MD_CTX_ctrl()
145 This is a legacy method. EVP_MD_CTX_set_params() and EVP_MD_CTX_get_params()
146 is the mechanism that should be used to set and get parameters that are used by
148 Performs digest-specific control actions on context B<ctx>. The control command
149 is indicated in B<cmd> and any additional arguments in B<p1> and B<p2>.
150 EVP_MD_CTX_ctrl() must be called after EVP_DigestInit_ex(). Other restrictions
151 may apply depending on the control type and digest implementation.
152 See L</CONTROLS> below for more information.
154 =item EVP_MD_get_params()
156 Retrieves the requested list of B<params> from a MD B<md>.
157 See L</PARAMETERS> below for more information.
159 =item EVP_MD_CTX_get_params()
161 Retrieves the requested list of B<params> from a MD context B<ctx>.
162 See L</PARAMETERS> below for more information.
164 =item EVP_MD_CTX_set_params()
166 Sets the list of B<params> into a MD context B<ctx>.
167 See L</PARAMETERS> below for more information.
169 =item EVP_MD_gettable_params(), EVP_MD_gettable_ctx_params(),
170 EVP_MD_settable_ctx_params(), EVP_MD_CTX_gettable_params(),
171 EVP_MD_CTX_settable_params()
173 Get a B<OSSL_PARAM> array that describes the retrievable and settable
174 parameters. EVP_MD_gettable_params() returns parameters that can be used with
175 EVP_MD_get_params(). EVP_MD_gettable_ctx_params() and
176 EVP_MD_CTX_gettable_params() return parameters that can be used with
177 EVP_MD_CTX_get_params(). EVP_MD_settable_ctx_params() and
178 EVP_MD_CTX_settable_params() return parameters that can be used with
179 EVP_MD_CTX_set_params().
180 See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor.
182 =item EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags(), EVP_MD_CTX_test_flags()
184 Sets, clears and tests B<ctx> flags. See L</FLAGS> below for more information.
188 A wrapper around the Digest Init_ex, Update and Final_ex functions.
189 Hashes B<count> bytes of data at B<data> using a digest B<type> from ENGINE
190 B<impl>. The digest value is placed in B<md> and its length is written at B<size>
191 if the pointer is not NULL. At most B<EVP_MAX_MD_SIZE> bytes will be written.
192 If B<impl> is NULL the default implementation of digest B<type> is used.
194 =item EVP_DigestInit_ex()
196 Sets up digest context B<ctx> to use a digest B<type>.
197 B<type> is typically supplied by a function such as EVP_sha1(), or a
198 value explicitly fetched with EVP_MD_fetch().
200 If B<impl> is non-NULL, its implementation of the digest B<type> is used if
201 there is one, and if not, the default implementation is used.
203 =item EVP_DigestUpdate()
205 Hashes B<cnt> bytes of data at B<d> into the digest context B<ctx>. This
206 function can be called several times on the same B<ctx> to hash additional
209 =item EVP_DigestFinal_ex()
211 Retrieves the digest value from B<ctx> and places it in B<md>. If the B<s>
212 parameter is not NULL then the number of bytes of data written (i.e. the
213 length of the digest) will be written to the integer at B<s>, at most
214 B<EVP_MAX_MD_SIZE> bytes will be written. After calling EVP_DigestFinal_ex()
215 no additional calls to EVP_DigestUpdate() can be made, but
216 EVP_DigestInit_ex() can be called to initialize a new digest operation.
218 =item EVP_DigestFinalXOF()
220 Interfaces to extendable-output functions, XOFs, such as SHAKE128 and SHAKE256.
221 It retrieves the digest value from B<ctx> and places it in B<len>-sized <B>md.
222 After calling this function no additional calls to EVP_DigestUpdate() can be
223 made, but EVP_DigestInit_ex() can be called to initialize a new operation.
225 =item EVP_MD_CTX_copy_ex()
227 Can be used to copy the message digest state from B<in> to B<out>. This is
228 useful if large amounts of data are to be hashed which only differ in the last
231 =item EVP_DigestInit()
233 Behaves in the same way as EVP_DigestInit_ex() except it always uses the
234 default digest implementation and calls EVP_MD_CTX_reset().
236 =item EVP_DigestFinal()
238 Similar to EVP_DigestFinal_ex() except the digest context B<ctx> is
239 automatically cleaned up.
241 =item EVP_MD_CTX_copy()
243 Similar to EVP_MD_CTX_copy_ex() except the destination B<out> does not have to
248 Returns 1 if I<md> is an implementation of an algorithm that's
249 identifiable with I<name>, otherwise 0.
251 =item EVP_MD_number()
253 Returns the internal dynamic number assigned to the I<md>. This is
254 only useful with fetched B<EVP_MD>s.
259 Return the name of the given message digest. For fetched message
260 digests with multiple names, only one of them is returned; it's
261 recommended to use EVP_MD_names_do_all() instead.
263 =item EVP_MD_names_do_all()
265 Traverses all names for the I<md>, and calls I<fn> with each name and
266 I<data>. This is only useful with fetched B<EVP_MD>s.
268 =item EVP_MD_provider()
270 Returns an B<OSSL_PROVIDER> pointer to the provider that implements the given
276 Return the size of the message digest when passed an B<EVP_MD> or an
277 B<EVP_MD_CTX> structure, i.e. the size of the hash.
279 =item EVP_MD_block_size(),
280 EVP_MD_CTX_block_size()
282 Return the block size of the message digest when passed an B<EVP_MD> or an
283 B<EVP_MD_CTX> structure.
288 Return the NID of the OBJECT IDENTIFIER representing the given message digest
289 when passed an B<EVP_MD> structure. For example, C<EVP_MD_type(EVP_sha1())>
290 returns B<NID_sha1>. This function is normally used when setting ASN1 OIDs.
292 =item EVP_MD_CTX_md_data()
294 Return the digest method private data for the passed B<EVP_MD_CTX>.
295 The space is allocated by OpenSSL and has the size originally set with
296 EVP_MD_meth_set_app_datasize().
298 =item EVP_MD_CTX_md()
300 Returns the B<EVP_MD> structure corresponding to the passed B<EVP_MD_CTX>. This
301 will be the same B<EVP_MD> object originally passed to EVP_DigestInit_ex() (or
302 other similar function) when the EVP_MD_CTX was first initialised. Note that
303 where explicit fetch is in use (see L<EVP_MD_fetch(3)>) the value returned from
304 this function will not have its reference count incremented and therefore it
305 should not be used after the EVP_MD_CTX is freed.
307 =item EVP_MD_CTX_set_update_fn()
309 Sets the update function for B<ctx> to B<update>.
310 This is the function that is called by EVP_DigestUpdate. If not set, the
311 update function from the B<EVP_MD> type specified at initialization is used.
313 =item EVP_MD_CTX_update_fn()
315 Returns the update function for B<ctx>.
319 Returns the B<md> flags. Note that these are different from the B<EVP_MD_CTX>
320 ones. See L<EVP_MD_meth_set_flags(3)> for more information.
322 =item EVP_MD_pkey_type()
324 Returns the NID of the public key signing algorithm associated with this
325 digest. For example EVP_sha1() is associated with RSA so this will return
326 B<NID_sha1WithRSAEncryption>. Since digests and signature algorithms are no
327 longer linked this function is only retained for compatibility reasons.
331 A "null" message digest that does nothing: i.e. the hash it returns is of zero
334 =item EVP_get_digestbyname(),
335 EVP_get_digestbynid(),
336 EVP_get_digestbyobj()
338 Returns an B<EVP_MD> structure when passed a digest name, a digest B<NID> or an
339 B<ASN1_OBJECT> structure respectively.
341 =item EVP_MD_CTX_pkey_ctx()
343 Returns the B<EVP_PKEY_CTX> assigned to B<ctx>. The returned pointer should not
344 be freed by the caller.
346 =item EVP_MD_CTX_set_pkey_ctx()
348 Assigns an B<EVP_PKEY_CTX> to B<EVP_MD_CTX>. This is usually used to provide
349 a customized B<EVP_PKEY_CTX> to L<EVP_DigestSignInit(3)> or
350 L<EVP_DigestVerifyInit(3)>. The B<pctx> passed to this function should be freed
351 by the caller. A NULL B<pctx> pointer is also allowed to clear the B<EVP_PKEY_CTX>
352 assigned to B<ctx>. In such case, freeing the cleared B<EVP_PKEY_CTX> or not
353 depends on how the B<EVP_PKEY_CTX> is created.
355 =item EVP_MD_do_all_provided()
357 Traverses all messages digests implemented by all activated providers
358 in the given library context I<libctx>, and for each of the implementations,
359 calls the given function I<fn> with the implementation method and the given
366 See L<OSSL_PARAM(3)> for information about passing parameters.
368 EVP_MD_CTX_set_params() can be used with the following OSSL_PARAM keys:
372 =item "xoflen" (B<OSSL_PARAM_DIGEST_KEY_XOFLEN>) <unsigned integer>
374 Sets the digest length for extendable output functions.
375 It is used by the SHAKE algorithm and should not exceed what can be given
378 =item "pad_type" (B<OSSL_PARAM_DIGEST_KEY_PAD_TYPE>) <integer>
381 It is used by the MDC2 algorithm.
385 EVP_MD_CTX_get_params() can be used with the following OSSL_PARAM keys:
389 =item "micalg" (B<OSSL_PARAM_DIGEST_KEY_MICALG>) <UTF8 string>.
391 Gets the digest Message Integrity Check algorithm string. This is used when
392 creating S/MIME multipart/signed messages, as specified in RFC 3851.
393 It may be used by external engines or providers.
399 EVP_MD_CTX_ctrl() can be used to send the following standard controls:
403 =item EVP_MD_CTRL_MICALG
405 Gets the digest Message Integrity Check algorithm string. This is used when
406 creating S/MIME multipart/signed messages, as specified in RFC 3851.
407 The string value is written to B<p2>.
409 =item EVP_MD_CTRL_XOF_LEN
411 This control sets the digest length for extendable output functions to B<p1>.
412 Sending this control directly should not be necessary, the use of
413 C<EVP_DigestFinalXOF()> is preferred.
414 Currently used by SHAKE.
420 EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags() and EVP_MD_CTX_test_flags()
421 can be used the manipulate and test these B<EVP_MD_CTX> flags:
425 =item EVP_MD_CTX_FLAG_ONESHOT
427 This flag instructs the digest to optimize for one update only, if possible.
429 =for comment EVP_MD_CTX_FLAG_CLEANED is internal, don't mention it
431 =for comment EVP_MD_CTX_FLAG_REUSE is internal, don't mention it
433 =for comment We currently avoid documenting flags that are only bit holder:
434 EVP_MD_CTX_FLAG_NON_FIPS_ALLOW, EVP_MD_CTX_FLAGS_PAD_*
436 =item EVP_MD_CTX_FLAG_NO_INIT
438 This flag instructs EVP_DigestInit() and similar not to initialise the
439 implementation specific data.
441 =item EVP_MD_CTX_FLAG_FINALISE
443 Some functions such as EVP_DigestSign only finalise copies of internal
444 contexts so additional data can be included after the finalisation call.
445 This is inefficient if this functionality is not required, and can be
446 disabled with this flag.
456 Returns a pointer to a B<EVP_MD> for success or NULL for failure.
458 =item EVP_MD_up_ref()
460 Returns 1 for success or 0 for failure.
462 =item EVP_DigestInit_ex(),
467 success and 0 for failure.
469 =item EVP_MD_CTX_ctrl()
471 Returns 1 if successful or 0 for failure.
473 =item EVP_MD_CTX_set_params(),
474 EVP_MD_CTX_get_params()
476 Returns 1 if successful or 0 for failure.
478 =item EVP_MD_CTX_settable_params(),
479 EVP_MD_CTX_gettable_params()
481 Return an array of constant B<OSSL_PARAM>s, or NULL if there is none
484 =item EVP_MD_CTX_copy_ex()
486 Returns 1 if successful or 0 for failure.
491 Returns the NID of the corresponding OBJECT IDENTIFIER or NID_undef if none
497 EVP_MD_CTX_block_size()
499 Returns the digest or block size in bytes.
503 Returns a pointer to the B<EVP_MD> structure of the "null" message digest.
505 =item EVP_get_digestbyname(),
506 EVP_get_digestbynid(),
507 EVP_get_digestbyobj()
509 Returns either an B<EVP_MD> structure or NULL if an error occurs.
511 =item EVP_MD_CTX_set_pkey_ctx()
513 This function has no return value.
519 The B<EVP> interface to message digests should almost always be used in
520 preference to the low level interfaces. This is because the code then becomes
521 transparent to the digest used and much more flexible.
523 New applications should use the SHA-2 (such as L<EVP_sha256(3)>) or the SHA-3
524 digest algorithms (such as L<EVP_sha3_512(3)>). The other digest algorithms
525 are still in common use.
527 For most applications the B<impl> parameter to EVP_DigestInit_ex() will be
528 set to NULL to use the default digest implementation.
530 The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are
531 obsolete but are retained to maintain compatibility with existing code. New
532 applications should use EVP_DigestInit_ex(), EVP_DigestFinal_ex() and
533 EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context
534 instead of initializing and cleaning it up on each call and allow non default
535 implementations of digests to be specified.
537 If digest contexts are not cleaned up after use,
538 memory leaks will occur.
540 EVP_MD_CTX_name(), EVP_MD_CTX_size(), EVP_MD_CTX_block_size(),
541 EVP_MD_CTX_type(), EVP_get_digestbynid() and EVP_get_digestbyobj() are defined
544 EVP_MD_CTX_ctrl() sends commands to message digests for additional configuration
549 This example digests the data "Test Message\n" and "Hello World\n", using the
550 digest name passed on the command line.
554 #include <openssl/evp.h>
556 int main(int argc, char *argv[])
560 char mess1[] = "Test Message\n";
561 char mess2[] = "Hello World\n";
562 unsigned char md_value[EVP_MAX_MD_SIZE];
563 unsigned int md_len, i;
565 if (argv[1] == NULL) {
566 printf("Usage: mdtest digestname\n");
570 md = EVP_get_digestbyname(argv[1]);
572 printf("Unknown message digest %s\n", argv[1]);
576 mdctx = EVP_MD_CTX_new();
577 EVP_DigestInit_ex(mdctx, md, NULL);
578 EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
579 EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
580 EVP_DigestFinal_ex(mdctx, md_value, &md_len);
581 EVP_MD_CTX_free(mdctx);
583 printf("Digest is: ");
584 for (i = 0; i < md_len; i++)
585 printf("%02x", md_value[i]);
593 L<EVP_MD_meth_new(3)>,
599 The full list of digest algorithms are provided below.
601 L<EVP_blake2b512(3)>,
612 L<provider(7)/Fetching algorithms>
616 The EVP_MD_CTX_create() and EVP_MD_CTX_destroy() functions were renamed to
617 EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.0, respectively.
619 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
620 later, so now EVP_sha1() can be used with RSA and DSA.
622 The EVP_dss1() function was removed in OpenSSL 1.1.0.
624 The EVP_MD_CTX_set_pkey_ctx() function was added in 1.1.1.
626 The EVP_MD_fetch(), EVP_MD_free(), EVP_MD_up_ref(), EVP_MD_CTX_set_params()
627 and EVP_MD_CTX_get_params() functions were added in 3.0.
631 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
633 Licensed under the Apache License 2.0 (the "License"). You may not use
634 this file except in compliance with the License. You can obtain a copy
635 in the file LICENSE in the source distribution or at
636 L<https://www.openssl.org/source/license.html>.