diff options
author | tb <> | 2023-07-21 05:02:53 +0000 |
---|---|---|
committer | tb <> | 2023-07-21 05:02:53 +0000 |
commit | ec8c97dd8ab81c0eb4832547799104415b457d4d (patch) | |
tree | f4299676bafd4c94acbb1c4e7cc115c1a14edb85 /src/lib/libcrypto/man/OBJ_add_sigid.3 | |
parent | c8e14d21085a5664fe144bcce79739faa47cd45b (diff) | |
download | openbsd-ec8c97dd8ab81c0eb4832547799104415b457d4d.tar.gz openbsd-ec8c97dd8ab81c0eb4832547799104415b457d4d.tar.bz2 openbsd-ec8c97dd8ab81c0eb4832547799104415b457d4d.zip |
Remove OBJ_add_sigid and OBJ_sigid_free documentation
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.
Diffstat (limited to 'src/lib/libcrypto/man/OBJ_add_sigid.3')
-rw-r--r-- | src/lib/libcrypto/man/OBJ_add_sigid.3 | 42 |
1 files changed, 4 insertions, 38 deletions
diff --git a/src/lib/libcrypto/man/OBJ_add_sigid.3 b/src/lib/libcrypto/man/OBJ_add_sigid.3 index abfe825e88..685fbfa07f 100644 --- a/src/lib/libcrypto/man/OBJ_add_sigid.3 +++ b/src/lib/libcrypto/man/OBJ_add_sigid.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: OBJ_add_sigid.3,v 1.1 2021/12/18 17:47:45 schwarze Exp $ | 1 | .\" $OpenBSD: OBJ_add_sigid.3,v 1.2 2023/07/21 05:02:53 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,26 +14,16 @@ | |||
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: December 18 2021 $ | 17 | .Dd $Mdocdate: July 21 2023 $ |
18 | .Dt OBJ_ADD_SIGID 3 | 18 | .Dt OBJ_ADD_SIGID 3 |
19 | .Os | 19 | .Os |
20 | .Sh NAME | 20 | .Sh NAME |
21 | .Nm OBJ_add_sigid , | ||
22 | .Nm OBJ_sigid_free , | ||
23 | .Nm OBJ_find_sigid_algs , | 21 | .Nm OBJ_find_sigid_algs , |
24 | .Nm OBJ_find_sigid_by_algs | 22 | .Nm OBJ_find_sigid_by_algs |
25 | .Nd signature algorithm mappings | 23 | .Nd signature algorithm mappings |
26 | .Sh SYNOPSIS | 24 | .Sh SYNOPSIS |
27 | .In openssl/objects.h | 25 | .In openssl/objects.h |
28 | .Ft int | 26 | .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 | 27 | .Fo OBJ_find_sigid_algs |
38 | .Fa "int signature" | 28 | .Fa "int signature" |
39 | .Fa "int *pdigest" | 29 | .Fa "int *pdigest" |
@@ -46,25 +36,6 @@ | |||
46 | .Fa "int encryption" | 36 | .Fa "int encryption" |
47 | .Fc | 37 | .Fc |
48 | .Sh DESCRIPTION | 38 | .Sh DESCRIPTION |
49 | .Fn OBJ_add_sigid | ||
50 | defines the | ||
51 | .Fa signature | ||
52 | algorithm to use the specified | ||
53 | .Fa digest | ||
54 | and | ||
55 | .Fa encryption | ||
56 | algorithms. | ||
57 | Making sure that this does not conflict with earlier invocations of | ||
58 | .Fn OBJ_add_sigid | ||
59 | is the responsibility of the caller. | ||
60 | Definitions made with | ||
61 | .Fn OBJ_add_sigid | ||
62 | take precedence over definitions built into the library. | ||
63 | .Pp | ||
64 | .Fn OBJ_sigid_free | ||
65 | deletes all definitions made with | ||
66 | .Fn OBJ_add_sigid . | ||
67 | .Pp | ||
68 | .Fn OBJ_find_sigid_algs | 39 | .Fn OBJ_find_sigid_algs |
69 | looks up the | 40 | looks up the |
70 | .Fa signature | 41 | .Fa signature |
@@ -94,16 +65,12 @@ is a | |||
94 | .Dv NULL | 65 | .Dv NULL |
95 | pointer. | 66 | pointer. |
96 | .Sh RETURN VALUES | 67 | .Sh RETURN VALUES |
97 | .Fn OBJ_add_sigid | ||
98 | returns 1 on success or 0 if memory allocation fails. | ||
99 | .Pp | ||
100 | .Fn OBJ_find_sigid_algs | 68 | .Fn OBJ_find_sigid_algs |
101 | returns 1 if a definition of the | 69 | returns 1 if a definition of the |
102 | .Fa signature | 70 | .Fa signature |
103 | algorithm is found or 0 if a definition of the | 71 | algorithm is found or 0 if a definition of the |
104 | .Fa signature | 72 | .Fa signature |
105 | algorithm is neither built into the library nor provided with | 73 | algorithm is not built into the library. |
106 | .Fn OBJ_add_sigid . | ||
107 | .Pp | 74 | .Pp |
108 | .Fn OBJ_find_sigid_by_algs | 75 | .Fn OBJ_find_sigid_by_algs |
109 | returns 1 if a signature algorithm using the specified | 76 | returns 1 if a signature algorithm using the specified |
@@ -111,8 +78,7 @@ returns 1 if a signature algorithm using the specified | |||
111 | and | 78 | and |
112 | .Fa encryption | 79 | .Fa encryption |
113 | algorithms is defined or 0 if the definition of such an algorithm | 80 | algorithms is defined or 0 if the definition of such an algorithm |
114 | is neither built into the library nor provided with | 81 | is not built into the library. |
115 | .Fn OBJ_add_sigid . | ||
116 | .Sh SEE ALSO | 82 | .Sh SEE ALSO |
117 | .Xr EVP_cleanup 3 , | 83 | .Xr EVP_cleanup 3 , |
118 | .Xr OBJ_create 3 , | 84 | .Xr OBJ_create 3 , |