Add some EVP_PKEY_METHOD docs.
[openssl.git] / doc / crypto / EVP_PKEY_encrypt.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_encrypt_init, EVP_PKEY_encrypt - encrypt using a public key algorithm
6
7 =head1 SYNOPSIS
8
9  #include <openssl/evp.h>
10
11  int EVP_PKEY_encrypt_init(EVP_PKEY_CTX *ctx);
12  int EVP_PKEY_encrypt(EVP_PKEY_CTX *ctx,
13                         unsigned char *out, size_t *outlen,
14                         const unsigned char *in, size_t inlen);
15
16 =head1 DESCRIPTION
17
18 The EVP_PKEY_encrypt_init() function initializes a public key algorithm
19 context using key B<pkey> for an encryption operation.
20
21 The EVP_PKEY_encrypt() function performs a public key encryption operation
22 using B<ctx>. The data to be encrypted is specified using the B<in> and
23 B<inlen> parameters. If B<out> is B<NULL> then the maximum size of the output
24 buffer is written to the B<outlen> parameter. If B<out> is not B<NULL> then
25 before the call the B<outlen> parameter should contain the length of the
26 B<out> buffer, if the call is successful the encrypted data is written to
27 B<out> and the amount of data written to B<outlen>.
28
29 =head1 NOTES
30
31 After the call to EVP_PKEY_encrypt_init() algorithm specific control
32 operations can be performed to set any appropriate parameters for the
33 operation.
34
35 The function EVP_PKEY_encrypt() can be called more than once on the same
36 context if several operations are performed using the same parameters.
37
38 =head1 RETURN VALUES
39
40 EVP_PKEY_encrypt_init() and EVP_PKEY_encrypt() return 1 for success and 0
41 or a negative value for failure.
42
43 =head1 EXAMPLE
44
45 Encrypt data using OAEP (for RSA keys):
46
47 [to be added]
48
49 =head1 SEE ALSO
50
51 L<EVP_PKEY_CTX_new(3)|EVP_PKEY_CTX_new(3)>,
52 L<EVP_PKEY_decrypt(3)|EVP_PKEY_decrypt(3)>,
53 L<EVP_PKEY_sign(3)|EVP_PKEY_sign(3)>,
54 L<EVP_PKEY_verify(3)|EVP_PKEY_verify(3)>,
55 L<EVP_PKEY_verifyrecover(3)|EVP_PKEY_verifyrecover(3)>,
56 L<EVP_PKEY_derive(3)|EVP_PKEY_derive(3)> 
57
58 =head1 HISTORY
59
60 These functions were first added to OpenSSL 0.9.9.
61
62 =cut