1=pod
2
3=head1 NAME
4
5X509_STORE_get0_param, X509_STORE_set1_param,
6X509_STORE_get1_objects, X509_STORE_get0_objects, X509_STORE_get1_all_certs
7- X509_STORE setter and getter functions
8
9=head1 SYNOPSIS
10
11 #include <openssl/x509_vfy.h>
12
13 X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *xs);
14 int X509_STORE_set1_param(X509_STORE *xs, const X509_VERIFY_PARAM *pm);
15 STACK_OF(X509_OBJECT) *X509_STORE_get1_objects(X509_STORE *xs);
16 STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *xs);
17 STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *xs);
18
19=head1 DESCRIPTION
20
21X509_STORE_set1_param() sets the verification parameters to I<pm> for I<xs>.
22
23X509_STORE_get0_param() retrieves an internal pointer to the verification
24parameters for I<xs>. The returned pointer must not be freed by the
25calling application
26
27X509_STORE_get1_objects() returns a snapshot of all objects in the store's X509
28cache. The cache contains B<X509> and B<X509_CRL> objects. The caller is
29responsible for freeing the returned list.
30
31X509_STORE_get0_objects() retrieves an internal pointer to the store's
32X509 object cache. The cache contains B<X509> and B<X509_CRL> objects. The
33returned pointer must not be freed by the calling application. If the store is
34shared across multiple threads, it is not safe to use the result of this
35function. Use X509_STORE_get1_objects() instead, which avoids this problem.
36
37X509_STORE_get1_all_certs() returns a list of all certificates in the store.
38The caller is responsible for freeing the returned list.
39
40=head1 RETURN VALUES
41
42X509_STORE_get0_param() returns a pointer to an
43B<X509_VERIFY_PARAM> structure.
44
45X509_STORE_set1_param() returns 1 for success and 0 for failure.
46
47X509_STORE_get1_objects() returns a pointer to a stack of the retrieved
48objects on success, else NULL.
49
50X509_STORE_get0_objects() returns a pointer to a stack of B<X509_OBJECT>.
51
52X509_STORE_get1_all_certs() returns a pointer to a stack of the retrieved
53certificates on success, else NULL.
54
55=head1 SEE ALSO
56
57L<X509_STORE_new(3)>
58
59=head1 HISTORY
60
61B<X509_STORE_get0_param> and B<X509_STORE_get0_objects> were added in
62OpenSSL 1.1.0.
63B<X509_STORE_get1_certs> was added in OpenSSL 3.0.
64B<X509_STORE_get1_objects> was added in OpenSSL 3.3.
65
66=head1 COPYRIGHT
67
68Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.
69
70Licensed under the Apache License 2.0 (the "License").  You may not use
71this file except in compliance with the License.  You can obtain a copy
72in the file LICENSE in the source distribution or at
73L<https://www.openssl.org/source/license.html>.
74
75=cut
76