1.\" $OpenBSD: SSL_CTX_set_cert_store.3,v 1.8 2024/08/03 04:53:01 tb Exp $ 2.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 3.\" 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" Copyright (c) 2001, 2002, 2005 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: August 3 2024 $ 52.Dt SSL_CTX_SET_CERT_STORE 3 53.Os 54.Sh NAME 55.Nm SSL_CTX_set_cert_store , 56.Nm SSL_CTX_set1_cert_store , 57.Nm SSL_CTX_get_cert_store 58.Nd manipulate X509 certificate verification storage 59.Sh SYNOPSIS 60.In openssl/ssl.h 61.Ft void 62.Fn SSL_CTX_set_cert_store "SSL_CTX *ctx" "X509_STORE *store" 63.Ft void 64.Fn SSL_CTX_set1_cert_store "SSL_CTX *ctx" "X509_STORE *store" 65.Ft X509_STORE * 66.Fn SSL_CTX_get_cert_store "const SSL_CTX *ctx" 67.Sh DESCRIPTION 68.Fn SSL_CTX_set_cert_store 69sets the verification storage of 70.Fa ctx 71to or replaces it with 72.Fa store . 73If another 74.Vt X509_STORE 75object is currently set in 76.Fa ctx , 77it will be freed. 78.Pp 79.Fn SSL_CTX_set1_cert_store 80sets the verification storage of 81.Fa ctx 82to or replaces it with 83.Fa store . 84The 85.Fa store Ns 's 86reference count is incremented. 87.Pp 88.Fn SSL_CTX_get_cert_store 89returns a pointer to the current certificate verification storage. 90.Pp 91In order to verify the certificates presented by the peer, trusted CA 92certificates must be accessed. 93These CA certificates are made available via lookup methods, handled inside the 94.Vt X509_STORE . 95From the 96.Vt X509_STORE 97the 98.Vt X509_STORE_CTX 99used when verifying certificates is created. 100.Pp 101Typically the trusted certificate store is handled indirectly via using 102.Xr SSL_CTX_load_verify_locations 3 . 103Using the 104.Fn SSL_CTX_set_cert_store 105and 106.Fn SSL_CTX_get_cert_store 107functions it is possible to manipulate the 108.Vt X509_STORE 109object beyond the 110.Xr SSL_CTX_load_verify_locations 3 111call. 112.Pp 113Currently no detailed documentation on how to use the 114.Vt X509_STORE 115object is available. 116Not all members of the 117.Vt X509_STORE 118are used when the verification takes place. 119So will, for example, the 120.Fn verify_callback 121be overridden with the 122.Fn verify_callback 123set via the 124.Xr SSL_CTX_set_verify 3 125family of functions. 126This document must therefore be updated when documentation about the 127.Vt X509_STORE 128object and its handling becomes available. 129.Sh RETURN VALUES 130.Fn SSL_CTX_get_cert_store 131returns the current setting. 132.Sh SEE ALSO 133.Xr ssl 3 , 134.Xr SSL_CTX_load_verify_locations 3 , 135.Xr SSL_CTX_set_verify 3 , 136.Xr X509_STORE_new 3 137.Sh HISTORY 138.Fn SSL_CTX_set_cert_store 139and 140.Fn SSL_CTX_get_cert_store 141first appeared in SSLeay 0.8.1 and have been available since 142.Ox 2.4 . 143.Pp 144.Fn SSL_CTX_set1_cert_store 145first appeared in OpenSSL 1.1.1 and has been available since 146.Ox 7.6 . 147