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