doc/man3/OpenSSL_add_all_algorithms.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OpenSSL_add_all_algorithms, OpenSSL_add_all_ciphers, OpenSSL_add_all_digests, EVP_cleanup -
   6 add algorithms to internal table
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/evp.h>
  11
  12 Deprecated:
  13
  14  # if OPENSSL_API_COMPAT < 0x10100000L
  15  void OpenSSL_add_all_algorithms(void);
  16  void OpenSSL_add_all_ciphers(void);
  17  void OpenSSL_add_all_digests(void);
  18
  19  void EVP_cleanup(void)
  20 # endif
  21
  22 =head1 DESCRIPTION
  23
  24 OpenSSL keeps an internal table of digest algorithms and ciphers. It uses
  25 this table to lookup ciphers via functions such as EVP_get_cipher_byname(). In
  26 OpenSSL versions prior to 1.1.0 these functions initialised and de-initialised
  27 this table. From OpenSSL 1.1.0 they are deprecated. No explicit initialisation
  28 or de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further
  29 information.
  30
  31 OpenSSL_add_all_digests() adds all digest algorithms to the table.
  32
  33 OpenSSL_add_all_algorithms() adds all algorithms to the table (digests and
  34 ciphers).
  35
  36 OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including
  37 password based encryption algorithms.
  38
  39 In versions prior to 1.1.0 EVP_cleanup() removed all ciphers and digests from
  40 the table. It no longer has any effect in OpenSSL 1.1.0.
  41
  42 =head1 RETURN VALUES
  43
  44 None of the functions return a value.
  45
  46 =head1 NOTES
  47
  48 A typical application will call OpenSSL_add_all_algorithms() initially and
  49 EVP_cleanup() before exiting.
  50
  51 An application does not need to add algorithms to use them explicitly, for example
  52 by EVP_sha1(). It just needs to add them if it (or any of the functions it calls)
  53 needs to lookup algorithms.
  54
  55 The cipher and digest lookup functions are used in many parts of the library. If
  56 the table is not initialized several functions will misbehave and complain they
  57 cannot find algorithms. This includes the PEM, PKCS#12, SSL and S/MIME libraries.
  58 This is a common query in the OpenSSL mailing lists.
  59
  60 Calling OpenSSL_add_all_algorithms() links in all algorithms: as a result a
  61 statically linked executable can be quite large. If this is important it is possible
  62 to just add the required ciphers and digests.
  63
  64 =head1 BUGS
  65
  66 Although the functions do not return error codes it is possible for them to fail.
  67 This will only happen as a result of a memory allocation failure so this is not
  68 too much of a problem in practice.
  69
  70 =head1 SEE ALSO
  71
  72 L<evp(7)>, L<EVP_DigestInit(3)>,
  73 L<EVP_EncryptInit(3)>
  74
  75 =head1 HISTORY
  76
  77 The OpenSSL_add_all_algorithms(), OpenSSL_add_all_ciphers(),
  78 OpenSSL_add_all_digests(), and EVP_cleanup(), functions
  79 were deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().
  80
  81 =head1 COPYRIGHT
  82
  83 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  84
  85 Licensed under the OpenSSL license (the "License").  You may not use
  86 this file except in compliance with the License.  You can obtain a copy
  87 in the file LICENSE in the source distribution or at
  88 L<https://www.openssl.org/source/license.html>.
  89
  90 =cut