xref: /freebsd/crypto/openssl/doc/man3/X509_STORE_get0_param.pod (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1=pod
2
3=head1 NAME
4
5X509_STORE_get0_param, X509_STORE_set1_param,
6X509_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 *ctx);
14 int X509_STORE_set1_param(X509_STORE *ctx, const X509_VERIFY_PARAM *pm);
15 STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *ctx);
16 STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *st);
17
18=head1 DESCRIPTION
19
20X509_STORE_set1_param() sets the verification parameters
21to B<pm> for B<ctx>.
22
23X509_STORE_get0_param() retrieves an internal pointer to the verification
24parameters for B<ctx>. The returned pointer must not be freed by the
25calling application
26
27X509_STORE_get0_objects() retrieves an internal pointer to the store's
28X509 object cache. The cache contains B<X509> and B<X509_CRL> objects. The
29returned pointer must not be freed by the calling application.
30
31X509_STORE_get1_all_certs() returns a list of all certificates in the store.
32The caller is responsible for freeing the returned list.
33
34=head1 RETURN VALUES
35
36X509_STORE_get0_param() returns a pointer to an
37B<X509_VERIFY_PARAM> structure.
38
39X509_STORE_set1_param() returns 1 for success and 0 for failure.
40
41X509_STORE_get0_objects() returns a pointer to a stack of B<X509_OBJECT>.
42
43X509_STORE_get1_all_certs() returns a pointer to a stack of the retrieved
44certificates on success, else NULL.
45
46=head1 SEE ALSO
47
48L<X509_STORE_new(3)>
49
50=head1 HISTORY
51
52B<X509_STORE_get0_param> and B<X509_STORE_get0_objects> were added in
53OpenSSL 1.1.0.
54B<X509_STORE_get1_certs> was added in OpenSSL 3.0.
55
56=head1 COPYRIGHT
57
58Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
59
60Licensed under the Apache License 2.0 (the "License").  You may not use
61this file except in compliance with the License.  You can obtain a copy
62in the file LICENSE in the source distribution or at
63L<https://www.openssl.org/source/license.html>.
64
65=cut
66