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