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