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