doc/crypto/EVP_DigestInit.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal - EVP digest routines
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/evp.h>
  10
  11  void EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
  12  void EVP_DigestUpdate(EVP_MD_CTX *ctx,const void *d, unsigned int cnt);
  13  void EVP_DigestFinal(EVP_MD_CTX *ctx,unsigned char *md,unsigned int *s);
  14
  15  #define EVP_MAX_MD_SIZE (16+20) /* The SSLv3 md5+sha1 type */
  16
  17  int EVP_MD_CTX_copy(EVP_MD_CTX *out,EVP_MD_CTX *in);
  18
  19  #define EVP_MD_type(e)                 ((e)->type)
  20  #define EVP_MD_pkey_type(e)            ((e)->pkey_type)
  21  #define EVP_MD_size(e)                 ((e)->md_size)
  22  #define EVP_MD_block_size(e)           ((e)->block_size)
  23
  24  #define EVP_MD_CTX_md(e)               (e)->digest)
  25  #define EVP_MD_CTX_size(e)             EVP_MD_size((e)->digest)
  26  #define EVP_MD_CTX_block_size(e)       EVP_MD_block_size((e)->digest)
  27  #define EVP_MD_CTX_type(e)             EVP_MD_type((e)->digest)
  28
  29  EVP_MD *EVP_md_null(void);
  30  EVP_MD *EVP_md2(void);
  31  EVP_MD *EVP_md5(void);
  32  EVP_MD *EVP_sha(void);
  33  EVP_MD *EVP_sha1(void);
  34  EVP_MD *EVP_dss(void);
  35  EVP_MD *EVP_dss1(void);
  36  EVP_MD *EVP_mdc2(void);
  37  EVP_MD *EVP_ripemd160(void);
  38
  39  const EVP_MD *EVP_get_digestbyname(const char *name);
  40  #define EVP_get_digestbynid(a) EVP_get_digestbyname(OBJ_nid2sn(a))
  41  #define EVP_get_digestbyobj(a) EVP_get_digestbynid(OBJ_obj2nid(a))
  42
  43 =head1 DESCRIPTION
  44
  45 The EVP digest routines are a high level interface to message digests.
  46
  47 EVP_DigestInit() initialises a digest context B<ctx> to use a digest
  48 B<type>: this will typically be supplied by a function such as
  49 EVP_sha1().
  50
  51 EVP_DigestUpdate() hashes B<cnt> bytes of data at B<d> into the
  52 digest context B<ctx>. This funtion can be called several times on the
  53 same B<ctx> to hash additional data.
  54
  55 EVP_DigestFinal() retrieves the digest value from B<ctx> and places
  56 it in B<md>. If the B<s> parameter is not NULL then the number of
  57 bytes of data written (i.e. the length of the digest) will be written
  58 to the integer at B<s>, at most B<EVP_MAX_MD_SIZE> bytes will be written.
  59 After calling EVP_DigestFinal() no additional calls to EVP_DigestUpdate()
  60 can be made, but EVP_DigestInit() can be called to initialiase a new
  61 digest operation.
  62
  63 EVP_MD_CTX_copy() can be used to copy the message digest state from
  64 B<in> to B<out>. This is useful if large amounts of data are to be
  65 hashed which only differ in the last few bytes.
  66
  67 EVP_MD_size() and EVP_MD_CTX_size() return the size of the message digest
  68 when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure, i.e. the size of the
  69 hash.
  70
  71 EVP_MD_block_size() and EVP_MD_CTX_block_size() return the block size of the
  72 message digest when passed an B<EVP_MD> or an B<EVP_MD_CTX> structure.
  73
  74 EVP_MD_type() and EVP_MD_CTX_type() return the NID of the OBJECT IDENTIFIER
  75 representing the given message digest when passed an B<EVP_MD> structure.
  76 For example EVP_MD_type(EVP_sha1()) returns B<NID_sha1>. This function is
  77 normally used when setting ASN1 OIDs.
  78
  79 EVP_MD_CTX_md() returns the B<EVP_MD> structure corresponding to the passed
  80 B<EVP_MD_CTX>.
  81
  82 EVP_MD_pkey_type() returns the NID of the public key signing algorithm associated
  83 with this digest. For example EVP_sha1() is associated with RSA so this will
  84 return B<NID_sha1WithRSAEncryption>. This "link" between digests and signature
  85 algorithms may not be retained in future versions of OpenSSL.
  86
  87 EVP_md2(), EVP_md5(), EVP_sha(), EVP_sha1(), EVP_mdc2() and EVP_ripemd160()
  88 return B<EVP_MD> structures for the MD2, MD5, SHA, SHA1, MDC2 and RIPEMD160 digest
  89 algorithms respectively. The associated signature algorithm is RSA in each case.
  90
  91 EVP_dss() and EVP_dss1() return B<EVP_MD> structures for SHA and SHA1 digest
  92 algorithms but using DSS (DSA) for the signature algorithm.
  93
  94 EVP_md_null() is a "null" message digest that does nothing: i.e. the hash it
  95 returns is of zero length.
  96
  97 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
  98 return an B<EVP_MD> structure when passed a digest name, a digest NID or
  99 an ASN1_OBJECT structure respectively. The digest table must be initialised
 100 using, for example, OpenSSL_add_all_digests() for these functions to work.
 101
 102 =head1 RETURN VALUES
 103
 104 EVP_DigestInit(), EVP_DigestUpdate() and EVP_DigestFinal() do not return values.
 105
 106 EVP_MD_CTX_copy() returns 1 if successful or 0 for failure.
 107
 108 EVP_MD_type(), EVP_MD_pkey_type() and EVP_MD_type() return the NID of the
 109 corresponding OBJECT IDENTIFIER or NID_undef if none exists.
 110
 111 EVP_MD_size(), EVP_MD_block_size(), EVP_MD_CTX_size(e), EVP_MD_size(),
 112 EVP_MD_CTX_block_size() and EVP_MD_block_size() return the digest or block
 113 size in bytes.
 114
 115 EVP_md_null(), EVP_md2(), EVP_md5(), EVP_sha(), EVP_sha1(), EVP_dss(),
 116 EVP_dss1(), EVP_mdc2() and EVP_ripemd160() return pointers to the
 117 corresponding EVP_MD structures.
 118
 119 EVP_get_digestbyname(), EVP_get_digestbynid() and EVP_get_digestbyobj()
 120 return either an B<EVP_MD> structure or NULL if an error occurs.
 121
 122 =head1 NOTES
 123
 124 The B<EVP> interface to message digests should almost always be used in
 125 preference to the low level interfaces. This is because the code then becomes
 126 transparent to the digest used and much more flexible.
 127
 128 SHA1 is the digest of choice for new applications. The other digest algorithms
 129 are still in common use.
 130
 131 =head1 EXAMPLE
 132
 133 This example digests the data "Test Message\n" and "Hello World\n", using the
 134 digest name passed on the command line.
 135
 136  #include <stdio.h>
 137  #include <openssl/evp.h>
 138
 139  main(int argc, char *argv[])
 140  {
 141  EVP_MD_CTX mdctx;
 142  const EVP_MD *md;
 143  char mess1[] = "Test Message\n";
 144  char mess2[] = "Hello World\n";
 145  unsigned char md_value[EVP_MAX_MD_SIZE];
 146  int md_len, i;
 147
 148  OpenSSL_add_all_digests();
 149
 150  if(!argv[1]) {
 151         printf("Usage: mdtest digestname\n");
 152         exit(1);
 153  }
 154
 155  md = EVP_get_digestbyname(argv[1]);
 156
 157  if(!md) {
 158         printf("Unknown message digest %s\n", argv[1]);
 159         exit(1);
 160  }
 161
 162  EVP_DigestInit(&mdctx, md);
 163  EVP_DigestUpdate(&mdctx, mess1, strlen(mess1));
 164  EVP_DigestUpdate(&mdctx, mess2, strlen(mess2));
 165  EVP_DigestFinal(&mdctx, md_value, &md_len);
 166
 167  printf("Digest is: ");
 168  for(i = 0; i < md_len; i++) printf("%02x", md_value[i]);
 169  printf("\n");
 170  }
 171
 172 =head1 BUGS
 173
 174 Several of the functions do not return values: maybe they should. Although the
 175 internal digest operations will never fail some future hardware based operations
 176 might.
 177
 178 The link between digests and signing algorithms results in a situation where
 179 EVP_sha1() must be used with RSA and EVP_dss1() must be used with DSS
 180 even though they are identical digests.
 181
 182 The size of an B<EVP_MD_CTX> structure is determined at compile time: this results
 183 in code that must be recompiled if the size of B<EVP_MD_CTX> increases.
 184
 185 =head1 SEE ALSO
 186
 187 L<evp(3)|evp(3)>, L<hmac(3)|hmac(3)>, L<md2(3)|md2(3)>,
 188 L<md5(3)|md5(3)>, L<mdc2(3)|mdc2(3)>, L<ripemd(3)|ripemd(3)>,
 189 L<sha(3)|sha(3)>, L<digest(1)|digest(1)>
 190
 191 =head1 HISTORY
 192
 193 EVP_DigestInit(), EVP_DigestUpdate() and EVP_DigestFinal() are
 194 available in all versions of SSLeay and OpenSSL.
 195
 196 =cut