summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man/OBJ_find_sigid_algs.3
blob: 1d7a2b649beb03c56161aeb350654b4d5516e105 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.\" $OpenBSD: OBJ_find_sigid_algs.3,v 1.2 2024/01/31 08:02:53 tb Exp $
.\"
.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate: January 31 2024 $
.Dt OBJ_FIND_SIGID_ALGS 3
.Os
.Sh NAME
.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_find_sigid_algs
.Fa "int signature"
.Fa "int *pdigest"
.Fa "int *pencryption"
.Fc
.Ft int
.Fo OBJ_find_sigid_by_algs
.Fa "int *psignature"
.Fa "int digest"
.Fa "int encryption"
.Fc
.Sh DESCRIPTION
.Fn OBJ_find_sigid_algs
looks up the
.Fa signature
algorithm.
If it is found, the associated digest algorithm is stored in
.Pf * Fa pdigest
unless
.Fa pdigest
is a
.Dv NULL
pointer, and the associated encryption algorithm is stored in
.Pf * Fa pencryption
unless
.Fa pencryption
is a
.Dv NULL
pointer.
.Pp
.Fn OBJ_find_sigid_by_algs
looks up the pair
.Pq Fa digest , encryption .
If it is found, the associated signature algorithm is stored in
.Pf * Fa psignature
unless
.Fa psignature
is a
.Dv NULL
pointer.
.Sh RETURN VALUES
.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 not built into the library.
.Pp
.Fn OBJ_find_sigid_by_algs
returns 1 if a signature algorithm using the specified
.Fa digest
and
.Fa encryption
algorithms is defined or 0 if the definition of such an algorithm
is not built into the library.
.Sh SEE ALSO
.Xr EVP_cleanup 3 ,
.Xr OBJ_create 3 ,
.Xr OBJ_nid2obj 3
.Sh HISTORY
These functions first appeared in OpenSSL 1.0.0
and have been available since
.Ox 4.9 .