OpenSSL_add_all_algorithms.pod 3.4 KB
Newer Older
D
 
Dr. Stephen Henson 已提交
1 2 3 4
=pod

=head1 NAME

M
Matt Caswell 已提交
5
OpenSSL_add_all_algorithms, OpenSSL_add_all_ciphers, OpenSSL_add_all_digests, EVP_cleanup -
6
add algorithms to internal table
D
 
Dr. Stephen Henson 已提交
7 8 9 10 11

=head1 SYNOPSIS

 #include <openssl/evp.h>

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
Deprecated:

 # if OPENSSL_API_COMPAT < 0x10100000L
 #  define OPENSSL_add_all_algorithms_conf() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
                         | OPENSSL_INIT_ADD_ALL_DIGESTS \
                         | OPENSSL_INIT_LOAD_CONFIG, NULL)
 #  define OPENSSL_add_all_algorithms_noconf() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
                         | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)

 #  ifdef OPENSSL_LOAD_CONF
 #   define OpenSSL_add_all_algorithms() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
                         | OPENSSL_INIT_ADD_ALL_DIGESTS \
                         | OPENSSL_INIT_LOAD_CONFIG, NULL)
 #  else
 #   define OpenSSL_add_all_algorithms() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS \
                         | OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)
 #  endif

 #  define OpenSSL_add_all_ciphers() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS, NULL)
 #  define OpenSSL_add_all_digests() \
     OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_DIGESTS, NULL)

 #  define EVP_cleanup()
# endif
D
 
Dr. Stephen Henson 已提交
41 42 43 44

=head1 DESCRIPTION

OpenSSL keeps an internal table of digest algorithms and ciphers. It uses
45 46 47 48 49
this table to lookup ciphers via functions such as EVP_get_cipher_byname(). In
OpenSSL versions prior to 1.1.0 these functions initialised and de-initialised
this table. From OpenSSL 1.1.0 are deprecated. No explicit initialisation or
de-initialisation is required. See L<OPENSSL_init_crypto(3)> for further
information.
D
 
Dr. Stephen Henson 已提交
50 51 52 53 54 55 56 57 58

OpenSSL_add_all_digests() adds all digest algorithms to the table.

OpenSSL_add_all_algorithms() adds all algorithms to the table (digests and
ciphers).

OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including
password based encryption algorithms.

59 60
In versions prior to 1.1.0 EVP_cleanup() removed all ciphers and digests from
the table. It no longer has any effect in OpenSSL 1.1.0.
D
 
Dr. Stephen Henson 已提交
61 62 63 64 65 66 67

=head1 RETURN VALUES

None of the functions return a value.

=head1 NOTES

R
Richard Levitte 已提交
68
A typical application will call OpenSSL_add_all_algorithms() initially and
D
 
Dr. Stephen Henson 已提交
69 70 71 72 73 74 75
EVP_cleanup() before exiting.

An application does not need to add algorithms to use them explicitly, for example
by EVP_sha1(). It just needs to add them if it (or any of the functions it calls)
needs to lookup algorithms.

The cipher and digest lookup functions are used in many parts of the library. If
U
ispell.  
Ulf Möller 已提交
76
the table is not initialized several functions will misbehave and complain they
D
 
Dr. Stephen Henson 已提交
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
cannot find algorithms. This includes the PEM, PKCS#12, SSL and S/MIME libraries.
This is a common query in the OpenSSL mailing lists.

Calling 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.

=head1 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.

=head1 SEE ALSO

R
Rich Salz 已提交
92 93
L<evp(3)>, L<EVP_DigestInit(3)>,
L<EVP_EncryptInit(3)>
D
 
Dr. Stephen Henson 已提交
94

95 96 97 98 99 100
=head1 HISTORY

The OpenSSL_add_all_algorithms(), OpenSSL_add_all_ciphers(),
OpenSSL_add_all_digests(), and EVP_cleanup(), functions
were deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().

D
 
Dr. Stephen Henson 已提交
101
=cut