summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authortb <>2023-12-21 21:32:01 +0000
committertb <>2023-12-21 21:32:01 +0000
commit34d8cdfef0cdd7085a42bc158cd2b62057e4b0f7 (patch)
treee45bd200fd03f43877e3b4ed176b8ec6b67c2e6d /src/lib
parente6e9768e352ef37eb0f2fcbb2e1e41f7f1cc3f28 (diff)
downloadopenbsd-34d8cdfef0cdd7085a42bc158cd2b62057e4b0f7.tar.gz
openbsd-34d8cdfef0cdd7085a42bc158cd2b62057e4b0f7.tar.bz2
openbsd-34d8cdfef0cdd7085a42bc158cd2b62057e4b0f7.zip
Remove EVP_PKEY_asn1_add{0,_alias}() documentation
This API was recently neutered and will be removed in the next major bump. Mark it as intentionally undocumented in EVP_PKEY_asn1_new.3 and remove it from all other manuals.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/EVP_PKCS82PKEY.37
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_asn1_get_count.319
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_asn1_new.356
-rw-r--r--src/lib/libcrypto/man/EVP_PKEY_set1_RSA.310
4 files changed, 14 insertions, 78 deletions
diff --git a/src/lib/libcrypto/man/EVP_PKCS82PKEY.3 b/src/lib/libcrypto/man/EVP_PKCS82PKEY.3
index 5fed846fe6..0f66673886 100644
--- a/src/lib/libcrypto/man/EVP_PKCS82PKEY.3
+++ b/src/lib/libcrypto/man/EVP_PKCS82PKEY.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_PKCS82PKEY.3,v 1.1 2021/10/25 13:48:12 schwarze Exp $ 1.\" $OpenBSD: EVP_PKCS82PKEY.3,v 1.2 2023/12/21 21:32:01 tb Exp $
2.\" 2.\"
3.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> 3.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
4.\" 4.\"
@@ -14,7 +14,7 @@
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\" 16.\"
17.Dd $Mdocdate: October 25 2021 $ 17.Dd $Mdocdate: December 21 2023 $
18.Dt EVP_PKCS82PKEY 3 18.Dt EVP_PKCS82PKEY 3
19.Os 19.Os
20.Sh NAME 20.Sh NAME
@@ -40,8 +40,6 @@ structure representing the private key contained in
40.Fa pkey . 40.Fa pkey .
41.Pp 41.Pp
42Supported algorithms include DH, DSA, EC, GOST2001, and RSA. 42Supported algorithms include DH, DSA, EC, GOST2001, and RSA.
43Application programs can add additional algorithms using
44.Xr EVP_PKEY_asn1_add0 3 .
45.Sh RETURN VALUES 43.Sh RETURN VALUES
46These functions return a newly allocated object or 44These functions return a newly allocated object or
47.Dv NULL 45.Dv NULL
@@ -51,7 +49,6 @@ or
51.Fa pkey 49.Fa pkey
52is unsupported or if memory allocation, decoding, or encoding fails. 50is unsupported or if memory allocation, decoding, or encoding fails.
53.Sh SEE ALSO 51.Sh SEE ALSO
54.Xr EVP_PKEY_asn1_add0 3 ,
55.Xr EVP_PKEY_base_id 3 , 52.Xr EVP_PKEY_base_id 3 ,
56.Xr EVP_PKEY_new 3 , 53.Xr EVP_PKEY_new 3 ,
57.Xr PKCS8_pkey_set0 3 , 54.Xr PKCS8_pkey_set0 3 ,
diff --git a/src/lib/libcrypto/man/EVP_PKEY_asn1_get_count.3 b/src/lib/libcrypto/man/EVP_PKEY_asn1_get_count.3
index 9f272a2426..85a6471aeb 100644
--- a/src/lib/libcrypto/man/EVP_PKEY_asn1_get_count.3
+++ b/src/lib/libcrypto/man/EVP_PKEY_asn1_get_count.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_PKEY_asn1_get_count.3,v 1.7 2023/09/13 13:55:50 schwarze Exp $ 1.\" $OpenBSD: EVP_PKEY_asn1_get_count.3,v 1.8 2023/12/21 21:32:01 tb Exp $
2.\" full merge up to: OpenSSL 72a7a702 Feb 26 14:05:09 2019 +0000 2.\" full merge up to: OpenSSL 72a7a702 Feb 26 14:05:09 2019 +0000
3.\" 3.\"
4.\" This file is a derived work. 4.\" This file is a derived work.
@@ -65,7 +65,7 @@
65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
66.\" OF THE POSSIBILITY OF SUCH DAMAGE. 66.\" OF THE POSSIBILITY OF SUCH DAMAGE.
67.\" 67.\"
68.Dd $Mdocdate: September 13 2023 $ 68.Dd $Mdocdate: December 21 2023 $
69.Dt EVP_PKEY_ASN1_GET_COUNT 3 69.Dt EVP_PKEY_ASN1_GET_COUNT 3
70.Os 70.Os
71.Sh NAME 71.Sh NAME
@@ -111,7 +111,6 @@
111.Sh DESCRIPTION 111.Sh DESCRIPTION
112.Fn EVP_PKEY_asn1_get_count 112.Fn EVP_PKEY_asn1_get_count
113returns the number of public key ASN.1 methods available. 113returns the number of public key ASN.1 methods available.
114It includes standard methods and any methods added by the application.
115.Pp 114.Pp
116.Fn EVP_PKEY_asn1_get0 115.Fn EVP_PKEY_asn1_get0
117returns the public key ASN.1 method 116returns the public key ASN.1 method
@@ -185,8 +184,6 @@ object and will never be returned from
185.Fn EVP_PKEY_asn1_find 184.Fn EVP_PKEY_asn1_find
186or 185or
187.Fn EVP_PKEY_asn1_find_str . 186.Fn EVP_PKEY_asn1_find_str .
188It is either an alias built into the library, or it was created with
189.Xr EVP_PKEY_asn1_add_alias 3 .
190.It Dv ASN1_PKEY_DYNAMIC 187.It Dv ASN1_PKEY_DYNAMIC
191This 188This
192.Fa ameth 189.Fa ameth
@@ -218,18 +215,6 @@ objects with
218In particular, this is used for 215In particular, this is used for
219.Dv EVP_PKEY_RSA . 216.Dv EVP_PKEY_RSA .
220.El 217.El
221.Pp
222.Fn EVP_PKEY_asn1_get_count ,
223.Fn EVP_PKEY_asn1_get0 ,
224.Fn EVP_PKEY_asn1_find
225and
226.Fn EVP_PKEY_asn1_find_str
227are not thread safe, but as long as all
228.Vt EVP_PKEY_ASN1_METHOD
229objects are added before the application gets threaded, using them is
230safe.
231See
232.Xr EVP_PKEY_asn1_add0 3 .
233.Sh RETURN VALUES 218.Sh RETURN VALUES
234.Fn EVP_PKEY_asn1_get_count 219.Fn EVP_PKEY_asn1_get_count
235returns the number of available public key methods. 220returns the number of available public key methods.
diff --git a/src/lib/libcrypto/man/EVP_PKEY_asn1_new.3 b/src/lib/libcrypto/man/EVP_PKEY_asn1_new.3
index 82a109c57d..cd6a716907 100644
--- a/src/lib/libcrypto/man/EVP_PKEY_asn1_new.3
+++ b/src/lib/libcrypto/man/EVP_PKEY_asn1_new.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_PKEY_asn1_new.3,v 1.10 2023/09/13 14:18:21 schwarze Exp $ 1.\" $OpenBSD: EVP_PKEY_asn1_new.3,v 1.11 2023/12/21 21:32:01 tb Exp $
2.\" selective merge up to: 2.\" selective merge up to:
3.\" OpenSSL man3/EVP_PKEY_ASN1_METHOD b0004708 Nov 1 00:45:24 2017 +0800 3.\" OpenSSL man3/EVP_PKEY_ASN1_METHOD b0004708 Nov 1 00:45:24 2017 +0800
4.\" 4.\"
@@ -67,15 +67,16 @@
67.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 67.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
68.\" OF THE POSSIBILITY OF SUCH DAMAGE. 68.\" OF THE POSSIBILITY OF SUCH DAMAGE.
69.\" 69.\"
70.Dd $Mdocdate: September 13 2023 $ 70.Dd $Mdocdate: December 21 2023 $
71.Dt EVP_PKEY_ASN1_NEW 3 71.Dt EVP_PKEY_ASN1_NEW 3
72.Os 72.Os
73.Sh NAME 73.Sh NAME
74.\" .Nm EVP_PKEY_asn1_add0 and
75.\" .Nm EVP_PKEY_asn1_add_alias are intentionally undocumented
76.\" because they will be removed in the next major bump
74.Nm EVP_PKEY_asn1_new , 77.Nm EVP_PKEY_asn1_new ,
75.Nm EVP_PKEY_asn1_copy , 78.Nm EVP_PKEY_asn1_copy ,
76.Nm EVP_PKEY_asn1_free , 79.Nm EVP_PKEY_asn1_free ,
77.Nm EVP_PKEY_asn1_add0 ,
78.Nm EVP_PKEY_asn1_add_alias ,
79.Nm EVP_PKEY_asn1_set_public , 80.Nm EVP_PKEY_asn1_set_public ,
80.Nm EVP_PKEY_asn1_set_private , 81.Nm EVP_PKEY_asn1_set_private ,
81.Nm EVP_PKEY_asn1_set_param , 82.Nm EVP_PKEY_asn1_set_param ,
@@ -104,15 +105,6 @@
104.Fo EVP_PKEY_asn1_free 105.Fo EVP_PKEY_asn1_free
105.Fa "EVP_PKEY_ASN1_METHOD *ameth" 106.Fa "EVP_PKEY_ASN1_METHOD *ameth"
106.Fc 107.Fc
107.Ft int
108.Fo EVP_PKEY_asn1_add0
109.Fa "const EVP_PKEY_ASN1_METHOD *ameth"
110.Fc
111.Ft int
112.Fo EVP_PKEY_asn1_add_alias
113.Fa "int to"
114.Fa "int from"
115.Fc
116.Ft void 108.Ft void
117.Fo EVP_PKEY_asn1_set_public 109.Fo EVP_PKEY_asn1_set_public
118.Fa "EVP_PKEY_ASN1_METHOD *ameth" 110.Fa "EVP_PKEY_ASN1_METHOD *ameth"
@@ -179,13 +171,10 @@
179is a structure which holds a set of ASN.1 conversion, printing and 171is a structure which holds a set of ASN.1 conversion, printing and
180information methods for a specific public key algorithm. 172information methods for a specific public key algorithm.
181.Pp 173.Pp
182There are two places where the 174The built-in
183.Vt EVP_PKEY_ASN1_METHOD 175.Vt EVP_PKEY_ASN1_METHOD
184objects are stored: one is a built-in array representing the standard 176objects are stored in a table containing the standard
185methods for different algorithms, and the other one is a stack of 177methods for different algorithms.
186user-defined application-specific methods, which can be manipulated by
187using
188.Fn EVP_PKEY_asn1_add0 .
189.Ss Methods 178.Ss Methods
190The methods are the underlying implementations of a particular public 179The methods are the underlying implementations of a particular public
191key algorithm present by the 180key algorithm present by the
@@ -467,28 +456,6 @@ is
467.Dv NULL 456.Dv NULL
468of not marked as dynamically allocated, no action occurs. 457of not marked as dynamically allocated, no action occurs.
469.Pp 458.Pp
470.Fn EVP_PKEY_asn1_add0
471adds
472.Fa ameth
473to the user defined stack of methods unless another
474.Vt EVP_PKEY_ASN1_METHOD
475with the same NID is already there.
476This function is not thread safe, it is recommended to only use this when
477initializing the application.
478.Pp
479.Fn EVP_PKEY_asn1_add_alias
480creates an alias with the NID
481.Fa to
482for the
483.Vt EVP_PKEY_ASN1_METHOD
484with NID
485.Fa from
486unless another
487.Vt EVP_PKEY_ASN1_METHOD
488with the same NID is already added.
489This function is not thread safe, it's recommended to only use this when
490initializing the application.
491.Pp
492.Fn EVP_PKEY_asn1_set_public , 459.Fn EVP_PKEY_asn1_set_public ,
493.Fn EVP_PKEY_asn1_set_private , 460.Fn EVP_PKEY_asn1_set_private ,
494.Fn EVP_PKEY_asn1_set_param , 461.Fn EVP_PKEY_asn1_set_param ,
@@ -509,11 +476,6 @@ returns a pointer to the new
509object or 476object or
510.Dv NULL 477.Dv NULL
511if memory allocation fails. 478if memory allocation fails.
512.Pp
513.Fn EVP_PKEY_asn1_add0
514and
515.Fn EVP_PKEY_asn1_add_alias
516return 0 on error or 1 on success.
517.Sh SEE ALSO 479.Sh SEE ALSO
518.Xr EVP_PKEY_asn1_get_count 3 , 480.Xr EVP_PKEY_asn1_get_count 3 ,
519.Xr EVP_PKEY_new 3 , 481.Xr EVP_PKEY_new 3 ,
@@ -522,8 +484,6 @@ return 0 on error or 1 on success.
522.Fn EVP_PKEY_asn1_new , 484.Fn EVP_PKEY_asn1_new ,
523.Fn EVP_PKEY_asn1_copy , 485.Fn EVP_PKEY_asn1_copy ,
524.Fn EVP_PKEY_asn1_free , 486.Fn EVP_PKEY_asn1_free ,
525.Fn EVP_PKEY_asn1_add0 ,
526.Fn EVP_PKEY_asn1_add_alias ,
527.Fn EVP_PKEY_asn1_set_public , 487.Fn EVP_PKEY_asn1_set_public ,
528.Fn EVP_PKEY_asn1_set_private , 488.Fn EVP_PKEY_asn1_set_private ,
529.Fn EVP_PKEY_asn1_set_param , 489.Fn EVP_PKEY_asn1_set_param ,
diff --git a/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3 b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
index 4a382e1150..4825b6056e 100644
--- a/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
+++ b/src/lib/libcrypto/man/EVP_PKEY_set1_RSA.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: EVP_PKEY_set1_RSA.3,v 1.20 2023/08/27 13:08:15 schwarze Exp $ 1.\" $OpenBSD: EVP_PKEY_set1_RSA.3,v 1.21 2023/12/21 21:32:01 tb Exp $
2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
3.\" 3.\"
4.\" This file is a derived work. 4.\" This file is a derived work.
@@ -65,7 +65,7 @@
65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
66.\" OF THE POSSIBILITY OF SUCH DAMAGE. 66.\" OF THE POSSIBILITY OF SUCH DAMAGE.
67.\" 67.\"
68.Dd $Mdocdate: August 27 2023 $ 68.Dd $Mdocdate: December 21 2023 $
69.Dt EVP_PKEY_SET1_RSA 3 69.Dt EVP_PKEY_SET1_RSA 3
70.Os 70.Os
71.Sh NAME 71.Sh NAME
@@ -314,9 +314,6 @@ according to the following table:
314.It Dv EVP_PKEY_RSA_PSS Ta = Dv NID_rsassaPss Ta RSA-PSS 314.It Dv EVP_PKEY_RSA_PSS Ta = Dv NID_rsassaPss Ta RSA-PSS
315.El 315.El
316.Pp 316.Pp
317Application programs can support additional key types by calling
318.Xr EVP_PKEY_asn1_add0 3 .
319.Pp
320.Fn EVP_PKEY_id 317.Fn EVP_PKEY_id
321returns the actual OID associated with 318returns the actual OID associated with
322.Fa pkey . 319.Fa pkey .
@@ -334,9 +331,6 @@ The following deprecated aliases are still supported:
334.It Dv EVP_PKEY_RSA2 Ta = Dv NID_rsa Ta RSA 331.It Dv EVP_PKEY_RSA2 Ta = Dv NID_rsa Ta RSA
335.El 332.El
336.Pp 333.Pp
337Application programs can support additional alternative OIDs by calling
338.Xr EVP_PKEY_asn1_add_alias 3 .
339.Pp
340Most applications wishing to know a key type will simply call 334Most applications wishing to know a key type will simply call
341.Fn EVP_PKEY_base_id 335.Fn EVP_PKEY_base_id
342and will not care about the actual type, 336and will not care about the actual type,