Remove OBJ_add_sigid and OBJ_sigid_free documentation
authortb <tb@openbsd.org>
Fri, 21 Jul 2023 05:02:53 +0000 (05:02 +0000)
committertb <tb@openbsd.org>
Fri, 21 Jul 2023 05:02:53 +0000 (05:02 +0000)
These will be made internal and will likely go away.  The OBJ_add_sigid.3
manual should probably be renamed; this can be done in a second step.

lib/libcrypto/man/OBJ_NAME_add.3
lib/libcrypto/man/OBJ_add_sigid.3
lib/libcrypto/man/OBJ_create.3
lib/libcrypto/man/OBJ_nid2obj.3
lib/libcrypto/man/OpenSSL_add_all_algorithms.3

index 6d57416..685619d 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: OBJ_NAME_add.3,v 1.3 2022/09/10 10:22:46 jsg Exp $
+.\" $OpenBSD: OBJ_NAME_add.3,v 1.4 2023/07/21 05:02:53 tb Exp $
 .\"
 .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: September 10 2022 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt OBJ_NAME_ADD 3
 .Os
 .Sh NAME
@@ -315,7 +315,6 @@ representing the new type or 0 if memory allocation fails.
 .Xr EVP_get_cipherbyname 3 ,
 .Xr EVP_get_digestbyname 3 ,
 .Xr lh_new 3 ,
-.Xr OBJ_add_sigid 3 ,
 .Xr OBJ_create 3 ,
 .Xr OBJ_nid2obj 3
 .Sh BUGS
index abfe825..685fbfa 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: OBJ_add_sigid.3,v 1.1 2021/12/18 17:47:45 schwarze Exp $
+.\" $OpenBSD: OBJ_add_sigid.3,v 1.2 2023/07/21 05:02:53 tb Exp $
 .\"
 .\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 18 2021 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt OBJ_ADD_SIGID 3
 .Os
 .Sh NAME
-.Nm OBJ_add_sigid ,
-.Nm OBJ_sigid_free ,
 .Nm OBJ_find_sigid_algs ,
 .Nm OBJ_find_sigid_by_algs
 .Nd signature algorithm mappings
 .Sh SYNOPSIS
 .In openssl/objects.h
 .Ft int
-.Fo OBJ_add_sigid
-.Fa "int signature"
-.Fa "int digest"
-.Fa "int encryption"
-.Fc
-.Ft void
-.Fn OBJ_sigid_free void
-.Ft int
 .Fo OBJ_find_sigid_algs
 .Fa "int signature"
 .Fa "int *pdigest"
 .Fa "int encryption"
 .Fc
 .Sh DESCRIPTION
-.Fn OBJ_add_sigid
-defines the
-.Fa signature
-algorithm to use the specified
-.Fa digest
-and
-.Fa encryption
-algorithms.
-Making sure that this does not conflict with earlier invocations of
-.Fn OBJ_add_sigid
-is the responsibility of the caller.
-Definitions made with
-.Fn OBJ_add_sigid
-take precedence over definitions built into the library.
-.Pp
-.Fn OBJ_sigid_free
-deletes all definitions made with
-.Fn OBJ_add_sigid .
-.Pp
 .Fn OBJ_find_sigid_algs
 looks up the
 .Fa signature
@@ -94,16 +65,12 @@ is a
 .Dv NULL
 pointer.
 .Sh RETURN VALUES
-.Fn OBJ_add_sigid
-returns 1 on success or 0 if memory allocation fails.
-.Pp
 .Fn OBJ_find_sigid_algs
 returns 1 if a definition of the
 .Fa signature
 algorithm is found or 0 if a definition of the
 .Fa signature
-algorithm is neither built into the library nor provided with
-.Fn OBJ_add_sigid .
+algorithm is not built into the library.
 .Pp
 .Fn OBJ_find_sigid_by_algs
 returns 1 if a signature algorithm using the specified
@@ -111,8 +78,7 @@ returns 1 if a signature algorithm using the specified
 and
 .Fa encryption
 algorithms is defined or 0 if the definition of such an algorithm
-is neither built into the library nor provided with
-.Fn OBJ_add_sigid .
+is not built into the library.
 .Sh SEE ALSO
 .Xr EVP_cleanup 3 ,
 .Xr OBJ_create 3 ,
index e587eb1..690c1c7 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: OBJ_create.3,v 1.6 2022/01/01 02:06:07 jsg Exp $
+.\" $OpenBSD: OBJ_create.3,v 1.7 2023/07/21 05:02:53 tb Exp $
 .\" full merge up to:
 .\" OpenSSL OBJ_nid2obj.pod 9b86974e Aug 17 15:21:33 2015 -0400
 .\" selective merge up to:
@@ -69,7 +69,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: January 1 2022 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt OBJ_CREATE 3
 .Os
 .Sh NAME
@@ -253,7 +253,6 @@ obj = OBJ_nid2obj(new_nid);
 .Sh SEE ALSO
 .Xr ASN1_OBJECT_new 3 ,
 .Xr EVP_cleanup 3 ,
-.Xr OBJ_add_sigid 3 ,
 .Xr OBJ_NAME_add 3 ,
 .Xr OBJ_nid2obj 3
 .Sh HISTORY
index 4b35762..62d67ac 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: OBJ_nid2obj.3,v 1.19 2022/03/31 17:27:17 naddy Exp $
+.\" $OpenBSD: OBJ_nid2obj.3,v 1.20 2023/07/21 05:02:53 tb Exp $
 .\" full merge up to: OpenSSL c264592d May 14 11:28:00 2006 +0000
 .\" selective merge up to: OpenSSL 35fd9953 May 28 14:49:38 2019 +0200
 .\"
@@ -67,7 +67,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: March 31 2022 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt OBJ_NID2OBJ 3
 .Os
 .Sh NAME
@@ -389,7 +389,6 @@ obj = OBJ_txt2obj("1.2.3.4", 1);
 .Xr ASN1_OBJECT_new 3 ,
 .Xr BIO_new 3 ,
 .Xr d2i_ASN1_OBJECT 3 ,
-.Xr OBJ_add_sigid 3 ,
 .Xr OBJ_create 3 ,
 .Xr OBJ_NAME_add 3
 .Sh HISTORY
index 908b344..364a6c1 100644 (file)
@@ -1,4 +1,4 @@
-.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.11 2021/12/18 17:47:45 schwarze Exp $
+.\" $OpenBSD: OpenSSL_add_all_algorithms.3,v 1.12 2023/07/21 05:02:53 tb Exp $
 .\" full merge up to: OpenSSL b3696a55 Sep 2 09:35:50 2017 -0400
 .\"
 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -48,7 +48,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: December 18 2021 $
+.Dd $Mdocdate: July 21 2023 $
 .Dt OPENSSL_ADD_ALL_ALGORITHMS 3
 .Os
 .Sh NAME
@@ -100,12 +100,10 @@ only the first call has an effect.
 .Fn EVP_cleanup
 removes all ciphers and digests from the table and also calls
 .Xr OBJ_NAME_cleanup 3
-with an argument of \-1 and
-.Xr OBJ_sigid_free 3 ,
+with an argument of \-1 ,
 thus resetting the global associative array of names
 and all signature algorithm definitions to their default states,
-removing all application-defined types, key-value pairs, aliases,
-and signature algorithm definitions,
+removing all application-defined types, key-value pairs, and aliases,
 including any that are unrelated to the EVP library.
 .Sh SEE ALSO
 .Xr evp 3 ,
@@ -113,7 +111,6 @@ including any that are unrelated to the EVP library.
 .Xr EVP_EncryptInit 3 ,
 .Xr OBJ_cleanup 3 ,
 .Xr OBJ_NAME_add 3 ,
-.Xr OBJ_sigid_free 3 ,
 .Xr OPENSSL_config 3
 .Sh HISTORY
 .Fn EVP_cleanup