Debian Codegraph @

upstream/debian-unstable/man3/X509_STORE_get0_param.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 "X509_STORE_GET0_PARAM 3SSL"
58 .TH X509_STORE_GET0_PARAM 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 X509_STORE_get0_param, X509_STORE_set1_param,
65 X509_STORE_get1_objects, X509_STORE_get0_objects, X509_STORE_get1_all_certs
66 \&\- X509_STORE setter and getter functions
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/x509_vfy.h>
71 \&
72 \& X509_VERIFY_PARAM *X509_STORE_get0_param(const X509_STORE *xs);
73 \& int X509_STORE_set1_param(X509_STORE *xs, const X509_VERIFY_PARAM *pm);
74 \& STACK_OF(X509_OBJECT) *X509_STORE_get1_objects(X509_STORE *xs);
75 \& STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(const X509_STORE *xs);
76 \& STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *xs);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 \&\fBX509_STORE_set1_param()\fR sets the verification parameters to \fIpm\fR for \fIxs\fR.
81 .PP
82 \&\fBX509_STORE_get0_param()\fR retrieves an internal pointer to the verification
83 parameters for \fIxs\fR. The returned pointer must not be freed by the
84 calling application
85 .PP
86 \&\fBX509_STORE_get1_objects()\fR returns a snapshot of all objects in the store's X509
87 cache. The cache contains \fBX509\fR and \fBX509_CRL\fR objects. The caller
88 is responsible for freeing the returned list,
89 using sk_X509_OBJECT_pop_free(sk, X509_OBJECT_free).
90 .PP
91 \&\fBX509_STORE_get0_objects()\fR retrieves an internal pointer to the store's
92 X509 object cache. The cache contains \fBX509\fR and \fBX509_CRL\fR objects. The
93 returned pointer must not be freed by the calling application. If the store is
94 shared across multiple threads, it is not safe to use the result of this
95 function. Use \fBX509_STORE_get1_objects()\fR instead, which avoids this problem.
96 .PP
97 \&\fBX509_STORE_get1_all_certs()\fR returns a list of all certificates in the store.
98 The caller is responsible for freeing the returned list
99 with \fBOSSL_STACK_OF_X509_free()\fR.
100 .SH "RETURN VALUES"
101 .IX Header "RETURN VALUES"
102 \&\fBX509_STORE_get0_param()\fR returns a pointer to an
103 \&\fBX509_VERIFY_PARAM\fR structure.
104 .PP
105 \&\fBX509_STORE_set1_param()\fR returns 1 for success and 0 for failure.
106 .PP
107 \&\fBX509_STORE_get1_objects()\fR returns a pointer to a stack of the retrieved
108 objects on success, else NULL.
109 .PP
110 \&\fBX509_STORE_get0_objects()\fR returns a pointer to a stack of \fBX509_OBJECT\fR.
111 .PP
112 \&\fBX509_STORE_get1_all_certs()\fR returns a pointer to a stack of the retrieved
113 certificates on success, else NULL.
114 .SH "SEE ALSO"
115 .IX Header "SEE ALSO"
116 \&\fBDEFINE_STACK_OF\fR\|(3),
117 \&\fBX509_STORE_new\fR\|(3)
118 .SH HISTORY
119 .IX Header "HISTORY"
120 \&\fBX509_STORE_get0_param\fR and \fBX509_STORE_get0_objects\fR were added in
121 OpenSSL 1.1.0.
122 \&\fBX509_STORE_get1_certs\fR was added in OpenSSL 3.0.
123 \&\fBX509_STORE_get1_objects\fR was added in OpenSSL 3.3.
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright 2016\-2024 The OpenSSL Project Authors. All Rights Reserved.
127 .PP
128 Licensed under the Apache License 2.0 (the "License"). You may not use
129 this file except in compliance with the License. You can obtain a copy
130 in the file LICENSE in the source distribution or at
131 <https://www.openssl.org/source/license.html>.