Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_cert_store.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 "SSL_CTX_SET_CERT_STORE 3SSL"
58 .TH SSL_CTX_SET_CERT_STORE 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 SSL_CTX_set_cert_store, SSL_CTX_set1_cert_store, SSL_CTX_get_cert_store \- manipulate X509 certificate verification storage
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store);
71 \& void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *store);
72 \& X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_CTX_set_cert_store()\fR sets/replaces the certificate verification storage
77 of \fBctx\fR to/with \fBstore\fR. If another X509_STORE object is currently
78 set in \fBctx\fR, it will be \fBX509_STORE_free()\fRed. \fBSSL_CTX_set_cert_store()\fR will
79 take ownership of the \fBstore\fR, i.e., the call \f(CWX509_STORE_free(store)\fR is no
80 longer needed.
81 .PP
82 \&\fBSSL_CTX_set1_cert_store()\fR sets/replaces the certificate verification storage
83 of \fBctx\fR to/with \fBstore\fR. The \fBstore\fR's reference count is incremented.
84 If another X509_STORE object is currently set in \fBctx\fR, it will be \fBX509_STORE_free()\fRed.
85 .PP
86 \&\fBSSL_CTX_get_cert_store()\fR returns a pointer to the current certificate
87 verification storage. \fBctx\fR \fBMUST NOT\fR be NULL.
88 .SH NOTES
89 .IX Header "NOTES"
90 In order to verify the certificates presented by the peer, trusted CA
91 certificates must be accessed. These CA certificates are made available
92 via lookup methods, handled inside the X509_STORE. From the X509_STORE
93 the X509_STORE_CTX used when verifying certificates is created.
94 .PP
95 Typically the trusted certificate store is handled indirectly via using
96 \&\fBSSL_CTX_load_verify_locations\fR\|(3).
97 Using the \fBSSL_CTX_set_cert_store()\fR and \fBSSL_CTX_get_cert_store()\fR functions
98 it is possible to manipulate the X509_STORE object beyond the
99 \&\fBSSL_CTX_load_verify_locations\fR\|(3)
100 call.
101 .PP
102 Currently no detailed documentation on how to use the X509_STORE
103 object is available. Not all members of the X509_STORE are used when
104 the verification takes place. So will e.g. the \fBverify_callback()\fR be
105 overridden with the \fBverify_callback()\fR set via the
106 \&\fBSSL_CTX_set_verify\fR\|(3) family of functions.
107 This document must therefore be updated when documentation about the
108 X509_STORE object and its handling becomes available.
109 .PP
110 \&\fBSSL_CTX_set_cert_store()\fR does not increment the \fBstore\fR's reference
111 count, so it should not be used to assign an X509_STORE that is owned
112 by another SSL_CTX.
113 .PP
114 To share X509_STOREs between two SSL_CTXs, use \fBSSL_CTX_get_cert_store()\fR
115 to get the X509_STORE from the first SSL_CTX, and then use
116 \&\fBSSL_CTX_set1_cert_store()\fR to assign to the second SSL_CTX and
117 increment the reference count of the X509_STORE.
118 .SH RESTRICTIONS
119 .IX Header "RESTRICTIONS"
120 The X509_STORE structure used by an SSL_CTX is used for verifying peer
121 certificates and building certificate chains, it is also shared by
122 every child SSL structure. Applications wanting finer control can use
123 functions such as \fBSSL_CTX_set1_verify_cert_store()\fR instead.
124 .SH "RETURN VALUES"
125 .IX Header "RETURN VALUES"
126 \&\fBSSL_CTX_set_cert_store()\fR does not return diagnostic output.
127 .PP
128 \&\fBSSL_CTX_set1_cert_store()\fR does not return diagnostic output.
129 .PP
130 \&\fBSSL_CTX_get_cert_store()\fR returns the current setting.
131 .SH "SEE ALSO"
132 .IX Header "SEE ALSO"
133 \&\fBssl\fR\|(7),
134 \&\fBSSL_CTX_load_verify_locations\fR\|(3),
135 \&\fBSSL_CTX_set_verify\fR\|(3)
136 .SH COPYRIGHT
137 .IX Header "COPYRIGHT"
138 Copyright 2001\-2024 The OpenSSL Project Authors. All Rights Reserved.
139 .PP
140 Licensed under the Apache License 2.0 (the "License"). You may not use
141 this file except in compliance with the License. You can obtain a copy
142 in the file LICENSE in the source distribution or at
143 <https://www.openssl.org/source/license.html>.