RIPEMD160_Init.pod 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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. Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  8. B<OPENSSL_API_COMPAT> with a suitable version value, see
  9. L<openssl_user_macros(7)>:
  10. unsigned char *RIPEMD160(const unsigned char *d, unsigned long n,
  11. unsigned char *md);
  12. int RIPEMD160_Init(RIPEMD160_CTX *c);
  13. int RIPEMD160_Update(RIPEMD160_CTX *c, const void *data, unsigned long len);
  14. int RIPEMD160_Final(unsigned char *md, RIPEMD160_CTX *c);
  15. =head1 DESCRIPTION
  16. All of the functions described on this page are deprecated.
  17. Applications should instead use L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)>
  18. and L<EVP_DigestFinal_ex(3)>.
  19. RIPEMD-160 is a cryptographic hash function with a
  20. 160 bit output.
  21. RIPEMD160() computes the RIPEMD-160 message digest of the B<n>
  22. bytes at B<d> and places it in B<md> (which must have space for
  23. RIPEMD160_DIGEST_LENGTH == 20 bytes of output). If B<md> is NULL, the digest
  24. is placed in a static array.
  25. The following functions may be used if the message is not completely
  26. stored in memory:
  27. RIPEMD160_Init() initializes a B<RIPEMD160_CTX> structure.
  28. RIPEMD160_Update() can be called repeatedly with chunks of the message to
  29. be hashed (B<len> bytes at B<data>).
  30. RIPEMD160_Final() places the message digest in B<md>, which must have
  31. space for RIPEMD160_DIGEST_LENGTH == 20 bytes of output, and erases
  32. the B<RIPEMD160_CTX>.
  33. =head1 RETURN VALUES
  34. RIPEMD160() returns a pointer to the hash value.
  35. RIPEMD160_Init(), RIPEMD160_Update() and RIPEMD160_Final() return 1 for
  36. success, 0 otherwise.
  37. =head1 NOTE
  38. Applications should use the higher level functions
  39. L<EVP_DigestInit(3)> etc. instead of calling these
  40. functions directly.
  41. =head1 CONFORMING TO
  42. ISO/IEC 10118-3:2016 Dedicated Hash-Function 1 (RIPEMD-160).
  43. =head1 SEE ALSO
  44. L<EVP_DigestInit(3)>
  45. =head1 HISTORY
  46. All of these functions were deprecated in OpenSSL 3.0.
  47. =head1 COPYRIGHT
  48. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  49. Licensed under the Apache License 2.0 (the "License"). You may not use
  50. this file except in compliance with the License. You can obtain a copy
  51. in the file LICENSE in the source distribution or at
  52. L<https://www.openssl.org/source/license.html>.
  53. =cut