blob: 7a31b9d1e8db1a9ec1069735eb227a84c88b462d (
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
61
62
63
64
65
66
67
68
69
70
71
72
73
|
.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.3 2016/11/22 21:38:18 jmc Exp $
.\"
.Dd $Mdocdate: November 22 2016 $
.Dt OPENSSL_ADD_ALL_ALGORITHMS 3
.Os
.Sh NAME
.Nm OpenSSL_add_all_algorithms ,
.Nm OpenSSL_add_all_ciphers ,
.Nm OpenSSL_add_all_digests ,
.Nm EVP_cleanup
.Nd add algorithms to internal table
.Sh SYNOPSIS
.In openssl/evp.h
.Ft void
.Fn OpenSSL_add_all_algorithms void
.Ft void
.Fn OpenSSL_add_all_ciphers void
.Ft void
.Fn OpenSSL_add_all_digests void
.Ft void
.Fn EVP_cleanup void
.Sh DESCRIPTION
OpenSSL keeps an internal table of digest algorithms and ciphers.
It uses this table to look up ciphers via functions such as
.Xr EVP_get_cipherbyname 3 .
.Pp
.Fn OpenSSL_add_all_algorithms
adds all algorithms to the table (digests and ciphers).
.Pp
.Fn OpenSSL_add_all_digests
adds all digest algorithms to the table.
.Pp
.Fn OpenSSL_add_all_ciphers
adds all encryption algorithms to the table including password based
encryption algorithms.
.Pp
.Fn EVP_cleanup
removes all ciphers and digests from the table.
.Pp
A typical application will call
.Fn OpenSSL_add_all_algorithms
initially and
.Fn EVP_cleanup
before exiting.
.Pp
An application does not need to add algorithms to use them explicitly,
for example by
.Xr EVP_sha1 3 .
It just needs to add them if it (or any of the functions it calls) needs
to look up algorithms.
.Pp
The cipher and digest lookup functions are used in many parts of the
library.
If the table is not initialized, several functions will misbehave and
complain they cannot find algorithms.
This includes the PEM, PKCS#12, SSL and S/MIME libraries.
This is a common query in the OpenSSL mailing lists.
.Pp
Calling
.Fn OpenSSL_add_all_algorithms
links in all algorithms: as a result a statically linked executable can
be quite large.
If this is important, it is possible to just add the required ciphers and
digests.
.Sh SEE ALSO
.Xr evp 3 ,
.Xr EVP_DigestInit 3 ,
.Xr EVP_EncryptInit 3
.Sh BUGS
Although the functions do not return error codes, it is possible for them
to fail.
This will only happen as a result of a memory allocation failure so this
is not too much of a problem in practice.
|
