summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EVP_PKEY_CTX_new.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_CTX_new.385
1 files changed, 85 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_CTX_new.3 b/src/lib/libcrypto/man/EVP_PKEY_CTX_new.3
new file mode 100644
index 0000000000..c08db1eb21
--- /dev/null
+++ b/src/lib/libcrypto/man/EVP_PKEY_CTX_new.3
@@ -0,0 +1,85 @@
1.Dd $Mdocdate: November 3 2016 $
2.Dt EVP_PKEY_CTX_NEW 3
3.Os
4.Sh NAME
5.Nm EVP_PKEY_CTX_new ,
6.Nm EVP_PKEY_CTX_new_id ,
7.Nm EVP_PKEY_CTX_dup ,
8.Nm EVP_PKEY_CTX_free
9.Nd public key algorithm context functions
10.Sh SYNOPSIS
11.In openssl/evp.h
12.Ft EVP_PKEY_CTX *
13.Fo EVP_PKEY_CTX_new
14.Fa "EVP_PKEY *pkey"
15.Fa "ENGINE *e"
16.Fc
17.Ft EVP_PKEY_CTX *
18.Fo EVP_PKEY_CTX_new_id
19.Fa "int id"
20.Fa "ENGINE *e"
21.Fc
22.Ft EVP_PKEY_CTX *
23.Fo EVP_PKEY_CTX_dup
24.Fa "EVP_PKEY_CTX *ctx"
25.Fc
26.Ft void
27.Fo EVP_PKEY_CTX_free
28.Fa "EVP_PKEY_CTX *ctx"
29.Fc
30.Sh DESCRIPTION
31The
32.Fn EVP_PKEY_CTX_new
33function allocates a public key algorithm context using the algorithm
34specified in
35.Fa pkey
36and the
37.Vt ENGINE
38.Fa e .
39.Pp
40The
41.Fn EVP_PKEY_CTX_new_id
42function allocates a public key algorithm context using the algorithm
43specified by
44.Fa id
45and
46.Vt ENGINE
47.Fa e .
48It is normally used when no
49.Vt EVP_PKEY
50structure is associated with the operations, for example during
51parameter generation of key generation for some algorithms.
52.Pp
53.Fn EVP_PKEY_CTX_dup
54duplicates the context
55.Fa ctx .
56.Pp
57.Fn EVP_PKEY_CTX_free
58frees up the context
59.Fa ctx .
60.Sh RETURN VALUES
61.Fn EVP_PKEY_CTX_new ,
62.Fn EVP_PKEY_CTX_new_id ,
63.Fn EVP_PKEY_CTX_dup
64returns either the newly allocated
65.Vt EVP_PKEY_CTX
66structure of
67.Dv NULL
68if an error occurred.
69.Pp
70.Fn EVP_PKEY_CTX_free
71does not return a value.
72.Sh SEE ALSO
73.Xr EVP_PKEY_new 3
74.Sh HISTORY
75These functions were first added to OpenSSL 1.0.0.
76.Sh CAVEATS
77The
78.Vt EVP_PKEY_CTX
79structure is an opaque public key algorithm context used by the OpenSSL
80high level public key API.
81Contexts
82.Sy MUST NOT
83be shared between threads.
84It is not permissible to use the same context simultaneously in two
85threads.