initial decription of GCM/CCM usage via EVP
[openssl.git] / doc / crypto / evp.pod
1 =pod
2
3 =head1 NAME
4
5 evp - high-level cryptographic functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/evp.h>
10
11 =head1 DESCRIPTION
12
13 The EVP library provides a high-level interface to cryptographic
14 functions.
15
16 B<EVP_Seal>I<...> and B<EVP_Open>I<...> provide public key encryption
17 and decryption to implement digital "envelopes".
18
19 The B<EVP_Sign>I<...> and B<EVP_Verify>I<...> functions implement
20 digital signatures.
21
22 Symmetric encryption is available with the B<EVP_Encrypt>I<...>
23 functions.  The B<EVP_Digest>I<...> functions provide message digests.
24
25 The B<EVP_PKEY>I<...> functions provide a high level interface to
26 asymmetric algorithms.
27
28 Algorithms are loaded with OpenSSL_add_all_algorithms(3).
29
30 All the symmetric algorithms (ciphers), digests and asymmetric algorithms
31 (public key algorithms) can be replaced by ENGINE modules providing alternative
32 implementations. If ENGINE implementations of ciphers or digests are registered
33 as defaults, then the various EVP functions will automatically use those
34 implementations automatically in preference to built in software
35 implementations. For more information, consult the engine(3) man page.
36
37 Although low level algorithm specific functions exist for many algorithms
38 their use is discouraged. They cannot be used with an ENGINE and ENGINE
39 versions of new algorithms cannot be accessed using the low level functions.
40 Also makes code harder to adapt to new algorithms and some options are not 
41 cleanly supported at the low level and some operations are more efficient
42 using the high level interface.
43
44 =head1 SEE ALSO
45
46 L<EVP_DigestInit(3)|EVP_DigestInit(3)>,
47 L<EVP_EncryptInit(3)|EVP_EncryptInit(3)>,
48 L<EVP_OpenInit(3)|EVP_OpenInit(3)>,
49 L<EVP_SealInit(3)|EVP_SealInit(3)>,
50 L<EVP_SignInit(3)|EVP_SignInit(3)>,
51 L<EVP_VerifyInit(3)|EVP_VerifyInit(3)>,
52 L<OpenSSL_add_all_algorithms(3)|OpenSSL_add_all_algorithms(3)>,
53 L<engine(3)|engine(3)>
54
55 =cut