diff options
Diffstat (limited to 'src/lib/libcrypto/doc/OpenSSL_add_all_algorithms.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/OpenSSL_add_all_algorithms.pod | 66 |
1 files changed, 0 insertions, 66 deletions
diff --git a/src/lib/libcrypto/doc/OpenSSL_add_all_algorithms.pod b/src/lib/libcrypto/doc/OpenSSL_add_all_algorithms.pod deleted file mode 100644 index e63411b5bb..0000000000 --- a/src/lib/libcrypto/doc/OpenSSL_add_all_algorithms.pod +++ /dev/null | |||
| @@ -1,66 +0,0 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | OpenSSL_add_all_algorithms, OpenSSL_add_all_ciphers, OpenSSL_add_all_digests - | ||
| 6 | add algorithms to internal table | ||
| 7 | |||
| 8 | =head1 SYNOPSIS | ||
| 9 | |||
| 10 | #include <openssl/evp.h> | ||
| 11 | |||
| 12 | void OpenSSL_add_all_algorithms(void); | ||
| 13 | void OpenSSL_add_all_ciphers(void); | ||
| 14 | void OpenSSL_add_all_digests(void); | ||
| 15 | |||
| 16 | void EVP_cleanup(void); | ||
| 17 | |||
| 18 | =head1 DESCRIPTION | ||
| 19 | |||
| 20 | OpenSSL keeps an internal table of digest algorithms and ciphers. It uses | ||
| 21 | this table to lookup ciphers via functions such as EVP_get_cipher_byname(). | ||
| 22 | |||
| 23 | OpenSSL_add_all_digests() adds all digest algorithms to the table. | ||
| 24 | |||
| 25 | OpenSSL_add_all_algorithms() adds all algorithms to the table (digests and | ||
| 26 | ciphers). | ||
| 27 | |||
| 28 | OpenSSL_add_all_ciphers() adds all encryption algorithms to the table including | ||
| 29 | password based encryption algorithms. | ||
| 30 | |||
| 31 | EVP_cleanup() removes all ciphers and digests from the table. | ||
| 32 | |||
| 33 | =head1 RETURN VALUES | ||
| 34 | |||
| 35 | None of the functions return a value. | ||
| 36 | |||
| 37 | =head1 NOTES | ||
| 38 | |||
| 39 | A typical application will call OpenSSL_add_all_algorithms() initially and | ||
| 40 | EVP_cleanup() before exiting. | ||
| 41 | |||
| 42 | An application does not need to add algorithms to use them explicitly, for example | ||
| 43 | by EVP_sha1(). It just needs to add them if it (or any of the functions it calls) | ||
| 44 | needs to lookup algorithms. | ||
| 45 | |||
| 46 | The cipher and digest lookup functions are used in many parts of the library. If | ||
| 47 | the table is not initialized several functions will misbehave and complain they | ||
| 48 | cannot find algorithms. This includes the PEM, PKCS#12, SSL and S/MIME libraries. | ||
| 49 | This is a common query in the OpenSSL mailing lists. | ||
| 50 | |||
| 51 | Calling OpenSSL_add_all_algorithms() links in all algorithms: as a result a | ||
| 52 | statically linked executable can be quite large. If this is important it is possible | ||
| 53 | to just add the required ciphers and digests. | ||
| 54 | |||
| 55 | =head1 BUGS | ||
| 56 | |||
| 57 | Although the functions do not return error codes it is possible for them to fail. | ||
| 58 | This will only happen as a result of a memory allocation failure so this is not | ||
| 59 | too much of a problem in practice. | ||
| 60 | |||
| 61 | =head1 SEE ALSO | ||
| 62 | |||
| 63 | L<evp(3)|evp(3)>, L<EVP_DigestInit(3)|EVP_DigestInit(3)>, | ||
| 64 | L<EVP_EncryptInit(3)|EVP_EncryptInit(3)> | ||
| 65 | |||
| 66 | =cut | ||
