summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/doc/EVP_PKEY_CTX_new.pod53
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
5EVP_PKEY_CTX_new, EVP_PKEY_CTX_new_id, EVP_PKEY_CTX_dup, EVP_PKEY_CTX_free -
6public 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
19The EVP_PKEY_CTX_new() function allocates public key algorithm context using
20the algorithm specified in B<pkey> and ENGINE B<e>.
21
22The EVP_PKEY_CTX_new_id() function allocates public key algorithm context
23using the algorithm specified by B<id> and ENGINE B<e>. It is normally used
24when no B<EVP_PKEY> structure is associated with the operations, for example
25during parameter generation of key generation for some algorithms.
26
27EVP_PKEY_CTX_dup() duplicates the context B<ctx>.
28
29EVP_PKEY_CTX_free() frees up the context B<ctx>.
30
31=head1 NOTES
32
33The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used
34by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between
35threads: that is it is not permissible to use the same context simultaneously
36in two threads.
37
38=head1 RETURN VALUES
39
40EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either
41the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred.
42
43EVP_PKEY_CTX_free() does not return a value.
44
45=head1 SEE ALSO
46
47L<EVP_PKEY_new(3)|EVP_PKEY_new(3)>
48
49=head1 HISTORY
50
51These functions were first added to OpenSSL 1.0.0.
52
53=cut