RIPEMD160_Init.pod 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. =pod
  2. =head1 NAME
  3. RIPEMD160, RIPEMD160_Init, RIPEMD160_Update, RIPEMD160_Final -
  4. RIPEMD-160 hash function
  5. =head1 SYNOPSIS
  6. #include <openssl/ripemd.h>
  7. unsigned char *RIPEMD160(const unsigned char *d, unsigned long n,
  8. unsigned char *md);
  9. int RIPEMD160_Init(RIPEMD160_CTX *c);
  10. int RIPEMD160_Update(RIPEMD_CTX *c, const void *data,
  11. unsigned long len);
  12. int RIPEMD160_Final(unsigned char *md, RIPEMD160_CTX *c);
  13. =head1 DESCRIPTION
  14. RIPEMD-160 is a cryptographic hash function with a
  15. 160 bit output.
  16. RIPEMD160() computes the RIPEMD-160 message digest of the B<n>
  17. bytes at B<d> and places it in B<md> (which must have space for
  18. RIPEMD160_DIGEST_LENGTH == 20 bytes of output). If B<md> is NULL, the digest
  19. is placed in a static array.
  20. The following functions may be used if the message is not completely
  21. stored in memory:
  22. RIPEMD160_Init() initializes a B<RIPEMD160_CTX> structure.
  23. RIPEMD160_Update() can be called repeatedly with chunks of the message to
  24. be hashed (B<len> bytes at B<data>).
  25. RIPEMD160_Final() places the message digest in B<md>, which must have
  26. space for RIPEMD160_DIGEST_LENGTH == 20 bytes of output, and erases
  27. the B<RIPEMD160_CTX>.
  28. =head1 RETURN VALUES
  29. RIPEMD160() returns a pointer to the hash value.
  30. RIPEMD160_Init(), RIPEMD160_Update() and RIPEMD160_Final() return 1 for
  31. success, 0 otherwise.
  32. =head1 NOTE
  33. Applications should use the higher level functions
  34. L<EVP_DigestInit(3)> etc. instead of calling these
  35. functions directly.
  36. =head1 CONFORMING TO
  37. ISO/IEC 10118-3 (draft) (??)
  38. =head1 SEE ALSO
  39. L<EVP_DigestInit(3)>
  40. =head1 COPYRIGHT
  41. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  42. Licensed under the OpenSSL license (the "License"). You may not use
  43. this file except in compliance with the License. You can obtain a copy
  44. in the file LICENSE in the source distribution or at
  45. L<https://www.openssl.org/source/license.html>.
  46. =cut