Debian Codegraph @

upstream/debian-unstable/man3/EVP_SIGNATURE.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_SIGNATURE 3SSL"
58 .TH EVP_SIGNATURE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_SIGNATURE,
65 EVP_SIGNATURE_fetch, EVP_SIGNATURE_free, EVP_SIGNATURE_up_ref,
66 EVP_SIGNATURE_is_a, EVP_SIGNATURE_get0_provider,
67 EVP_SIGNATURE_do_all_provided, EVP_SIGNATURE_names_do_all,
68 EVP_SIGNATURE_get0_name, EVP_SIGNATURE_get0_description,
69 EVP_SIGNATURE_gettable_ctx_params, EVP_SIGNATURE_settable_ctx_params
70 \&\- Functions to manage EVP_SIGNATURE algorithm objects
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& #include <openssl/evp.h>
75 \&
76 \& typedef struct evp_signature_st EVP_SIGNATURE;
77 \&
78 \& EVP_SIGNATURE *EVP_SIGNATURE_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
79 \& const char *properties);
80 \& void EVP_SIGNATURE_free(EVP_SIGNATURE *signature);
81 \& int EVP_SIGNATURE_up_ref(EVP_SIGNATURE *signature);
82 \& const char *EVP_SIGNATURE_get0_name(const EVP_SIGNATURE *signature);
83 \& int EVP_SIGNATURE_is_a(const EVP_SIGNATURE *signature, const char *name);
84 \& OSSL_PROVIDER *EVP_SIGNATURE_get0_provider(const EVP_SIGNATURE *signature);
85 \& void EVP_SIGNATURE_do_all_provided(OSSL_LIB_CTX *libctx,
86 \& void (*fn)(EVP_SIGNATURE *signature,
87 \& void *arg),
88 \& void *arg);
89 \& int EVP_SIGNATURE_names_do_all(const EVP_SIGNATURE *signature,
90 \& void (*fn)(const char *name, void *data),
91 \& void *data);
92 \& const char *EVP_SIGNATURE_get0_name(const EVP_SIGNATURE *signature);
93 \& const char *EVP_SIGNATURE_get0_description(const EVP_SIGNATURE *signature);
94 \& const OSSL_PARAM *EVP_SIGNATURE_gettable_ctx_params(const EVP_SIGNATURE *sig);
95 \& const OSSL_PARAM *EVP_SIGNATURE_settable_ctx_params(const EVP_SIGNATURE *sig);
96 .Ve
97 .SH DESCRIPTION
98 .IX Header "DESCRIPTION"
99 \&\fBEVP_SIGNATURE_fetch()\fR fetches the implementation for the given
100 \&\fBalgorithm\fR from any provider offering it, within the criteria given
101 by the \fBproperties\fR.
102 The algorithm will be one offering functions for performing signature related
103 tasks such as signing and verifying.
104 See "ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for further information.
105 .PP
106 The returned value must eventually be freed with \fBEVP_SIGNATURE_free()\fR.
107 .PP
108 \&\fBEVP_SIGNATURE_free()\fR decrements the reference count for the \fBEVP_SIGNATURE\fR
109 structure. Typically this structure will have been obtained from an earlier call
110 to \fBEVP_SIGNATURE_fetch()\fR. If the reference count drops to 0 then the
111 structure is freed. If the argument is NULL, nothing is done.
112 .PP
113 \&\fBEVP_SIGNATURE_up_ref()\fR increments the reference count for an \fBEVP_SIGNATURE\fR
114 structure.
115 .PP
116 \&\fBEVP_SIGNATURE_is_a()\fR returns 1 if \fIsignature\fR is an implementation of an
117 algorithm that's identifiable with \fIname\fR, otherwise 0.
118 .PP
119 \&\fBEVP_SIGNATURE_get0_provider()\fR returns the provider that \fIsignature\fR was
120 fetched from.
121 .PP
122 \&\fBEVP_SIGNATURE_do_all_provided()\fR traverses all SIGNATURE implemented by all
123 activated providers in the given library context \fIlibctx\fR, and for each of the
124 implementations, calls the given function \fIfn\fR with the implementation method
125 and the given \fIarg\fR as argument.
126 .PP
127 \&\fBEVP_SIGNATURE_get0_name()\fR returns the algorithm name from the provided
128 implementation for the given \fIsignature\fR. Note that the \fIsignature\fR may have
129 multiple synonyms associated with it. In this case the first name from the
130 algorithm definition is returned. Ownership of the returned string is retained
131 by the \fIsignature\fR object and should not be freed by the caller.
132 .PP
133 \&\fBEVP_SIGNATURE_names_do_all()\fR traverses all names for \fIsignature\fR, and calls
134 \&\fIfn\fR with each name and \fIdata\fR.
135 .PP
136 \&\fBEVP_SIGNATURE_get0_description()\fR returns a description of the \fIsignature\fR,
137 meant for display and human consumption. The description is at the
138 discretion of the \fIsignature\fR implementation.
139 .PP
140 \&\fBEVP_SIGNATURE_gettable_ctx_params()\fR and \fBEVP_SIGNATURE_settable_ctx_params()\fR
141 return a constant \fBOSSL_PARAM\fR\|(3) array that describes the names and types of key
142 parameters that can be retrieved or set by a signature algorithm using
143 \&\fBEVP_PKEY_CTX_get_params\fR\|(3) and \fBEVP_PKEY_CTX_set_params\fR\|(3).
144 .SH "RETURN VALUES"
145 .IX Header "RETURN VALUES"
146 \&\fBEVP_SIGNATURE_fetch()\fR returns a pointer to an \fBEVP_SIGNATURE\fR for success
147 or \fBNULL\fR for failure.
148 .PP
149 \&\fBEVP_SIGNATURE_up_ref()\fR returns 1 for success or 0 otherwise.
150 .PP
151 \&\fBEVP_SIGNATURE_names_do_all()\fR returns 1 if the callback was called for all names.
152 A return value of 0 means that the callback was not called for any names.
153 .PP
154 \&\fBEVP_SIGNATURE_gettable_ctx_params()\fR and \fBEVP_SIGNATURE_settable_ctx_params()\fR
155 return a constant \fBOSSL_PARAM\fR\|(3) array or NULL on error.
156 .SH "SEE ALSO"
157 .IX Header "SEE ALSO"
158 "ALGORITHM FETCHING" in \fBcrypto\fR\|(7), \fBOSSL_PROVIDER\fR\|(3)
159 .SH HISTORY
160 .IX Header "HISTORY"
161 The functions described here were added in OpenSSL 3.0.
162 .SH COPYRIGHT
163 .IX Header "COPYRIGHT"
164 Copyright 2019\-2024 The OpenSSL Project Authors. All Rights Reserved.
165 .PP
166 Licensed under the Apache License 2.0 (the "License"). You may not use
167 this file except in compliance with the License. You can obtain a copy
168 in the file LICENSE in the source distribution or at
169 <https://www.openssl.org/source/license.html>.