4e286e1ece8bde78545ea25ab904a75f0f97a474
[dragonfly.git] / secure / lib / libcrypto / man / X509_STORE_CTX_new.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "X509_STORE_CTX_new 3"
136 .TH X509_STORE_CTX_new 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_init, X509_STORE_CTX_trusted_stack, X509_STORE_CTX_set_cert, X509_STORE_CTX_set_chain, X509_STORE_CTX_set0_crls, X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param, X509_STORE_CTX_set_default \- X509_STORE_CTX initialisation
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/x509_vfy.h>
147 \&
148 \& X509_STORE_CTX *X509_STORE_CTX_new(void);
149 \& void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
150 \& void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
151 \&
152 \& int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
153 \&                         X509 *x509, STACK_OF(X509) *chain);
154 \&
155 \& void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
156 \&
157 \& void   X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx,X509 *x);
158 \& void   X509_STORE_CTX_set_chain(X509_STORE_CTX *ctx,STACK_OF(X509) *sk);
159 \& void   X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
160 \&
161 \& X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
162 \& void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
163 \& int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
164 .Ve
165 .SH "DESCRIPTION"
166 .IX Header "DESCRIPTION"
167 These functions initialise an \fBX509_STORE_CTX\fR structure for subsequent use
168 by \fIX509_verify_cert()\fR.
169 .PP
170 \&\fIX509_STORE_CTX_new()\fR returns a newly initialised \fBX509_STORE_CTX\fR structure.
171 .PP
172 \&\fIX509_STORE_CTX_cleanup()\fR internally cleans up an \fBX509_STORE_CTX\fR structure.
173 The context can then be reused with an new call to \fIX509_STORE_CTX_init()\fR.
174 .PP
175 \&\fIX509_STORE_CTX_free()\fR completely frees up \fBctx\fR. After this call \fBctx\fR
176 is no longer valid.
177 .PP
178 \&\fIX509_STORE_CTX_init()\fR sets up \fBctx\fR for a subsequent verification operation.
179 The trusted certificate store is set to \fBstore\fR, the end entity certificate
180 to be verified is set to \fBx509\fR and a set of additional certificates (which
181 will be untrusted but may be used to build the chain) in \fBchain\fR. Any or
182 all of the \fBstore\fR, \fBx509\fR and \fBchain\fR parameters can be \fB\s-1NULL\s0\fR.
183 .PP
184 \&\fIX509_STORE_CTX_trusted_stack()\fR sets the set of trusted certificates of \fBctx\fR
185 to \fBsk\fR. This is an alternative way of specifying trusted certificates 
186 instead of using an \fBX509_STORE\fR.
187 .PP
188 \&\fIX509_STORE_CTX_set_cert()\fR sets the certificate to be vertified in \fBctx\fR to
189 \&\fBx\fR.
190 .PP
191 \&\fIX509_STORE_CTX_set_chain()\fR sets the additional certificate chain used by \fBctx\fR
192 to \fBsk\fR.
193 .PP
194 \&\fIX509_STORE_CTX_set0_crls()\fR sets a set of CRLs to use to aid certificate
195 verification to \fBsk\fR. These CRLs will only be used if \s-1CRL\s0 verification is
196 enabled in the associated \fBX509_VERIFY_PARAM\fR structure. This might be
197 used where additional \*(L"useful\*(R" CRLs are supplied as part of a protocol,
198 for example in a PKCS#7 structure.
199 .PP
200 X509_VERIFY_PARAM *\fIX509_STORE_CTX_get0_param()\fR retrieves an intenal pointer
201 to the verification parameters associated with \fBctx\fR.
202 .PP
203 \&\fIX509_STORE_CTX_set0_param()\fR sets the intenal verification parameter pointer
204 to \fBparam\fR. After this call \fBparam\fR should not be used.
205 .PP
206 \&\fIX509_STORE_CTX_set_default()\fR looks up and sets the default verification
207 method to \fBname\fR. This uses the function \fIX509_VERIFY_PARAM_lookup()\fR to
208 find an appropriate set of parameters from \fBname\fR.
209 .SH "NOTES"
210 .IX Header "NOTES"
211 The certificates and CRLs in a store are used internally and should \fBnot\fR
212 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Legacy
213 applications might implicitly use an \fBX509_STORE_CTX\fR like this:
214 .PP
215 .Vb 2
216 \&  X509_STORE_CTX ctx;
217 \&  X509_STORE_CTX_init(&ctx, store, cert, chain);
218 .Ve
219 .PP
220 this is \fBnot\fR recommended in new applications they should instead do:
221 .PP
222 .Vb 5
223 \&  X509_STORE_CTX *ctx;
224 \&  ctx = X509_STORE_CTX_new();
225 \&  if (ctx == NULL)
226 \&        /* Bad error */
227 \&  X509_STORE_CTX_init(ctx, store, cert, chain);
228 .Ve
229 .SH "BUGS"
230 .IX Header "BUGS"
231 The certificates and CRLs in a context are used internally and should \fBnot\fR
232 be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Copies
233 should be made or reference counts increased instead.
234 .SH "RETURN VALUES"
235 .IX Header "RETURN VALUES"
236 \&\fIX509_STORE_CTX_new()\fR returns an newly allocates context or \fB\s-1NULL\s0\fR is an
237 error occurred.
238 .PP
239 \&\fIX509_STORE_CTX_init()\fR returns 1 for success or 0 if an error occurred.
240 .PP
241 \&\fIX509_STORE_CTX_get0_param()\fR returns a pointer to an \fBX509_VERIFY_PARAM\fR
242 structure or \fB\s-1NULL\s0\fR if an error occurred.
243 .PP
244 \&\fIX509_STORE_CTX_cleanup()\fR, \fIX509_STORE_CTX_free()\fR, \fIX509_STORE_CTX_trusted_stack()\fR,
245 \&\fIX509_STORE_CTX_set_cert()\fR, \fIX509_STORE_CTX_set_chain()\fR,
246 \&\fIX509_STORE_CTX_set0_crls()\fR and \fIX509_STORE_CTX_set0_param()\fR do not return
247 values.
248 .PP
249 \&\fIX509_STORE_CTX_set_default()\fR returns 1 for success or 0 if an error occurred.
250 .SH "SEE ALSO"
251 .IX Header "SEE ALSO"
252 \&\fIX509_verify_cert\fR\|(3)
253 \&\fIX509_VERIFY_PARAM_set_flags\fR\|(3)
254 .SH "HISTORY"
255 .IX Header "HISTORY"
256 \&\fIX509_STORE_CTX_set0_crls()\fR was first added to OpenSSL 1.0.0