md5.pod 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. =pod
  2. =head1 NAME
  3. MD2, MD4, MD5, MD2_Init, MD2_Update, MD2_Final, MD4_Init, MD4_Update,
  4. MD4_Final, MD5_Init, MD5_Update, MD5_Final - MD2, MD4, and MD5 hash functions
  5. =head1 SYNOPSIS
  6. #include <openssl/md2.h>
  7. unsigned char *MD2(const unsigned char *d, unsigned long n,
  8. unsigned char *md);
  9. int MD2_Init(MD2_CTX *c);
  10. int MD2_Update(MD2_CTX *c, const unsigned char *data,
  11. unsigned long len);
  12. int MD2_Final(unsigned char *md, MD2_CTX *c);
  13. #include <openssl/md4.h>
  14. unsigned char *MD4(const unsigned char *d, unsigned long n,
  15. unsigned char *md);
  16. int MD4_Init(MD4_CTX *c);
  17. int MD4_Update(MD4_CTX *c, const void *data,
  18. unsigned long len);
  19. int MD4_Final(unsigned char *md, MD4_CTX *c);
  20. #include <openssl/md5.h>
  21. unsigned char *MD5(const unsigned char *d, unsigned long n,
  22. unsigned char *md);
  23. int MD5_Init(MD5_CTX *c);
  24. int MD5_Update(MD5_CTX *c, const void *data,
  25. unsigned long len);
  26. int MD5_Final(unsigned char *md, MD5_CTX *c);
  27. =head1 DESCRIPTION
  28. MD2, MD4, and MD5 are cryptographic hash functions with a 128 bit output.
  29. MD2(), MD4(), and MD5() compute the MD2, MD4, and MD5 message digest
  30. of the B<n> bytes at B<d> and place it in B<md> (which must have space
  31. for MD2_DIGEST_LENGTH == MD4_DIGEST_LENGTH == MD5_DIGEST_LENGTH == 16
  32. bytes of output). If B<md> is NULL, the digest is placed in a static
  33. array.
  34. The following functions may be used if the message is not completely
  35. stored in memory:
  36. MD2_Init() initializes a B<MD2_CTX> structure.
  37. MD2_Update() can be called repeatedly with chunks of the message to
  38. be hashed (B<len> bytes at B<data>).
  39. MD2_Final() places the message digest in B<md>, which must have space
  40. for MD2_DIGEST_LENGTH == 16 bytes of output, and erases the B<MD2_CTX>.
  41. MD4_Init(), MD4_Update(), MD4_Final(), MD5_Init(), MD5_Update(), and
  42. MD5_Final() are analogous using an B<MD4_CTX> and B<MD5_CTX> structure.
  43. Applications should use the higher level functions
  44. L<EVP_DigestInit(3)|EVP_DigestInit(3)>
  45. etc. instead of calling the hash functions directly.
  46. =head1 NOTE
  47. MD2, MD4, and MD5 are recommended only for compatibility with existing
  48. applications. In new applications, SHA-1 or RIPEMD-160 should be
  49. preferred.
  50. =head1 RETURN VALUES
  51. MD2(), MD4(), and MD5() return pointers to the hash value.
  52. MD2_Init(), MD2_Update(), MD2_Final(), MD4_Init(), MD4_Update(),
  53. MD4_Final(), MD5_Init(), MD5_Update(), and MD5_Final() return 1 for
  54. success, 0 otherwise.
  55. =head1 CONFORMING TO
  56. RFC 1319, RFC 1320, RFC 1321
  57. =head1 SEE ALSO
  58. L<sha(3)|sha(3)>, L<ripemd(3)|ripemd(3)>, L<EVP_DigestInit(3)|EVP_DigestInit(3)>
  59. =head1 HISTORY
  60. MD2(), MD2_Init(), MD2_Update() MD2_Final(), MD5(), MD5_Init(),
  61. MD5_Update() and MD5_Final() are available in all versions of SSLeay
  62. and OpenSSL.
  63. MD4(), MD4_Init(), and MD4_Update() are available in OpenSSL 0.9.6 and
  64. above.
  65. =cut