Debian Codegraph @

upstream/debian-unstable/man3/X509V3_set_ctx.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 "X509V3_SET_CTX 3SSL"
58 .TH X509V3_SET_CTX 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 X509V3_set_ctx,
65 X509V3_set_issuer_pkey \- X.509 v3 extension generation utilities
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/x509v3.h>
70 \&
71 \& void X509V3_set_ctx(X509V3_CTX *ctx, X509 *issuer, X509 *subject,
72 \& X509_REQ *req, X509_CRL *crl, int flags);
73 \& int X509V3_set_issuer_pkey(X509V3_CTX *ctx, EVP_PKEY *pkey);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 \&\fBX509V3_set_ctx()\fR fills in the basic fields of \fIctx\fR of type \fBX509V3_CTX\fR,
78 providing details potentially needed by functions producing X509 v3 extensions.
79 These may make use of fields of the certificate \fIsubject\fR, the certification
80 request \fIreq\fR, or the certificate revocation list \fIcrl\fR.
81 At most one of these three parameters can be non-NULL.
82 When constructing the subject key identifier of a certificate by computing a
83 hash value of its public key, the public key is taken from \fIsubject\fR or \fIreq\fR.
84 Similarly, when constructing subject alternative names from any email addresses
85 contained in a subject DN, the subject DN is taken from \fIsubject\fR or \fIreq\fR.
86 If \fIsubject\fR or \fIcrl\fR is provided, \fIissuer\fR should point to its issuer, for
87 instance as a reference for generating the authority key identifier extension.
88 \&\fIissuer\fR may be the same pointer value as \fIsubject\fR (which usually is an
89 indication that the \fIsubject\fR certificate is self-issued or even self-signed).
90 In this case the fallback source for generating the authority key identifier
91 extension will be taken from any value provided using \fBX509V3_set_issuer_pkey()\fR.
92 \&\fIflags\fR may be 0
93 or contain \fBX509V3_CTX_TEST\fR, which means that just the syntax of
94 extension definitions is to be checked without actually producing any extension,
95 or \fBX509V3_CTX_REPLACE\fR, which means that each X.509v3 extension added as
96 defined in some configuration section shall replace any already existing
97 extension with the same OID.
98 .PP
99 \&\fBX509V3_set_issuer_pkey()\fR explicitly sets the issuer private key of
100 the subject certificate that has been provided in \fIctx\fR.
101 This should be done in case the \fIissuer\fR and \fIsubject\fR arguments to
102 \&\fBX509V3_set_ctx()\fR have the same pointer value
103 to provide fallback data for the authority key identifier extension.
104 .SH "RETURN VALUES"
105 .IX Header "RETURN VALUES"
106 \&\fBX509V3_set_issuer_pkey()\fR returns 1 on success and 0 on error.
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBX509_add_ext\fR\|(3)
110 .SH HISTORY
111 .IX Header "HISTORY"
112 \&\fBX509V3_set_issuer_pkey()\fR was added in OpenSSL 3.0.
113 .PP
114 CTX_TEST was deprecated in OpenSSL 3.0; use X509V3_CTX_TEST instead.
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2015\-2025 The OpenSSL Project Authors. All Rights Reserved.
118 .PP
119 Licensed under the Apache License 2.0 (the "License"). You may not use
120 this file except in compliance with the License. You can obtain a copy
121 in the file LICENSE in the source distribution or at
122 <https://www.openssl.org/source/license.html>.