Debian Codegraph @

upstream/debian-unstable/man3/EVP_PKEY_CTX_get_algor.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_PKEY_CTX_GET_ALGOR 3SSL"
58 .TH EVP_PKEY_CTX_GET_ALGOR 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_CIPHER_CTX_get_algor,
65 EVP_CIPHER_CTX_get_algor_params,
66 EVP_CIPHER_CTX_set_algor_params,
67 EVP_PKEY_CTX_get_algor,
68 EVP_PKEY_CTX_get_algor_params,
69 EVP_PKEY_CTX_set_algor_params
70 \&\- pass AlgorithmIdentifier and its params to/from algorithm implementations
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 3
74 \& int EVP_TYPE_CTX_get_algor(EVP_TYPE_CTX *ctx, X509_ALGOR **alg);
75 \& int EVP_TYPE_CTX_get_algor_params(EVP_TYPE_CTX *ctx, X509_ALGOR *alg);
76 \& int EVP_TYPE_CTX_set_algor_params(EVP_TYPE_CTX *ctx, const X509_ALGOR *alg);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 In the description here and the "SYNOPSIS" above, \fR\f(BITYPE\fR\fB\fR is used as a
81 placeholder for any EVP operation type.
82 .PP
83 \&\fBEVP_\fR\f(BITYPE\fR\fB_CTX_get_algor\fR() attempts to retrieve a complete
84 AlgorithmIdentifier from the \fBEVP_\fR\f(BITYPE\fR implementation, and populates
85 \&\fI*alg\fR with it.
86 If \fIalg\fR is NULL, calling this function will serve to see if calling this
87 function is supported at all by the \fBEVP_\fR\f(BITYPE\fR\fB\fR implementation.
88 If \fI*alg\fR is NULL, space will be allocated automatically, and assigned to
89 \&\fI*alg\fR.
90 .PP
91 \&\fBEVP_\fR\f(BITYPE\fR\fB_CTX_get_algor_params\fR() attempts to retrieve the \fIparameters\fR
92 part of an AlgorithmIdentifier from the \fBEVP_\fR\f(BITYPE\fR implementation, and
93 populates \fIalg\-\fRparameters> with it.
94 If \fIalg\fR is NULL, calling this function will serve to see if calling this
95 function is supported at all by the \fBEVP_\fR\f(BITYPE\fR\fB\fR implementation.
96 If \fIalg\->parameters\fR is NULL, space will be allocated automatically, and
97 assigned to \fIalg\->parameters\fR.
98 If \fIalg\->parameters\fR is not NULL, its previous contents will be overwritten
99 with the retrieved AlgorithmIdentifier parameters. Beware!
100 .PP
101 \&\fBEVP_\fR\f(BITYPE\fR\fB_CTX_set_algor_params\fR() attempts to pass \fIalg\->parameters\fR
102 to the \fBEVP_\fR\f(BITYPE\fR implementation.
103 If \fIalg\fR is NULL, calling this function will serve to see if calling this
104 function is supported at all by the \fBEVP_\fR\f(BITYPE\fR\fB\fR implementation.
105 .SH "RETURN VALUES"
106 .IX Header "RETURN VALUES"
107 All functions return 1 for success, and 0 or a negative number if an error
108 occurs. In particular, \-2 is returned when the function isn't supported by
109 the \fBEVP_\fR\f(BITYPE\fR implementation.
110 .SH HISTORY
111 .IX Header "HISTORY"
112 These functions were added in OpenSSL 3.4.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.