doc/crypto/EVP_DigestInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_MD_CTX_new, EVP_MD_CTX_reset, EVP_MD_CTX_free, EVP_MD_CTX_copy_ex,
   6 EVP_DigestInit_ex, EVP_DigestUpdate, EVP_DigestFinal_ex, EVP_MAX_MD_SIZE,
   7 EVP_DigestInit, EVP_DigestFinal, EVP_MD_CTX_copy, EVP_MD_type,
   8 EVP_MD_pkey_type, EVP_MD_size, EVP_MD_block_size, EVP_MD_CTX_md, EVP_MD_CTX_size,
   9 EVP_MD_CTX_block_size, EVP_MD_CTX_type, EVP_md_null, EVP_md2, EVP_md5, EVP_sha1,
  10 EVP_sha224, EVP_sha256, EVP_sha384, EVP_sha512, EVP_mdc2,
  11 EVP_ripemd160, EVP_blake2b_512, EVP_blake2s_256, EVP_get_digestbyname,
  12 EVP_get_digestbynid, EVP_get_digestbyobj - EVP digest routines
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/evp.h>
  17
  18  EVP_MD_CTX *EVP_MD_CTX_new(void);
  19  int EVP_MD_CTX_reset(EVP_MD_CTX *ctx);
  20  void EVP_MD_CTX_free(EVP_MD_CTX *ctx);
  21
  22  int EVP_DigestInit_ex(EVP_MD_CTX *ctx, const EVP_MD *type, ENGINE *impl);
  23  int EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, size_t cnt);
  24  int EVP_DigestFinal_ex(EVP_MD_CTX *ctx, unsigned char *md,
  25         unsigned int *s);
  26
  27  int EVP_MD_CTX_copy_ex(EVP_MD_CTX *out,const EVP_MD_CTX *in);
  28
  29  int EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
  30  int EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
  31         unsigned int *s);
  32
  33  int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
  34
  35  #define EVP_MAX_MD_SIZE 64     /* SHA512 */
  36
  37  int EVP_MD_type(const EVP_MD *md);
  38  int EVP_MD_pkey_type(const EVP_MD *md);
  39  int EVP_MD_size(const EVP_MD *md);
  40  int EVP_MD_block_size(const EVP_MD *md);
  41
  42  const EVP_MD *EVP_MD_CTX_md(const EVP_MD_CTX *ctx);
  43  int EVP_MD_CTX_size(const EVP_MD *ctx);
  44  int EVP_MD_CTX_block_size(const EVP_MD *ctx);
  45  int EVP_MD_CTX_type(const EVP_MD *ctx);
  46
  47  const EVP_MD *EVP_md_null(void);
  48  const EVP_MD *EVP_md2(void);
  49  const EVP_MD *EVP_md5(void);
  50  const EVP_MD *EVP_sha1(void);
  51  const EVP_MD *EVP_mdc2(void);
  52  const EVP_MD *EVP_ripemd160(void);
  53  const EVP_MD *EVP_blake2b_512(void);
  54  const EVP_MD *EVP_blake2s_256(void);
  55
  56  const EVP_MD *EVP_sha224(void);
  57  const EVP_MD *EVP_sha256(void);
  58  const EVP_MD *EVP_sha384(void);
  59  const EVP_MD *EVP_sha512(void);
  60
  61  const EVP_MD *EVP_get_digestbyname(const char *name);
  62  const EVP_MD *EVP_get_digestbynid(int type);
  63  const EVP_MD *EVP_get_digestbyobj(const ASN1_OBJECT *o);
  64
  65 =head1 DESCRIPTION
  66
  67 The EVP digest routines are a high level interface to message digests,
  68 and should be used instead of the cipher-specific functions.
  69
  70 EVP_MD_CTX_new() allocates, initializes and returns a digest context.
  71
  72 EVP_MD_CTX_reset() resets the digest context B<ctx>.  This can be used
  73 to reuse an already existing context.
  74
  75 EVP_MD_CTX_free() cleans up digest context B<ctx> and frees up the
  76 space allocated to it.
  77
  78 EVP_DigestInit_ex() sets up digest context B<ctx> to use a digest
  79 B<type> from ENGINE B<impl>. B<ctx> must be initialized before calling this
  80 function. B<type> will typically be supplied by a function such as EVP_sha1().
  81 If B<impl> is NULL then the default implementation of digest B<type> is used.
  82
  83 EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the
  84 digest context B<ctx>. This function can be called several times on the
  85 same B<ctx> to hash additional data.
  86
  87 EVP_DigestFinal_ex() retrieves the digest value from B<ctx> and places
  88 it in B<md>. If the B<s> parameter is not NULL then the number of
  89 bytes of data written (i.e. the length of the digest) will be written
  90 to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written.
  91 After calling EVP_DigestFinal_ex() no additional calls to EVP_DigestUpdate()
  92 can be made, but EVP_DigestInit_ex() can be called to initialize a new
  93 digest operation.
  94
  95 EVP_MD_CTX_copy_ex() can be used to copy the message digest state from
  96 B<in> to B<out>. This is useful if large amounts of data are to be
  97 hashed which only differ in the last few bytes. B<out> must be initialized
  98 before calling this function.
  99
 100 EVP_DigestInit() behaves in the same way as EVP_DigestInit_ex() except
 101 the passed context B<ctx> does not have to be initialized, and it always
 102 uses the default digest implementation.
 103
 104 EVP_DigestFinal() is similar to EVP_DigestFinal_ex() except the digest
 105 context B<ctx> is automatically cleaned up.
 106
 107 EVP_MD_CTX_copy() is similar to EVP_MD_CTX_copy_ex() except the destination
 108 B<out> does not have to be initialized.
 109
 110 EVP_MD_size() and EVP_MD_CTX_size() return the size of the message digest
 111 when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure, i.e. the size of the
 112 hash.
 113
 114 EVP_MD_block_size() and EVP_MD_CTX_block_size() return the block size of the
 115 message digest when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure.
 116
 117 EVP_MD_type() and EVP_MD_CTX_type() return the NID of the OBJECT IDENTIFIER
 118 representing the given message digest when passed an B<EVP_MD> structure.
 119 For example EVP_MD_type(EVP_sha1()) returns B<NID_sha1>. This function is
 120 normally used when setting ASN1 OIDs.
 121
 122 EVP_MD_CTX_md() returns the B<EVP_MD> structure corresponding to the passed
 123 B<EVP_MD_CTX>.
 124
 125 EVP_MD_pkey_type() returns the NID of the public key signing algorithm associated
 126 with this digest. For example EVP_sha1() is associated with RSA so this will
 127 return B<NID_sha1WithRSAEncryption>. Since digests and signature algorithms
 128 are no longer linked this function is only retained for compatibility
 129 reasons.
 130
 131 EVP_md2(), EVP_md5(), EVP_sha1(), EVP_sha224(), EVP_sha256(),
 132 EVP_sha384(), EVP_sha512(), EVP_mdc2(), EVP_ripemd160(), EVP_blake2b_512(), and
 133 EVP_blake2s_256() return B<EVP_MD> structures for the MD2, MD5, SHA1, SHA224,
 134 SHA256, SHA384, SHA512, MDC2, RIPEMD160, BLAKE2b-512, and BLAKE2s-256 digest
 135 algorithms respectively.
 136
 137 EVP_md_null() is a "null" message digest that does nothing: i.e. the hash it
 138 returns is of zero length.
 139
 140 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
 141 return an B<EVP_MD> structure when passed a digest name, a digest NID or
 142 an ASN1_OBJECT structure respectively.
 143
 144 =head1 RETURN VALUES
 145
 146 EVP_DigestInit_ex(), EVP_DigestUpdate() and EVP_DigestFinal_ex() return 1 for
 147 success and 0 for failure.
 148
 149 EVP_MD_CTX_copy_ex() returns 1 if successful or 0 for failure.
 150
 151 EVP_MD_type(), EVP_MD_pkey_type() and EVP_MD_type() return the NID of the
 152 corresponding OBJECT IDENTIFIER or NID_undef if none exists.
 153
 154 EVP_MD_size(), EVP_MD_block_size(), EVP_MD_CTX_size() and
 155 EVP_MD_CTX_block_size() return the digest or block size in bytes.
 156
 157 EVP_md_null(), EVP_md2(), EVP_md5(), EVP_sha1(),
 158 EVP_mdc2(), EVP_ripemd160(), EVP_blake2b_512(), and EVP_blake2s_256() return
 159 pointers to the corresponding EVP_MD structures.
 160
 161 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
 162 return either an B<EVP_MD> structure or NULL if an error occurs.
 163
 164 =head1 NOTES
 165
 166 The B<EVP> interface to message digests should almost always be used in
 167 preference to the low level interfaces. This is because the code then becomes
 168 transparent to the digest used and much more flexible.
 169
 170 New applications should use the SHA2 digest algorithms such as SHA256.
 171 The other digest algorithms are still in common use.
 172
 173 For most applications the B<impl> parameter to EVP_DigestInit_ex() will be
 174 set to NULL to use the default digest implementation.
 175
 176 The functions EVP_DigestInit(), EVP_DigestFinal() and EVP_MD_CTX_copy() are
 177 obsolete but are retained to maintain compatibility with existing code. New
 178 applications should use EVP_DigestInit_ex(), EVP_DigestFinal_ex() and
 179 EVP_MD_CTX_copy_ex() because they can efficiently reuse a digest context
 180 instead of initializing and cleaning it up on each call and allow non default
 181 implementations of digests to be specified.
 182
 183 If digest contexts are not cleaned up after use
 184 memory leaks will occur.
 185
 186 EVP_MD_CTX_size(), EVP_MD_CTX_block_size(), EVP_MD_CTX_type(),
 187 EVP_get_digestbynid() and EVP_get_digestbyobj() are defined as
 188 macros.
 189
 190
 191 =head1 EXAMPLE
 192
 193 This example digests the data "Test Message\n" and "Hello World\n", using the
 194 digest name passed on the command line.
 195
 196  #include <stdio.h>
 197  #include <openssl/evp.h>
 198
 199  main(int argc, char *argv[])
 200  {
 201  EVP_MD_CTX *mdctx;
 202  const EVP_MD *md;
 203  char mess1[] = "Test Message\n";
 204  char mess2[] = "Hello World\n";
 205  unsigned char md_value[EVP_MAX_MD_SIZE];
 206  int md_len, i;
 207
 208  if(!argv[1]) {
 209         printf("Usage: mdtest digestname\n");
 210         exit(1);
 211  }
 212
 213  md = EVP_get_digestbyname(argv[1]);
 214
 215  if(!md) {
 216         printf("Unknown message digest %s\n", argv[1]);
 217         exit(1);
 218  }
 219
 220  mdctx = EVP_MD_CTX_new();
 221  EVP_DigestInit_ex(mdctx, md, NULL);
 222  EVP_DigestUpdate(mdctx, mess1, strlen(mess1));
 223  EVP_DigestUpdate(mdctx, mess2, strlen(mess2));
 224  EVP_DigestFinal_ex(mdctx, md_value, &md_len);
 225  EVP_MD_CTX_free(mdctx);
 226
 227  printf("Digest is: ");
 228  for(i = 0; i < md_len; i++)
 229         printf("%02x", md_value[i]);
 230  printf("\n");
 231
 232  exit(0);
 233  }
 234
 235 =head1 SEE ALSO
 236
 237 L<dgst(1)>,
 238 L<evp(3)>
 239
 240 =head1 HISTORY
 241
 242 B<EVP_MD_CTX> became opaque in OpenSSL 1.1.  Consequently, stack
 243 allocated B<EVP_MD_CTX>s are no longer supported.
 244
 245 EVP_MD_CTX_create() and EVP_MD_CTX_destroy() were renamed to
 246 EVP_MD_CTX_new() and EVP_MD_CTX_free() in OpenSSL 1.1.
 247
 248 The link between digests and signing algorithms was fixed in OpenSSL 1.0 and
 249 later, so now EVP_sha1() can be used with RSA and DSA. The legacy EVP_dss1()
 250 was removed in OpenSSL 1.1.0
 251
 252 =head1 COPYRIGHT
 253
 254 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 255
 256 Licensed under the OpenSSL license (the "License").  You may not use
 257 this file except in compliance with the License.  You can obtain a copy
 258 in the file LICENSE in the source distribution or at
 259 L<https://www.openssl.org/source/license.html>.
 260
 261 =cut