1.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.4 2016/11/28 16:40:27 schwarze Exp $ 2.\" OpenSSL f672aee4 Feb 9 11:52:40 2016 -0500 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: November 28 2016 $ 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 71OpenSSL keeps an internal table of digest algorithms and ciphers. 72It uses this table to look up ciphers via functions such as 73.Xr EVP_get_cipherbyname 3 . 74.Pp 75.Fn OpenSSL_add_all_algorithms 76adds all algorithms to the table (digests and ciphers). 77.Pp 78.Fn OpenSSL_add_all_digests 79adds all digest algorithms to the table. 80.Pp 81.Fn OpenSSL_add_all_ciphers 82adds all encryption algorithms to the table including password based 83encryption algorithms. 84.Pp 85.Fn EVP_cleanup 86removes all ciphers and digests from the table. 87.Pp 88A typical application will call 89.Fn OpenSSL_add_all_algorithms 90initially and 91.Fn EVP_cleanup 92before exiting. 93.Pp 94An application does not need to add algorithms to use them explicitly, 95for example by 96.Xr EVP_sha1 3 . 97It just needs to add them if it (or any of the functions it calls) needs 98to look up algorithms. 99.Pp 100The cipher and digest lookup functions are used in many parts of the 101library. 102If the table is not initialized, several functions will misbehave and 103complain they cannot find algorithms. 104This includes the PEM, PKCS#12, SSL and S/MIME libraries. 105This is a common query in the OpenSSL mailing lists. 106.Pp 107Calling 108.Fn OpenSSL_add_all_algorithms 109links in all algorithms: as a result a statically linked executable can 110be quite large. 111If this is important, it is possible to just add the required ciphers and 112digests. 113.Sh SEE ALSO 114.Xr evp 3 , 115.Xr EVP_DigestInit 3 , 116.Xr EVP_EncryptInit 3 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