xref: /openbsd-src/lib/libcrypto/man/OpenSSL_add_all_algorithms.3 (revision 897fc685943471cf985a0fe38ba076ea6fe74fa5)
1.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.7 2018/03/27 17:35:50 schwarze 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 27 2018 $
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.Nd add algorithms to internal table
60.Sh SYNOPSIS
61.In openssl/evp.h
62.Ft void
63.Fn OpenSSL_add_all_algorithms void
64.Ft void
65.Fn OpenSSL_add_all_ciphers void
66.Ft void
67.Fn OpenSSL_add_all_digests void
68.Ft void
69.Fn EVP_cleanup void
70.Sh DESCRIPTION
71These functions are deprecated.
72It is never useful for any application program
73to call any of them explicitly.
74The library automatically calls them internally whenever needed.
75.Pp
76OpenSSL keeps an internal table of digest algorithms and ciphers.
77It uses this table to look up ciphers via functions such as
78.Xr EVP_get_cipherbyname 3 .
79.Pp
80.Fn OpenSSL_add_all_algorithms
81adds all algorithms to the table (digests and ciphers).
82.Pp
83.Fn OpenSSL_add_all_digests
84adds all digest algorithms to the table.
85.Pp
86.Fn OpenSSL_add_all_ciphers
87adds all encryption algorithms to the table including password based
88encryption algorithms.
89.Pp
90If any of the above functions is called more than once,
91only the first call has an effect.
92.Pp
93.Fn EVP_cleanup
94removes all ciphers and digests from the table.
95.Sh SEE ALSO
96.Xr evp 3 ,
97.Xr EVP_DigestInit 3 ,
98.Xr EVP_EncryptInit 3 ,
99.Xr OPENSSL_config 3 ,
100.Xr OPENSSL_init_crypto 3
101.Sh HISTORY
102.Fn EVP_cleanup
103and precursor functions
104.Fn SSLeay_add_all_algorithms ,
105.Fn SSLeay_add_all_ciphers ,
106and
107.Fn SSLeay_add_all_digests
108first appeared in SSLeay 0.8.0 and have been available since
109.Ox 2.4 .
110.Pp
111.Fn OpenSSL_add_all_algorithms ,
112.Fn OpenSSL_add_all_ciphers ,
113and
114.Fn OpenSSL_add_all_digests
115first appeared in OpenSSL 0.9.5 and have been available since
116.Ox 2.7 .
117.Sh BUGS
118Although the functions do not return error codes, it is possible for them
119to fail.
120This will only happen as a result of a memory allocation failure so this
121is not too much of a problem in practice.
122