xref: /openssl/doc/man3/RIPEMD160_Init.pod (revision 3dbf8243)
1=pod
2
3=head1 NAME
4
5RIPEMD160, RIPEMD160_Init, RIPEMD160_Update, RIPEMD160_Final -
6RIPEMD-160 hash function
7
8=head1 SYNOPSIS
9
10 #include <openssl/ripemd.h>
11
12The following functions have been deprecated since OpenSSL 3.0, and can be
13hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
14see L<openssl_user_macros(7)>:
15
16 unsigned char *RIPEMD160(const unsigned char *d, unsigned long n,
17                          unsigned char *md);
18
19 int RIPEMD160_Init(RIPEMD160_CTX *c);
20 int RIPEMD160_Update(RIPEMD160_CTX *c, const void *data, unsigned long len);
21 int RIPEMD160_Final(unsigned char *md, RIPEMD160_CTX *c);
22
23=head1 DESCRIPTION
24
25All of the functions described on this page are deprecated.
26Applications should instead use L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)>
27and L<EVP_DigestFinal_ex(3)>.
28
29RIPEMD-160 is a cryptographic hash function with a
30160 bit output.
31
32RIPEMD160() computes the RIPEMD-160 message digest of the B<n>
33bytes at B<d> and places it in B<md> (which must have space for
34RIPEMD160_DIGEST_LENGTH == 20 bytes of output). If B<md> is NULL, the digest
35is placed in a static array.
36
37The following functions may be used if the message is not completely
38stored in memory:
39
40RIPEMD160_Init() initializes a B<RIPEMD160_CTX> structure.
41
42RIPEMD160_Update() can be called repeatedly with chunks of the message to
43be hashed (B<len> bytes at B<data>).
44
45RIPEMD160_Final() places the message digest in B<md>, which must have
46space for RIPEMD160_DIGEST_LENGTH == 20 bytes of output, and erases
47the B<RIPEMD160_CTX>.
48
49=head1 RETURN VALUES
50
51RIPEMD160() returns a pointer to the hash value.
52
53RIPEMD160_Init(), RIPEMD160_Update() and RIPEMD160_Final() return 1 for
54success, 0 otherwise.
55
56=head1 NOTE
57
58Applications should use the higher level functions
59L<EVP_DigestInit(3)> etc. instead of calling these
60functions directly.
61
62=head1 CONFORMING TO
63
64ISO/IEC 10118-3:2016 Dedicated Hash-Function 1 (RIPEMD-160).
65
66=head1 SEE ALSO
67
68L<EVP_DigestInit(3)>
69
70=head1 HISTORY
71
72All of these functions were deprecated in OpenSSL 3.0.
73
74=head1 COPYRIGHT
75
76Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
77
78Licensed under the Apache License 2.0 (the "License").  You may not use
79this file except in compliance with the License.  You can obtain a copy
80in the file LICENSE in the source distribution or at
81L<https://www.openssl.org/source/license.html>.
82
83=cut
84