xref: /freebsd/secure/lib/libcrypto/man/man3/X509_STORE_get0_param.3 (revision b5daf675efc746611c7cfcd1fa474b8905064c4b)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X509_STORE_GET0_PARAM 3ossl"
X509_STORE_GET0_PARAM 3ossl 2025-07-01 3.5.1 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
X509_STORE_get0_param, X509_STORE_set1_param, X509_STORE_get1_objects, X509_STORE_get0_objects, X509_STORE_get1_all_certs \- X509_STORE setter and getter functions
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/x509_vfy.h> \& X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *xs); int X509_STORE_set1_param(X509_STORE *xs, const X509_VERIFY_PARAM *pm); STACK_OF(X509_OBJECT) *X509_STORE_get1_objects(X509_STORE *xs); STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *xs); STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *xs); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBX509_STORE_set1_param() sets the verification parameters to pm for xs.

\fBX509_STORE_get0_param() retrieves an internal pointer to the verification parameters for xs. The returned pointer must not be freed by the calling application

\fBX509_STORE_get1_objects() returns a snapshot of all objects in the store's X509 cache. The cache contains X509 and X509_CRL objects. The caller is responsible for freeing the returned list.

\fBX509_STORE_get0_objects() retrieves an internal pointer to the store's X509 object cache. The cache contains X509 and X509_CRL objects. The returned pointer must not be freed by the calling application. If the store is shared across multiple threads, it is not safe to use the result of this function. Use X509_STORE_get1_objects() instead, which avoids this problem.

\fBX509_STORE_get1_all_certs() returns a list of all certificates in the store. The caller is responsible for freeing the returned list.

"RETURN VALUES"
Header "RETURN VALUES" \fBX509_STORE_get0_param() returns a pointer to an \fBX509_VERIFY_PARAM structure.

\fBX509_STORE_set1_param() returns 1 for success and 0 for failure.

\fBX509_STORE_get1_objects() returns a pointer to a stack of the retrieved objects on success, else NULL.

\fBX509_STORE_get0_objects() returns a pointer to a stack of X509_OBJECT.

\fBX509_STORE_get1_all_certs() returns a pointer to a stack of the retrieved certificates on success, else NULL.

"SEE ALSO"
Header "SEE ALSO" \fBX509_STORE_new\|(3)
HISTORY
Header "HISTORY" \fBX509_STORE_get0_param and X509_STORE_get0_objects were added in OpenSSL 1.1.0. \fBX509_STORE_get1_certs was added in OpenSSL 3.0. \fBX509_STORE_get1_objects was added in OpenSSL 3.3.
COPYRIGHT
Header "COPYRIGHT" Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.