doc/man3/EVP_DigestInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   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,
  17 EVP_MD_CTX_name,
  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,
  20 EVP_md_null,
  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
  24 - EVP digest routines
  25
  26 =head1 SYNOPSIS
  27
  28  #include <openssl/evp.h>
  29
  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);
  49
  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);
  56
  57  int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out, const EVP_MD_CTX *in);
  58
  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);
  61
  62  int EVP_MD_CTX_copy(EVP_MD_CTX *out, EVP_MD_CTX *in);
  63
  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),
  69                           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);
  76
  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));
  88
  89  const EVP_MD *EVP_md_null(void);
  90
  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);
  94
  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);
  97
  98  void EVP_MD_do_all_provided(OPENSSL_CTX *libctx,
  99                              void (*fn)(EVP_MD *mac, void *arg),
 100                              void *arg);
 101
 102 =head1 DESCRIPTION
 103
 104 The EVP digest routines are a high level interface to message digests,
 105 and should be used instead of the digest-specific functions.
 106
 107 The B<EVP_MD> type is a structure for digest method implementation.
 108
 109 =over 4
 110
 111 =item EVP_MD_fetch()
 112
 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.
 116
 117 The returned value must eventually be freed with EVP_MD_free().
 118
 119 Fetched B<EVP_MD> structures are reference counted.
 120
 121 =item EVP_MD_up_ref()
 122
 123 Increments the reference count for an B<EVP_MD> structure.
 124
 125 =item EVP_MD_free()
 126
 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.
 129
 130 =item EVP_MD_CTX_new()
 131
 132 Allocates and returns a digest context.
 133
 134 =item EVP_MD_CTX_reset()
 135
 136 Resets the digest context B<ctx>.  This can be used to reuse an already
 137 existing context.
 138
 139 =item EVP_MD_CTX_free()
 140
 141 Cleans up digest context B<ctx> and frees up the space allocated to it.
 142
 143 =item EVP_MD_CTX_ctrl()
 144
 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
 147 providers.
 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.
 153
 154 =item EVP_MD_get_params()
 155
 156 Retrieves the requested list of B<params> from a MD B<md>.
 157 See L</PARAMETERS> below for more information.
 158
 159 =item EVP_MD_CTX_get_params()
 160
 161 Retrieves the requested list of B<params> from a MD context B<ctx>.
 162 See L</PARAMETERS> below for more information.
 163
 164 =item EVP_MD_CTX_set_params()
 165
 166 Sets the list of B<params> into a MD context B<ctx>.
 167 See L</PARAMETERS> below for more information.
 168
 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()
 172
 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.
 181
 182 =item EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags(), EVP_MD_CTX_test_flags()
 183
 184 Sets, clears and tests B<ctx> flags.  See L</FLAGS> below for more information.
 185
 186 =item EVP_Digest()
 187
 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.
 193
 194 =item EVP_DigestInit_ex()
 195
 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().
 199
 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.
 202
 203 =item EVP_DigestUpdate()
 204
 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
 207 data.
 208
 209 =item EVP_DigestFinal_ex()
 210
 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.
 217
 218 =item EVP_DigestFinalXOF()
 219
 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.
 224
 225 =item EVP_MD_CTX_copy_ex()
 226
 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
 229 few bytes.
 230
 231 =item EVP_DigestInit()
 232
 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().
 235
 236 =item EVP_DigestFinal()
 237
 238 Similar to EVP_DigestFinal_ex() except the digest context B<ctx> is
 239 automatically cleaned up.
 240
 241 =item EVP_MD_CTX_copy()
 242
 243 Similar to EVP_MD_CTX_copy_ex() except the destination B<out> does not have to
 244 be initialized.
 245
 246 =item EVP_MD_is_a()
 247
 248 Returns 1 if I<md> is an implementation of an algorithm that's
 249 identifiable with I<name>, otherwise 0.
 250
 251 If I<md> is a legacy digest (it's the return value from the likes of
 252 EVP_sha256() rather than the result of an EVP_MD_fetch()), only cipher
 253 names registered with the default library context (see
 254 L<OPENSSL_CTX(3)>) will be considered.
 255
 256 =item EVP_MD_number()
 257
 258 Returns the internal dynamic number assigned to the I<md>.  This is
 259 only useful with fetched B<EVP_MD>s.
 260
 261 =item EVP_MD_name(),
 262 EVP_MD_CTX_name()
 263
 264 Return the name of the given message digest.  For fetched message
 265 digests with multiple names, only one of them is returned; it's
 266 recommended to use EVP_MD_names_do_all() instead.
 267
 268 =item EVP_MD_names_do_all()
 269
 270 Traverses all names for the I<md>, and calls I<fn> with each name and
 271 I<data>.  This is only useful with fetched B<EVP_MD>s.
 272
 273 =item EVP_MD_provider()
 274
 275 Returns an B<OSSL_PROVIDER> pointer to the provider that implements the given
 276 B<EVP_MD>.
 277
 278 =item EVP_MD_size(),
 279 EVP_MD_CTX_size()
 280
 281 Return the size of the message digest when passed an B<EVP_MD> or an
 282 B<EVP_MD_CTX> structure, i.e. the size of the hash.
 283
 284 =item EVP_MD_block_size(),
 285 EVP_MD_CTX_block_size()
 286
 287 Return the block size of the message digest when passed an B<EVP_MD> or an
 288 B<EVP_MD_CTX> structure.
 289
 290 =item EVP_MD_type(),
 291 EVP_MD_CTX_type()
 292
 293 Return the NID of the OBJECT IDENTIFIER representing the given message digest
 294 when passed an B<EVP_MD> structure.  For example, C<EVP_MD_type(EVP_sha1())>
 295 returns B<NID_sha1>. This function is normally used when setting ASN1 OIDs.
 296
 297 =item EVP_MD_CTX_md_data()
 298
 299 Return the digest method private data for the passed B<EVP_MD_CTX>.
 300 The space is allocated by OpenSSL and has the size originally set with
 301 EVP_MD_meth_set_app_datasize().
 302
 303 =item EVP_MD_CTX_md()
 304
 305 Returns the B<EVP_MD> structure corresponding to the passed B<EVP_MD_CTX>. This
 306 will be the same B<EVP_MD> object originally passed to EVP_DigestInit_ex() (or
 307 other similar function) when the EVP_MD_CTX was first initialised. Note that
 308 where explicit fetch is in use (see L<EVP_MD_fetch(3)>) the value returned from
 309 this function will not have its reference count incremented and therefore it
 310 should not be used after the EVP_MD_CTX is freed.
 311
 312 =item EVP_MD_CTX_set_update_fn()
 313
 314 Sets the update function for B<ctx> to B<update>.
 315 This is the function that is called by EVP_DigestUpdate. If not set, the
 316 update function from the B<EVP_MD> type specified at initialization is used.
 317
 318 =item EVP_MD_CTX_update_fn()
 319
 320 Returns the update function for B<ctx>.
 321
 322 =item EVP_MD_flags()
 323
 324 Returns the B<md> flags. Note that these are different from the B<EVP_MD_CTX>
 325 ones. See L<EVP_MD_meth_set_flags(3)> for more information.
 326
 327 =item EVP_MD_pkey_type()
 328
 329 Returns the NID of the public key signing algorithm associated with this
 330 digest. For example EVP_sha1() is associated with RSA so this will return
 331 B<NID_sha1WithRSAEncryption>. Since digests and signature algorithms are no
 332 longer linked this function is only retained for compatibility reasons.
 333
 334 =item EVP_md_null()
 335
 336 A "null" message digest that does nothing: i.e. the hash it returns is of zero
 337 length.
 338
 339 =item EVP_get_digestbyname(),
 340 EVP_get_digestbynid(),
 341 EVP_get_digestbyobj()
 342
 343 Returns an B<EVP_MD> structure when passed a digest name, a digest B<NID> or an
 344 B<ASN1_OBJECT> structure respectively.
 345
 346 =item EVP_MD_CTX_pkey_ctx()
 347
 348 Returns the B<EVP_PKEY_CTX> assigned to B<ctx>. The returned pointer should not
 349 be freed by the caller.
 350
 351 =item EVP_MD_CTX_set_pkey_ctx()
 352
 353 Assigns an B<EVP_PKEY_CTX> to B<EVP_MD_CTX>. This is usually used to provide
 354 a customized B<EVP_PKEY_CTX> to L<EVP_DigestSignInit(3)> or
 355 L<EVP_DigestVerifyInit(3)>. The B<pctx> passed to this function should be freed
 356 by the caller. A NULL B<pctx> pointer is also allowed to clear the B<EVP_PKEY_CTX>
 357 assigned to B<ctx>. In such case, freeing the cleared B<EVP_PKEY_CTX> or not
 358 depends on how the B<EVP_PKEY_CTX> is created.
 359
 360 =item EVP_MD_do_all_provided()
 361
 362 Traverses all messages digests implemented by all activated providers
 363 in the given library context I<libctx>, and for each of the implementations,
 364 calls the given function I<fn> with the implementation method and the given
 365 I<arg> as argument.
 366
 367 =back
 368
 369 =head1 PARAMETERS
 370
 371 See L<OSSL_PARAM(3)> for information about passing parameters.
 372
 373 EVP_MD_CTX_set_params() can be used with the following OSSL_PARAM keys:
 374
 375 =over 4
 376
 377 =item "xoflen" (B<OSSL_PARAM_DIGEST_KEY_XOFLEN>) <unsigned integer>
 378
 379 Sets the digest length for extendable output functions.
 380 It is used by the SHAKE algorithm and should not exceed what can be given
 381 using a B<size_t>.
 382
 383 =item "pad_type" (B<OSSL_PARAM_DIGEST_KEY_PAD_TYPE>) <integer>
 384
 385 Sets the pad type.
 386 It is used by the MDC2 algorithm.
 387
 388 =back
 389
 390 EVP_MD_CTX_get_params() can be used with the following OSSL_PARAM keys:
 391
 392 =over 4
 393
 394 =item "micalg" (B<OSSL_PARAM_DIGEST_KEY_MICALG>) <UTF8 string>.
 395
 396 Gets the digest Message Integrity Check algorithm string. This is used when
 397 creating S/MIME multipart/signed messages, as specified in RFC 3851.
 398 It may be used by external engines or providers.
 399
 400 =back
 401
 402 =head1 CONTROLS
 403
 404 EVP_MD_CTX_ctrl() can be used to send the following standard controls:
 405
 406 =over 4
 407
 408 =item EVP_MD_CTRL_MICALG
 409
 410 Gets the digest Message Integrity Check algorithm string. This is used when
 411 creating S/MIME multipart/signed messages, as specified in RFC 3851.
 412 The string value is written to B<p2>.
 413
 414 =item EVP_MD_CTRL_XOF_LEN
 415
 416 This control sets the digest length for extendable output functions to B<p1>.
 417 Sending this control directly should not be necessary, the use of
 418 C<EVP_DigestFinalXOF()> is preferred.
 419 Currently used by SHAKE.
 420
 421 =back
 422
 423 =head1 FLAGS
 424
 425 EVP_MD_CTX_set_flags(), EVP_MD_CTX_clear_flags() and EVP_MD_CTX_test_flags()
 426 can be used the manipulate and test these B<EVP_MD_CTX> flags:
 427
 428 =over 4
 429
 430 =item EVP_MD_CTX_FLAG_ONESHOT
 431
 432 This flag instructs the digest to optimize for one update only, if possible.
 433
 434 =for comment EVP_MD_CTX_FLAG_CLEANED is internal, don't mention it
 435
 436 =for comment EVP_MD_CTX_FLAG_REUSE is internal, don't mention it
 437
 438 =for comment We currently avoid documenting flags that are only bit holder:
 439 EVP_MD_CTX_FLAG_NON_FIPS_ALLOW, EVP_MD_CTX_FLAGS_PAD_*
 440
 441 =item EVP_MD_CTX_FLAG_NO_INIT
 442
 443 This flag instructs EVP_DigestInit() and similar not to initialise the
 444 implementation specific data.
 445
 446 =item EVP_MD_CTX_FLAG_FINALISE
 447
 448 Some functions such as EVP_DigestSign only finalise copies of internal
 449 contexts so additional data can be included after the finalisation call.
 450 This is inefficient if this functionality is not required, and can be
 451 disabled with this flag.
 452
 453 =back
 454
 455 =head1 RETURN VALUES
 456
 457 =over 4
 458
 459 =item EVP_MD_fetch()
 460
 461 Returns a pointer to a B<EVP_MD> for success or NULL for failure.
 462
 463 =item EVP_MD_up_ref()
 464
 465 Returns 1 for success or 0 for failure.
 466
 467 =item EVP_DigestInit_ex(),
 468 EVP_DigestUpdate(),
 469 EVP_DigestFinal_ex()
 470
 471 Returns 1 for
 472 success and 0 for failure.
 473
 474 =item EVP_MD_CTX_ctrl()
 475
 476 Returns 1 if successful or 0 for failure.
 477
 478 =item EVP_MD_CTX_set_params(),
 479 EVP_MD_CTX_get_params()
 480
 481 Returns 1 if successful or 0 for failure.
 482
 483 =item EVP_MD_CTX_settable_params(),
 484 EVP_MD_CTX_gettable_params()
 485
 486 Return an array of constant B<OSSL_PARAM>s, or NULL if there is none
 487 to get.
 488
 489 =item EVP_MD_CTX_copy_ex()
 490
 491 Returns 1 if successful or 0 for failure.
 492
 493 =item EVP_MD_type(),
 494 EVP_MD_pkey_type()
 495
 496 Returns the NID of the corresponding OBJECT IDENTIFIER or NID_undef if none
 497 exists.
 498
 499 =item EVP_MD_size(),
 500 EVP_MD_block_size(),
 501 EVP_MD_CTX_size(),
 502 EVP_MD_CTX_block_size()
 503
 504 Returns the digest or block size in bytes.
 505
 506 =item EVP_md_null()
 507
 508 Returns a pointer to the B<EVP_MD> structure of the "null" message digest.
 509
 510 =item EVP_get_digestbyname(),
 511 EVP_get_digestbynid(),
 512 EVP_get_digestbyobj()
 513
 514 Returns either an B<EVP_MD> structure or NULL if an error occurs.
 515
 516 =item EVP_MD_CTX_set_pkey_ctx()
 517
 518 This function has no return value.
 519
 520 =back
 521
 522 =head1 NOTES
 523
 524 The B<EVP> interface to message digests should almost always be used in
 525 preference to the low level interfaces. This is because the code then becomes
 526 transparent to the digest used and much more flexible.
 527
 528 New applications should use the SHA-2 (such as L<EVP_sha256(3)>) or the SHA-3
 529 digest algorithms (such as L<EVP_sha3_512(3)>). The other digest algorithms
 530 are still in common use.
 531
 532 For most applications the B<impl> parameter to EVP_DigestInit_ex() will be
 533 set to NULL to use the default digest implementation.
 534
 535 The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are
 536 obsolete but are retained to maintain compatibility with existing code. New
 537 applications should use EVP_DigestInit_ex(), EVP_DigestFinal_ex() and
 538 EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context
 539 instead of initializing and cleaning it up on each call and allow non default
 540 implementations of digests to be specified.
 541
 542 If digest contexts are not cleaned up after use,
 543 memory leaks will occur.
 544
 545 EVP_MD_CTX_name(), EVP_MD_CTX_size(), EVP_MD_CTX_block_size(),
 546 EVP_MD_CTX_type(), EVP_get_digestbynid() and EVP_get_digestbyobj() are defined
 547 as macros.
 548
 549 EVP_MD_CTX_ctrl() sends commands to message digests for additional configuration
 550 or control.
 551
 552 =head1 EXAMPLES
 553
 554 This example digests the data "Test Message\n" and "Hello World\n", using the
 555 digest name passed on the command line.
 556
 557  #include <stdio.h>
 558  #include <string.h>
 559  #include <openssl/evp.h>
 560
 561  int main(int argc, char *argv[])
 562  {
 563      EVP_MD_CTX *mdctx;
 564      const EVP_MD *md;
 565      char mess1[] = "Test Message\n";
 566      char mess2[] = "Hello World\n";
 567      unsigned char md_value[EVP_MAX_MD_SIZE];
 568      unsigned int md_len, i;
 569
 570      if (argv[1] == NULL) {
 571          printf("Usage: mdtest digestname\n");
 572          exit(1);
 573      }
 574
 575      md = EVP_get_digestbyname(argv[1]);
 576      if (md == NULL) {
 577          printf("Unknown message digest %s\n", argv[1]);
 578          exit(1);
 579      }
 580
 581      mdctx = EVP_MD_CTX_new();
 582      EVP_DigestInit_ex(mdctx, md, NULL);
 583      EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
 584      EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
 585      EVP_DigestFinal_ex(mdctx, md_value, &md_len);
 586      EVP_MD_CTX_free(mdctx);
 587
 588      printf("Digest is: ");
 589      for (i = 0; i < md_len; i++)
 590          printf("%02x", md_value[i]);
 591      printf("\n");
 592
 593      exit(0);
 594  }
 595
 596 =head1 SEE ALSO
 597
 598 L<EVP_MD_meth_new(3)>,
 599 L<openssl-dgst(1)>,
 600 L<evp(7)>,
 601 L<OSSL_PROVIDER(3)>,
 602 L<OSSL_PARAM(3)>
 603
 604 The full list of digest algorithms are provided below.
 605
 606 L<EVP_blake2b512(3)>,
 607 L<EVP_md2(3)>,
 608 L<EVP_md4(3)>,
 609 L<EVP_md5(3)>,
 610 L<EVP_mdc2(3)>,
 611 L<EVP_ripemd160(3)>,
 612 L<EVP_sha1(3)>,
 613 L<EVP_sha224(3)>,
 614 L<EVP_sha3_224(3)>,
 615 L<EVP_sm3(3)>,
 616 L<EVP_whirlpool(3)>
 617 L<provider(7)/Fetching algorithms>
 618
 619 =head1 HISTORY
 620
 621 The EVP_MD_CTX_create() and EVP_MD_CTX_destroy() functions were renamed to
 622 EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.0, respectively.
 623
 624 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
 625 later, so now EVP_sha1() can be used with RSA and DSA.
 626
 627 The EVP_dss1() function was removed in OpenSSL 1.1.0.
 628
 629 The EVP_MD_CTX_set_pkey_ctx() function was added in 1.1.1.
 630
 631 The EVP_MD_fetch(), EVP_MD_free(), EVP_MD_up_ref(), EVP_MD_CTX_set_params()
 632 and EVP_MD_CTX_get_params() functions were added in 3.0.
 633
 634 =head1 COPYRIGHT
 635
 636 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 637
 638 Licensed under the Apache License 2.0 (the "License").  You may not use
 639 this file except in compliance with the License.  You can obtain a copy
 640 in the file LICENSE in the source distribution or at
 641 L<https://www.openssl.org/source/license.html>.
 642
 643 =cut