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