summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/OBJ_add_sigid.3
diff options
context:
space:
mode:
authorschwarze <>2021-12-18 17:47:45 +0000
committerschwarze <>2021-12-18 17:47:45 +0000
commit41fcc6b5e0fadf216f047f3ac32e97de6603fd6b (patch)
tree910b00af2161542e9a62b69fd3d2435e011e0314 /src/lib/libcrypto/man/OBJ_add_sigid.3
parentf7d305590a6bc15a77694a68f5c4e5913c8aadf5 (diff)
downloadopenbsd-41fcc6b5e0fadf216f047f3ac32e97de6603fd6b.tar.gz
openbsd-41fcc6b5e0fadf216f047f3ac32e97de6603fd6b.tar.bz2
openbsd-41fcc6b5e0fadf216f047f3ac32e97de6603fd6b.zip
new manual page OBJ_add_sigid(3)
Diffstat (limited to 'src/lib/libcrypto/man/OBJ_add_sigid.3')
-rw-r--r--src/lib/libcrypto/man/OBJ_add_sigid.3124
1 files changed, 124 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/OBJ_add_sigid.3 b/src/lib/libcrypto/man/OBJ_add_sigid.3
new file mode 100644
index 0000000000..abfe825e88
--- /dev/null
+++ b/src/lib/libcrypto/man/OBJ_add_sigid.3
@@ -0,0 +1,124 @@
1.\" $OpenBSD: OBJ_add_sigid.3,v 1.1 2021/12/18 17:47:45 schwarze Exp $
2.\"
3.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: December 18 2021 $
18.Dt OBJ_ADD_SIGID 3
19.Os
20.Sh NAME
21.Nm OBJ_add_sigid ,
22.Nm OBJ_sigid_free ,
23.Nm OBJ_find_sigid_algs ,
24.Nm OBJ_find_sigid_by_algs
25.Nd signature algorithm mappings
26.Sh SYNOPSIS
27.In openssl/objects.h
28.Ft int
29.Fo OBJ_add_sigid
30.Fa "int signature"
31.Fa "int digest"
32.Fa "int encryption"
33.Fc
34.Ft void
35.Fn OBJ_sigid_free void
36.Ft int
37.Fo OBJ_find_sigid_algs
38.Fa "int signature"
39.Fa "int *pdigest"
40.Fa "int *pencryption"
41.Fc
42.Ft int
43.Fo OBJ_find_sigid_by_algs
44.Fa "int *psignature"
45.Fa "int digest"
46.Fa "int encryption"
47.Fc
48.Sh DESCRIPTION
49.Fn OBJ_add_sigid
50defines the
51.Fa signature
52algorithm to use the specified
53.Fa digest
54and
55.Fa encryption
56algorithms.
57Making sure that this does not conflict with earlier invocations of
58.Fn OBJ_add_sigid
59is the responsibility of the caller.
60Definitions made with
61.Fn OBJ_add_sigid
62take precedence over definitions built into the library.
63.Pp
64.Fn OBJ_sigid_free
65deletes all definitions made with
66.Fn OBJ_add_sigid .
67.Pp
68.Fn OBJ_find_sigid_algs
69looks up the
70.Fa signature
71algorithm.
72If it is found, the associated digest algorithm is stored in
73.Pf * Fa pdigest
74unless
75.Fa pdigest
76is a
77.Dv NULL
78pointer, and the associated encryption algorithm is stored in
79.Pf * Fa pencryption
80unless
81.Fa pencryption
82is a
83.Dv NULL
84pointer.
85.Pp
86.Fn OBJ_find_sigid_by_algs
87looks up the pair
88.Pq Fa digest , encryption .
89If it is found, the associated signature algorithm is stored in
90.Pf * Fa psignature
91unless
92.Fa psignature
93is a
94.Dv NULL
95pointer.
96.Sh RETURN VALUES
97.Fn OBJ_add_sigid
98returns 1 on success or 0 if memory allocation fails.
99.Pp
100.Fn OBJ_find_sigid_algs
101returns 1 if a definition of the
102.Fa signature
103algorithm is found or 0 if a definition of the
104.Fa signature
105algorithm is neither built into the library nor provided with
106.Fn OBJ_add_sigid .
107.Pp
108.Fn OBJ_find_sigid_by_algs
109returns 1 if a signature algorithm using the specified
110.Fa digest
111and
112.Fa encryption
113algorithms is defined or 0 if the definition of such an algorithm
114is neither built into the library nor provided with
115.Fn OBJ_add_sigid .
116.Sh SEE ALSO
117.Xr EVP_cleanup 3 ,
118.Xr OBJ_create 3 ,
119.Xr OBJ_NAME_add 3 ,
120.Xr OBJ_nid2obj 3
121.Sh HISTORY
122These functions first appeared in OpenSSL 1.0.0
123and have been available since
124.Ox 4.9 .