summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc
diff options
context:
space:
mode:
authorschwarze <>2016-11-03 10:02:57 +0000
committerschwarze <>2016-11-03 10:02:57 +0000
commit05264184755e9ad926b368969ae307f8b4784f6e (patch)
treee46d47f822cc196cab18580b945e031bb59a4186 /src/lib/libcrypto/doc
parent4d607f17ea3eb38ed9f7703afd423f6055c686d4 (diff)
downloadopenbsd-05264184755e9ad926b368969ae307f8b4784f6e.tar.gz
openbsd-05264184755e9ad926b368969ae307f8b4784f6e.tar.bz2
openbsd-05264184755e9ad926b368969ae307f8b4784f6e.zip
convert HMAC and MD5 manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc')
-rw-r--r--src/lib/libcrypto/doc/HMAC.pod106
-rw-r--r--src/lib/libcrypto/doc/MD5.pod101
2 files changed, 0 insertions, 207 deletions
diff --git a/src/lib/libcrypto/doc/HMAC.pod b/src/lib/libcrypto/doc/HMAC.pod
deleted file mode 100644
index d92138d273..0000000000
--- a/src/lib/libcrypto/doc/HMAC.pod
+++ /dev/null
@@ -1,106 +0,0 @@
1=pod
2
3=head1 NAME
4
5HMAC, HMAC_Init, HMAC_Update, HMAC_Final, HMAC_cleanup - HMAC message
6authentication code
7
8=head1 SYNOPSIS
9
10 #include <openssl/hmac.h>
11
12 unsigned char *HMAC(const EVP_MD *evp_md, const void *key,
13 int key_len, const unsigned char *d, int n,
14 unsigned char *md, unsigned int *md_len);
15
16 void HMAC_CTX_init(HMAC_CTX *ctx);
17
18 int HMAC_Init(HMAC_CTX *ctx, const void *key, int key_len,
19 const EVP_MD *md);
20 int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int key_len,
21 const EVP_MD *md, ENGINE *impl);
22 int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, int len);
23 int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len);
24
25 void HMAC_CTX_cleanup(HMAC_CTX *ctx);
26 void HMAC_cleanup(HMAC_CTX *ctx);
27
28=head1 DESCRIPTION
29
30HMAC is a MAC (message authentication code), i.e. a keyed hash
31function used for message authentication, which is based on a hash
32function.
33
34HMAC() computes the message authentication code of the B<n> bytes at
35B<d> using the hash function B<evp_md> and the key B<key> which is
36B<key_len> bytes long.
37
38It places the result in B<md> (which must have space for the output of
39the hash function, which is no more than B<EVP_MAX_MD_SIZE> bytes).
40If B<md> is NULL, the digest is placed in a static array. The size of
41the output is placed in B<md_len>, unless it is B<NULL>.
42
43B<evp_md> can be EVP_sha1(), EVP_ripemd160() etc.
44
45HMAC_CTX_init() initialises a B<HMAC_CTX> before first use. It must be
46called.
47
48HMAC_CTX_cleanup() erases the key and other data from the B<HMAC_CTX>
49and releases any associated resources. It must be called when an
50B<HMAC_CTX> is no longer required.
51
52HMAC_cleanup() is an alias for HMAC_CTX_cleanup() included for back
53compatibility with 0.9.6b, it is deprecated.
54
55The following functions may be used if the message is not completely
56stored in memory:
57
58HMAC_Init() initializes a B<HMAC_CTX> structure to use the hash
59function B<evp_md> and the key B<key> which is B<key_len> bytes
60long. It is deprecated and only included for backward compatibility
61with OpenSSL 0.9.6b.
62
63HMAC_Init_ex() initializes or reuses a B<HMAC_CTX> structure to use
64the function B<evp_md> and key B<key>. Either can be NULL, in which
65case the existing one will be reused. HMAC_CTX_init() must have been
66called before the first use of an B<HMAC_CTX> in this
67function. B<N.B. HMAC_Init() had this undocumented behaviour in
68previous versions of OpenSSL - failure to switch to HMAC_Init_ex() in
69programs that expect it will cause them to stop working>.
70
71HMAC_Update() can be called repeatedly with chunks of the message to
72be authenticated (B<len> bytes at B<data>).
73
74HMAC_Final() places the message authentication code in B<md>, which
75must have space for the hash function output.
76
77=head1 RETURN VALUES
78
79HMAC() returns a pointer to the message authentication code or NULL if
80an error occurred.
81
82HMAC_Init_ex(), HMAC_Update() and HMAC_Final() return 1 for success or 0 if
83an error occurred.
84
85HMAC_CTX_init() and HMAC_CTX_cleanup() do not return values.
86
87=head1 CONFORMING TO
88
89RFC 2104
90
91=head1 SEE ALSO
92
93L<sha(3)|sha(3)>, L<evp(3)|evp(3)>
94
95=head1 HISTORY
96
97HMAC(), HMAC_Init(), HMAC_Update(), HMAC_Final() and HMAC_cleanup()
98are available since SSLeay 0.9.0.
99
100HMAC_CTX_init(), HMAC_Init_ex() and HMAC_CTX_cleanup() are available
101since OpenSSL 0.9.7.
102
103HMAC_Init_ex(), HMAC_Update() and HMAC_Final() did not return values in
104versions of OpenSSL before 1.0.0.
105
106=cut
diff --git a/src/lib/libcrypto/doc/MD5.pod b/src/lib/libcrypto/doc/MD5.pod
deleted file mode 100644
index b0edd5416f..0000000000
--- a/src/lib/libcrypto/doc/MD5.pod
+++ /dev/null
@@ -1,101 +0,0 @@
1=pod
2
3=head1 NAME
4
5MD2, MD4, MD5, MD2_Init, MD2_Update, MD2_Final, MD4_Init, MD4_Update,
6MD4_Final, MD5_Init, MD5_Update, MD5_Final - MD2, MD4, and MD5 hash functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/md2.h>
11
12 unsigned char *MD2(const unsigned char *d, unsigned long n,
13 unsigned char *md);
14
15 int MD2_Init(MD2_CTX *c);
16 int MD2_Update(MD2_CTX *c, const unsigned char *data,
17 unsigned long len);
18 int MD2_Final(unsigned char *md, MD2_CTX *c);
19
20
21 #include <openssl/md4.h>
22
23 unsigned char *MD4(const unsigned char *d, unsigned long n,
24 unsigned char *md);
25
26 int MD4_Init(MD4_CTX *c);
27 int MD4_Update(MD4_CTX *c, const void *data,
28 unsigned long len);
29 int MD4_Final(unsigned char *md, MD4_CTX *c);
30
31
32 #include <openssl/md5.h>
33
34 unsigned char *MD5(const unsigned char *d, unsigned long n,
35 unsigned char *md);
36
37 int MD5_Init(MD5_CTX *c);
38 int MD5_Update(MD5_CTX *c, const void *data,
39 unsigned long len);
40 int MD5_Final(unsigned char *md, MD5_CTX *c);
41
42=head1 DESCRIPTION
43
44MD2, MD4, and MD5 are cryptographic hash functions with a 128 bit output.
45
46MD2(), MD4(), and MD5() compute the MD2, MD4, and MD5 message digest
47of the B<n> bytes at B<d> and place it in B<md> (which must have space
48for MD2_DIGEST_LENGTH == MD4_DIGEST_LENGTH == MD5_DIGEST_LENGTH == 16
49bytes of output). If B<md> is NULL, the digest is placed in a static
50array.
51
52The following functions may be used if the message is not completely
53stored in memory:
54
55MD2_Init() initializes a B<MD2_CTX> structure.
56
57MD2_Update() can be called repeatedly with chunks of the message to
58be hashed (B<len> bytes at B<data>).
59
60MD2_Final() places the message digest in B<md>, which must have space
61for MD2_DIGEST_LENGTH == 16 bytes of output, and erases the B<MD2_CTX>.
62
63MD4_Init(), MD4_Update(), MD4_Final(), MD5_Init(), MD5_Update(), and
64MD5_Final() are analogous using an B<MD4_CTX> and B<MD5_CTX> structure.
65
66Applications should use the higher level functions
67L<EVP_DigestInit(3)|EVP_DigestInit(3)>
68etc. instead of calling the hash functions directly.
69
70=head1 NOTE
71
72MD2, MD4, and MD5 are recommended only for compatibility with existing
73applications. In new applications, SHA-1 or RIPEMD-160 should be
74preferred.
75
76=head1 RETURN VALUES
77
78MD2(), MD4(), and MD5() return pointers to the hash value.
79
80MD2_Init(), MD2_Update(), MD2_Final(), MD4_Init(), MD4_Update(),
81MD4_Final(), MD5_Init(), MD5_Update(), and MD5_Final() return 1 for
82success, 0 otherwise.
83
84=head1 CONFORMING TO
85
86RFC 1319, RFC 1320, RFC 1321
87
88=head1 SEE ALSO
89
90L<sha(3)|sha(3)>, L<ripemd(3)|ripemd(3)>, L<EVP_DigestInit(3)|EVP_DigestInit(3)>
91
92=head1 HISTORY
93
94MD2(), MD2_Init(), MD2_Update() MD2_Final(), MD5(), MD5_Init(),
95MD5_Update() and MD5_Final() are available in all versions of SSLeay
96and OpenSSL.
97
98MD4(), MD4_Init(), and MD4_Update() are available in OpenSSL 0.9.6 and
99above.
100
101=cut