summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/evp.pod
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/doc/evp.pod')
-rw-r--r--src/lib/libcrypto/doc/evp.pod107
1 files changed, 0 insertions, 107 deletions
diff --git a/src/lib/libcrypto/doc/evp.pod b/src/lib/libcrypto/doc/evp.pod
deleted file mode 100644
index dfd96d3b98..0000000000
--- a/src/lib/libcrypto/doc/evp.pod
+++ /dev/null
@@ -1,107 +0,0 @@
1=pod
2
3=head1 NAME
4
5evp - high-level cryptographic functions
6
7=head1 SYNOPSIS
8
9 #include <openssl/evp.h>
10
11=head1 DESCRIPTION
12
13The EVP library provides a high-level interface to cryptographic
14functions.
15
16L<B<EVP_Seal>I<...>|EVP_SealInit(3)> and L<B<EVP_Open>I<...>|EVP_OpenInit(3)>
17provide public key encryption and decryption to implement digital "envelopes".
18
19The L<B<EVP_DigestSign>I<...>|EVP_DigestSignInit(3)> and
20L<B<EVP_DigestVerify>I<...>|EVP_DigestVerifyInit(3)> functions implement
21digital signatures and Message Authentication Codes (MACs). Also see the older
22L<B<EVP_Sign>I<...>|EVP_SignInit(3)> and L<B<EVP_Verify>I<...>|EVP_VerifyInit(3)>
23functions.
24
25Symmetric encryption is available with the L<B<EVP_Encrypt>I<...>|EVP_EncryptInit(3)>
26functions. The L<B<EVP_Digest>I<...>|EVP_DigestInit(3)> functions provide message digests.
27
28Authenticated encryption with additional data (AEAD) is available with
29the L<B<EVP_AEAD>I<...>|EVP_AEAD_CTX_init(3)> functions.
30
31The B<EVP_PKEY>I<...> functions provide a high level interface to
32asymmetric algorithms. To create a new EVP_PKEY see
33L<EVP_PKEY_new(3)|EVP_PKEY_new(3)>. EVP_PKEYs can be associated
34with a private key of a particular algorithm by using the functions
35described on the L<EVP_PKEY_set1_RSA(3)|EVP_PKEY_set1_RSA(3)> page, or
36new keys can be generated using L<EVP_PKEY_keygen(3)|EVP_PKEY_keygen(3)>.
37EVP_PKEYs can be compared using L<EVP_PKEY_cmp(3)|EVP_PKEY_cmp(3)>, or printed using
38L<EVP_PKEY_print_private(3)|EVP_PKEY_print_private(3)>.
39
40The EVP_PKEY functions support the full range of asymmetric algorithm operations:
41
42=over
43
44=item For key agreement see L<EVP_PKEY_derive(3)|EVP_PKEY_derive(3)>
45
46=item For signing and verifying see L<EVP_PKEY_sign(3)|EVP_PKEY_sign(3)>,
47L<EVP_PKEY_verify(3)|EVP_PKEY_verify(3)> and L<EVP_PKEY_verify_recover(3)|EVP_PKEY_verify_recover(3)>.
48However, note that
49these functions do not perform a digest of the data to be signed. Therefore
50normally you would use the L<B<EVP_DigestSign>I<...>|EVP_DigestSignInit(3)>
51functions for this purpose.
52
53=item For encryption and decryption see L<EVP_PKEY_encrypt(3)|EVP_PKEY_encrypt(3)>
54and L<EVP_PKEY_decrypt(3)|EVP_PKEY_decrypt(3)> respectively. However, note that
55these functions perform encryption and decryption only. As public key
56encryption is an expensive operation, normally you would wrap
57an encrypted message in a "digital envelope" using the L<B<EVP_Seal>I<...>|EVP_SealInit(3)> and
58L<B<EVP_Open>I<...>|EVP_OpenInit(3)> functions.
59
60=back
61
62The L<EVP_BytesToKey(3)|EVP_BytesToKey(3)> function provides some limited support for password
63based encryption. Careful selection of the parameters will provide a PKCS#5 PBKDF1 compatible
64implementation. However, new applications should not typically use this (preferring, for example,
65PBKDF2 from PCKS#5).
66
67Algorithms are loaded with L<OpenSSL_add_all_algorithms(3)|OpenSSL_add_all_algorithms(3)>.
68
69All the symmetric algorithms (ciphers), digests and asymmetric algorithms
70(public key algorithms) can be replaced by L<ENGINE|engine(3)> modules providing alternative
71implementations. If ENGINE implementations of ciphers or digests are registered
72as defaults, then the various EVP functions will automatically use those
73implementations automatically in preference to built in software
74implementations. For more information, consult the engine(3) man page.
75
76Although low level algorithm specific functions exist for many algorithms
77their use is discouraged. They cannot be used with an ENGINE and ENGINE
78versions of new algorithms cannot be accessed using the low level functions.
79Also makes code harder to adapt to new algorithms and some options are not
80cleanly supported at the low level and some operations are more efficient
81using the high level interface.
82
83=head1 SEE ALSO
84
85L<EVP_DigestInit(3)|EVP_DigestInit(3)>,
86L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>,
87L<EVP_AEAD_CTX_init(3)|EVP_AEAD_CTX_init(3)>,
88L<EVP_OpenInit(3)|EVP_OpenInit(3)>,
89L<EVP_SealInit(3)|EVP_SealInit(3)>,
90L<EVP_DigestSignInit(3)|EVP_DigestSignInit(3)>,
91L<EVP_SignInit(3)|EVP_SignInit(3)>,
92L<EVP_VerifyInit(3)|EVP_VerifyInit(3)>,
93L<EVP_PKEY_new(3)|EVP_PKEY_new(3)>,
94L<EVP_PKEY_set1_RSA(3)|EVP_PKEY_set1_RSA(3)>,
95L<EVP_PKEY_keygen(3)|EVP_PKEY_keygen(3)>,
96L<EVP_PKEY_print_private(3)|EVP_PKEY_print_private(3)>,
97L<EVP_PKEY_decrypt(3)|EVP_PKEY_decrypt(3)>,
98L<EVP_PKEY_encrypt(3)|EVP_PKEY_encrypt(3)>,
99L<EVP_PKEY_sign(3)|EVP_PKEY_sign(3)>,
100L<EVP_PKEY_verify(3)|EVP_PKEY_verify(3)>,
101L<EVP_PKEY_verify_recover(3)|EVP_PKEY_verify_recover(3)>,
102L<EVP_PKEY_derive(3)|EVP_PKEY_derive(3)>,
103L<EVP_BytesToKey(3)|EVP_BytesToKey(3)>,
104L<OpenSSL_add_all_algorithms(3)|OpenSSL_add_all_algorithms(3)>,
105L<engine(3)|engine(3)>
106
107=cut