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