summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3')
-rw-r--r--src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3152
1 files changed, 0 insertions, 152 deletions
diff --git a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 b/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3
deleted file mode 100644
index 88ecef9768..0000000000
--- a/src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3
+++ /dev/null
@@ -1,152 +0,0 @@
1.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.16 2024/03/04 19:04:47 tb Exp $
2.\" full merge up to: OpenSSL b3696a55 Sep 2 09:35:50 2017 -0400
3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2000, 2003, 2013 The OpenSSL Project. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: March 4 2024 $
52.Dt OPENSSL_ADD_ALL_ALGORITHMS 3
53.Os
54.Sh NAME
55.Nm OpenSSL_add_all_algorithms ,
56.Nm OpenSSL_add_all_ciphers ,
57.Nm OpenSSL_add_all_digests ,
58.Nm EVP_cleanup ,
59.Nm SSLeay_add_all_algorithms
60.\" .Nm OPENSSL_add_all_algorithms_conf ,
61.\" .Nm OPENSSL_add_all_algorithms_noconf ,
62.\" .Nm SSLeay_add_all_ciphers , and
63.\" .Nm SSLeay_add_all_digests are intentionally undocumented
64.\" because they are unused aliases.
65.Nd add algorithms to internal table
66.Sh SYNOPSIS
67.In openssl/evp.h
68.Ft void
69.Fn OpenSSL_add_all_algorithms void
70.Ft void
71.Fn OpenSSL_add_all_ciphers void
72.Ft void
73.Fn OpenSSL_add_all_digests void
74.Ft void
75.Fn EVP_cleanup void
76.Ft void
77.Fn SSLeay_add_all_algorithms void
78.Sh DESCRIPTION
79These functions are deprecated.
80It is never useful for any application program
81to call any of them explicitly.
82The library automatically calls them internally whenever needed.
83.Pp
84OpenSSL keeps an internal table of digest algorithms and ciphers.
85It uses this table to look up ciphers via functions such as
86.Xr EVP_get_cipherbyname 3 .
87.Pp
88.Fn OpenSSL_add_all_algorithms
89adds all algorithms to the table (digests and ciphers).
90If an application is compiled with the preprocessor symbol
91.Dv OPENSSL_LOAD_CONF
92#define'd, it also calls
93.Xr OPENSSL_config 3
94with a
95.Dv NULL
96argument, loading the default configuration file.
97.Pp
98.Fn OpenSSL_add_all_digests
99adds all digest algorithms to the table.
100.Pp
101.Fn OpenSSL_add_all_ciphers
102adds all encryption algorithms to the table including password based
103encryption algorithms.
104.Pp
105If any of the above functions is called more than once,
106only the first call has an effect.
107.Pp
108.Fn EVP_cleanup
109removes all ciphers and digests from the table and also calls
110.Xr OBJ_NAME_cleanup 3
111with an argument of \-1 ,
112thus resetting the global associative array of names
113and all signature algorithm definitions to their default states,
114removing all application-defined types, key-value pairs, and aliases,
115including any that are unrelated to the EVP library.
116.Pp
117.Fn SSLeay_add_all_algorithms
118is a deprecated alias for
119.Fn OpenSSL_add_all_algorithms .
120.Pp
121.Fn OpenSSL_add_all_algorithms
122and
123.Fn SSLeay_add_all_algorithms
124are implemented as macros.
125.Sh SEE ALSO
126.Xr evp 3 ,
127.Xr EVP_DigestInit 3 ,
128.Xr EVP_EncryptInit 3 ,
129.Xr OBJ_cleanup 3 ,
130.Xr OBJ_NAME_add 3 ,
131.Xr OPENSSL_config 3
132.Sh HISTORY
133.Fn EVP_cleanup ,
134.Fn SSLeay_add_all_algorithms ,
135and precursor functions
136.Fn SSLeay_add_all_ciphers
137and
138.Fn SSLeay_add_all_digests
139first appeared in SSLeay 0.8.0 and have been available since
140.Ox 2.4 .
141.Pp
142.Fn OpenSSL_add_all_algorithms ,
143.Fn OpenSSL_add_all_ciphers ,
144and
145.Fn OpenSSL_add_all_digests
146first appeared in OpenSSL 0.9.5 and have been available since
147.Ox 2.7 .
148.Sh BUGS
149Although the functions do not return error codes, it is possible for them
150to fail.
151This will only happen as a result of a memory allocation failure so this
152is not too much of a problem in practice.