diff options
Diffstat (limited to '')
-rw-r--r-- | src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod b/src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod deleted file mode 100644 index 60ad61e853..0000000000 --- a/src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod +++ /dev/null | |||
@@ -1,53 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | EVP_PKEY_CTX_new, EVP_PKEY_CTX_new_id, EVP_PKEY_CTX_dup, EVP_PKEY_CTX_free - | ||
6 | public key algorithm context functions. | ||
7 | |||
8 | =head1 SYNOPSIS | ||
9 | |||
10 | #include <openssl/evp.h> | ||
11 | |||
12 | EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e); | ||
13 | EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e); | ||
14 | EVP_PKEY_CTX *EVP_PKEY_CTX_dup(EVP_PKEY_CTX *ctx); | ||
15 | void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx); | ||
16 | |||
17 | =head1 DESCRIPTION | ||
18 | |||
19 | The EVP_PKEY_CTX_new() function allocates public key algorithm context using | ||
20 | the algorithm specified in B<pkey> and ENGINE B<e>. | ||
21 | |||
22 | The EVP_PKEY_CTX_new_id() function allocates public key algorithm context | ||
23 | using the algorithm specified by B<id> and ENGINE B<e>. It is normally used | ||
24 | when no B<EVP_PKEY> structure is associated with the operations, for example | ||
25 | during parameter generation of key generation for some algorithms. | ||
26 | |||
27 | EVP_PKEY_CTX_dup() duplicates the context B<ctx>. | ||
28 | |||
29 | EVP_PKEY_CTX_free() frees up the context B<ctx>. | ||
30 | |||
31 | =head1 NOTES | ||
32 | |||
33 | The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used | ||
34 | by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between | ||
35 | threads: that is it is not permissible to use the same context simultaneously | ||
36 | in two threads. | ||
37 | |||
38 | =head1 RETURN VALUES | ||
39 | |||
40 | EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either | ||
41 | the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred. | ||
42 | |||
43 | EVP_PKEY_CTX_free() does not return a value. | ||
44 | |||
45 | =head1 SEE ALSO | ||
46 | |||
47 | L<EVP_PKEY_new(3)|EVP_PKEY_new(3)> | ||
48 | |||
49 | =head1 HISTORY | ||
50 | |||
51 | These functions were first added to OpenSSL 1.0.0. | ||
52 | |||
53 | =cut | ||