summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
diff options
context:
space:
mode:
authorschwarze <>2016-11-03 09:35:34 +0000
committerschwarze <>2016-11-03 09:35:34 +0000
commitca3058f44f6c221a5580f274a8d643470f5ffa0a (patch)
tree58d82d0d7f6aeee380eaadbcfaa231ecbe6b90a0 /src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
parent13e48df1ecc456d07bff6a1552bb8ff8286b8b17 (diff)
downloadopenbsd-ca3058f44f6c221a5580f274a8d643470f5ffa0a.tar.gz
openbsd-ca3058f44f6c221a5580f274a8d643470f5ffa0a.tar.bz2
openbsd-ca3058f44f6c221a5580f274a8d643470f5ffa0a.zip
convert EVP manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3')
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3171
1 files changed, 171 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
new file mode 100644
index 0000000000..986918dc2f
--- /dev/null
+++ b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
@@ -0,0 +1,171 @@
1.Dd $Mdocdate: November 3 2016 $
2.Dt EVP_PKEY_SET1_RSA 3
3.Os
4.Sh NAME
5.Nm EVP_PKEY_set1_RSA ,
6.Nm EVP_PKEY_set1_DSA ,
7.Nm EVP_PKEY_set1_DH ,
8.Nm EVP_PKEY_set1_EC_KEY ,
9.Nm EVP_PKEY_get1_RSA ,
10.Nm EVP_PKEY_get1_DSA ,
11.Nm EVP_PKEY_get1_DH ,
12.Nm EVP_PKEY_get1_EC_KEY ,
13.Nm EVP_PKEY_assign_RSA ,
14.Nm EVP_PKEY_assign_DSA ,
15.Nm EVP_PKEY_assign_DH ,
16.Nm EVP_PKEY_assign_EC_KEY ,
17.Nm EVP_PKEY_type
18.Nd EVP_PKEY assignment functions
19.Sh SYNOPSIS
20.In openssl/evp.h
21.Ft int
22.Fo EVP_PKEY_set1_RSA
23.Fa "EVP_PKEY *pkey"
24.Fa "RSA *key"
25.Fc
26.Ft int
27.Fo EVP_PKEY_set1_DSA
28.Fa "EVP_PKEY *pkey"
29.Fa "DSA *key"
30.Fc
31.Ft int
32.Fo EVP_PKEY_set1_DH
33.Fa "EVP_PKEY *pkey"
34.Fa "DH *key"
35.Fc
36.Ft int
37.Fo EVP_PKEY_set1_EC_KEY
38.Fa "EVP_PKEY *pkey"
39.Fa "EC_KEY *key"
40.Fc
41.Ft RSA *
42.Fo EVP_PKEY_get1_RSA
43.Fa "EVP_PKEY *pkey"
44.Fc
45.Ft DSA *
46.Fo EVP_PKEY_get1_DSA
47.Fa "EVP_PKEY *pkey"
48.Fc
49.Ft DH *
50.Fo EVP_PKEY_get1_DH
51.Fa "EVP_PKEY *pkey"
52.Fc
53.Ft EC_KEY *
54.Fo EVP_PKEY_get1_EC_KEY
55.Fa "EVP_PKEY *pkey"
56.Fc
57.Ft int
58.Fo EVP_PKEY_assign_RSA
59.Fa "EVP_PKEY *pkey"
60.Fa "RSA *key"
61.Fc
62.Ft int
63.Fo EVP_PKEY_assign_DSA
64.Fa "EVP_PKEY *pkey"
65.Fa "DSA *key"
66.Fc
67.Ft int
68.Fo EVP_PKEY_assign_DH
69.Fa "EVP_PKEY *pkey"
70.Fa "DH *key"
71.Fc
72.Ft int
73.Fo EVP_PKEY_assign_EC_KEY
74.Fa "EVP_PKEY *pkey"
75.Fa "EC_KEY *key"
76.Fc
77.Ft int
78.Fo EVP_PKEY_type
79.Fa "int type"
80.Fc
81.Sh DESCRIPTION
82.Fn EVP_PKEY_set1_RSA ,
83.Fn EVP_PKEY_set1_DSA ,
84.Fn EVP_PKEY_set1_DH ,
85and
86.Fn EVP_PKEY_set1_EC_KEY
87set the key referenced by
88.Fa pkey
89to
90.Fa key .
91.Pp
92.Fn EVP_PKEY_get1_RSA ,
93.Fn EVP_PKEY_get1_DSA ,
94.Fn EVP_PKEY_get1_DH ,
95and
96.Fn EVP_PKEY_get1_EC_KEY
97return the key referenced in
98.Fa pkey
99or
100.Dv NULL
101if the key is not of the correct type.
102.Pp
103.Fn EVP_PKEY_assign_RSA ,
104.Fn EVP_PKEY_assign_DSA ,
105.Fn EVP_PKEY_assign_DH ,
106and
107.Fn EVP_PKEY_assign_EC_KEY
108also set the referenced key to
109.Fa key ;
110however these use the supplied
111.Fa key
112internally and so
113.Fa key
114will be freed when the parent
115.Fa pkey
116is freed.
117.Pp
118.Fn EVP_PKEY_type
119returns the type of key corresponding to the value
120.Fa type .
121The type of a key can be obtained with
122.Fn EVP_PKEY_type pkey->type .
123The return value will be
124.Dv EVP_PKEY_RSA ,
125.Dv EVP_PKEY_DSA ,
126.Dv EVP_PKEY_DH ,
127or
128.Dv EVP_PKEY_EC
129for the corresponding key types or
130.Dv NID_undef
131if the key type is unassigned.
132.Pp
133In accordance with the OpenSSL naming convention, the key obtained from
134or assigned to
135.Fa pkey
136using the
137.Sy 1
138functions must be freed as well as
139.Fa pkey .
140.Pp
141.Fn EVP_PKEY_assign_RSA ,
142.Fn EVP_PKEY_assign_DSA ,
143.Fn EVP_PKEY_assign_DH ,
144and
145.Fn EVP_PKEY_assign_EC_KEY
146are implemented as macros.
147.Sh RETURN VALUES
148.Fn EVP_PKEY_set1_RSA ,
149.Fn EVP_PKEY_set1_DSA ,
150.Fn EVP_PKEY_set1_DH ,
151and
152.Fn EVP_PKEY_set1_EC_KEY
153return 1 for success or 0 for failure.
154.Pp
155.Fn EVP_PKEY_get1_RSA ,
156.Fn EVP_PKEY_get1_DSA ,
157.Fn EVP_PKEY_get1_DH ,
158and
159.Fn EVP_PKEY_get1_EC_KEY
160return the referenced key or
161.Dv NULL
162if an error occurred.
163.Pp
164.Fn EVP_PKEY_assign_RSA ,
165.Fn EVP_PKEY_assign_DSA ,
166.Fn EVP_PKEY_assign_DH ,
167and
168.Fn EVP_PKEY_assign_EC_KEY
169return 1 for success and 0 for failure.
170.Sh SEE ALSO
171.Xr EVP_PKEY_new 3