summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/MD5.pod
blob: 056f94bd9e106ebb2a9b300940e4d8286eb0bd8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
=pod

=head1 NAME

MD5, MD5_Init, MD5_Update, MD5_Final - MD5 hash functions

=head1 SYNOPSIS

 #include <openssl/md5.h>

 unsigned char *MD5(const unsigned char *d, unsigned long n,
                  unsigned char *md);

 int MD5_Init(MD5_CTX *c);
 int MD5_Update(MD5_CTX *c, const void *data,
                  unsigned long len);
 int MD5_Final(unsigned char *md, MD5_CTX *c);

=head1 DESCRIPTION

MD5 is a cryptographic hash function with a 128 bit output.

MD5() computes the MD5 message digest of the B<n> bytes at B<d> and
places it in B<md> (which must have space for MD5_DIGEST_LENGTH == 16
bytes of output). If B<md> is NULL, the digest is placed in a static
array.

The following functions may be used if the message is not completely
stored in memory:

Applications should use the higher level functions
L<EVP_DigestInit(3)|EVP_DigestInit(3)>
etc. instead of calling the hash functions directly.

=head1 NOTE

MD5 is recommended only for compatibility with legacy applications.
In new applications, SHA-2 should be preferred.

=head1 RETURN VALUES

MD5() returns a pointer to the hash value.

MD5_Init(), MD5_Update(), and MD5_Final() return 1 for success, 0
otherwise.

=head1 CONFORMING TO

RFC 1321

=head1 SEE ALSO

L<EVP_DigestInit(3)|EVP_DigestInit(3)>

=head1 HISTORY

MD5(), MD5_Init(), MD5_Update() and MD5_Final() are available in all
versions of OpenSSL.

=cut