doc/man3/MD5.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 MD2, MD4, MD5, MD2_Init, MD2_Update, MD2_Final, MD4_Init, MD4_Update,
   6 MD4_Final, MD5_Init, MD5_Update, MD5_Final - MD2, MD4, and MD5 hash functions
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/md2.h>
  11
  12 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  13 B<OPENSSL_API_COMPAT> with a suitable version value, see
  14 L<openssl_user_macros(7)>:
  15
  16  unsigned char *MD2(const unsigned char *d, unsigned long n, unsigned char *md);
  17
  18  int MD2_Init(MD2_CTX *c);
  19  int MD2_Update(MD2_CTX *c, const unsigned char *data, unsigned long len);
  20  int MD2_Final(unsigned char *md, MD2_CTX *c);
  21
  22
  23  #include <openssl/md4.h>
  24
  25 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  26 B<OPENSSL_API_COMPAT> with a suitable version value, see
  27 L<openssl_user_macros(7)>:
  28
  29  unsigned char *MD4(const unsigned char *d, unsigned long n, unsigned char *md);
  30
  31  int MD4_Init(MD4_CTX *c);
  32  int MD4_Update(MD4_CTX *c, const void *data, unsigned long len);
  33  int MD4_Final(unsigned char *md, MD4_CTX *c);
  34
  35
  36  #include <openssl/md5.h>
  37
  38 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  39 B<OPENSSL_API_COMPAT> with a suitable version value, see
  40 L<openssl_user_macros(7)>:
  41
  42  unsigned char *MD5(const unsigned char *d, unsigned long n, unsigned char *md);
  43
  44  int MD5_Init(MD5_CTX *c);
  45  int MD5_Update(MD5_CTX *c, const void *data, unsigned long len);
  46  int MD5_Final(unsigned char *md, MD5_CTX *c);
  47
  48 =head1 DESCRIPTION
  49
  50 All of the functions described on this page are deprecated.
  51 Applications should instead use L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)>
  52 and L<EVP_DigestFinal_ex(3)>.
  53
  54 MD2, MD4, and MD5 are cryptographic hash functions with a 128 bit output.
  55
  56 MD2(), MD4(), and MD5() compute the MD2, MD4, and MD5 message digest
  57 of the B<n> bytes at B<d> and place it in B<md> (which must have space
  58 for MD2_DIGEST_LENGTH == MD4_DIGEST_LENGTH == MD5_DIGEST_LENGTH == 16
  59 bytes of output). If B<md> is NULL, the digest is placed in a static
  60 array.
  61
  62 The following functions may be used if the message is not completely
  63 stored in memory:
  64
  65 MD2_Init() initializes a B<MD2_CTX> structure.
  66
  67 MD2_Update() can be called repeatedly with chunks of the message to
  68 be hashed (B<len> bytes at B<data>).
  69
  70 MD2_Final() places the message digest in B<md>, which must have space
  71 for MD2_DIGEST_LENGTH == 16 bytes of output, and erases the B<MD2_CTX>.
  72
  73 MD4_Init(), MD4_Update(), MD4_Final(), MD5_Init(), MD5_Update(), and
  74 MD5_Final() are analogous using an B<MD4_CTX> and B<MD5_CTX> structure.
  75
  76 Applications should use the higher level functions
  77 L<EVP_DigestInit(3)>
  78 etc. instead of calling the hash functions directly.
  79
  80 =head1 NOTE
  81
  82 MD2, MD4, and MD5 are recommended only for compatibility with existing
  83 applications. In new applications, SHA-1 or RIPEMD-160 should be
  84 preferred.
  85
  86 =head1 RETURN VALUES
  87
  88 MD2(), MD4(), and MD5() return pointers to the hash value.
  89
  90 MD2_Init(), MD2_Update(), MD2_Final(), MD4_Init(), MD4_Update(),
  91 MD4_Final(), MD5_Init(), MD5_Update(), and MD5_Final() return 1 for
  92 success, 0 otherwise.
  93
  94 =head1 CONFORMING TO
  95
  96 RFC 1319, RFC 1320, RFC 1321
  97
  98 =head1 SEE ALSO
  99
 100 L<EVP_DigestInit(3)>
 101
 102 =head1 HISTORY
 103
 104 All of these functions were deprecated in OpenSSL 3.0.
 105
 106 =head1 COPYRIGHT
 107
 108 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 109
 110 Licensed under the Apache License 2.0 (the "License").  You may not use
 111 this file except in compliance with the License.  You can obtain a copy
 112 in the file LICENSE in the source distribution or at
 113 L<https://www.openssl.org/source/license.html>.
 114
 115 =cut