297 lines
11 KiB
Groff
Executable File
297 lines
11 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "X509_STORE_CTX_NEW 3"
|
|
.TH X509_STORE_CTX_NEW 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free,
|
|
X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack, X509_STORE_CTX_set_cert,
|
|
X509_STORE_CTX_set0_crls,
|
|
X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain,
|
|
X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param,
|
|
X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_set0_untrusted,
|
|
X509_STORE_CTX_get_num_untrusted,
|
|
X509_STORE_CTX_set_default,
|
|
X509_STORE_CTX_set_verify,
|
|
X509_STORE_CTX_verify_fn
|
|
\&\- X509_STORE_CTX initialisation
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/x509_vfy.h>
|
|
\&
|
|
\& X509_STORE_CTX *X509_STORE_CTX_new(void);
|
|
\& void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
|
|
\& void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
|
|
\&
|
|
\& int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
|
|
\& X509 *x509, STACK_OF(X509) *chain);
|
|
\&
|
|
\& void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
|
|
\&
|
|
\& void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
|
|
\& STACK_OF(X509) *X509_STORE_CTX_get0_chain(X509_STORE_CTX *ctx);
|
|
\& void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
|
|
\& void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
|
|
\&
|
|
\& X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx);
|
|
\& void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
|
|
\& int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
|
|
\&
|
|
\& STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
|
|
\& void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
|
|
\&
|
|
\& int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
|
|
\&
|
|
\& typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
|
|
\& void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
These functions initialise an \fBX509_STORE_CTX\fR structure for subsequent use
|
|
by \fIX509_verify_cert()\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_new()\fR returns a newly initialised \fBX509_STORE_CTX\fR structure.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_cleanup()\fR internally cleans up an \fBX509_STORE_CTX\fR structure.
|
|
The context can then be reused with an new call to \fIX509_STORE_CTX_init()\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_free()\fR completely frees up \fBctx\fR. After this call \fBctx\fR
|
|
is no longer valid.
|
|
If \fBctx\fR is \s-1NULL\s0 nothing is done.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_init()\fR sets up \fBctx\fR for a subsequent verification operation.
|
|
It must be called before each call to \fIX509_verify_cert()\fR, i.e. a \fBctx\fR is only
|
|
good for one call to \fIX509_verify_cert()\fR; if you want to verify a second
|
|
certificate with the same \fBctx\fR then you must call \fIX509_STORE_CTX_cleanup()\fR
|
|
and then \fIX509_STORE_CTX_init()\fR again before the second call to
|
|
\&\fIX509_verify_cert()\fR. The trusted certificate store is set to \fBstore\fR, the end
|
|
entity certificate to be verified is set to \fBx509\fR and a set of additional
|
|
certificates (which will be untrusted but may be used to build the chain) in
|
|
\&\fBchain\fR. Any or all of the \fBstore\fR, \fBx509\fR and \fBchain\fR parameters can be
|
|
\&\fB\s-1NULL\s0\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set0_trusted_stack()\fR sets the set of trusted certificates of
|
|
\&\fBctx\fR to \fBsk\fR. This is an alternative way of specifying trusted certificates
|
|
instead of using an \fBX509_STORE\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set_cert()\fR sets the certificate to be verified in \fBctx\fR to
|
|
\&\fBx\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set0_verified_chain()\fR sets the validated chain used
|
|
by \fBctx\fR to be \fBchain\fR.
|
|
Ownership of the chain is transferred to \fBctx\fR and should not be
|
|
free'd by the caller.
|
|
\&\fIX509_STORE_CTX_get0_chain()\fR returns a the internal pointer used by the
|
|
\&\fBctx\fR that contains the validated chain.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set0_crls()\fR sets a set of CRLs to use to aid certificate
|
|
verification to \fBsk\fR. These CRLs will only be used if \s-1CRL\s0 verification is
|
|
enabled in the associated \fBX509_VERIFY_PARAM\fR structure. This might be
|
|
used where additional \*(L"useful\*(R" CRLs are supplied as part of a protocol,
|
|
for example in a PKCS#7 structure.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_get0_param()\fR retrieves an internal pointer
|
|
to the verification parameters associated with \fBctx\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_get0_untrusted()\fR retrieves an internal pointer to the
|
|
stack of untrusted certificates associated with \fBctx\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set0_untrusted()\fR sets the internal point to the stack
|
|
of untrusted certificates associated with \fBctx\fR to \fBsk\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set0_param()\fR sets the internal verification parameter pointer
|
|
to \fBparam\fR. After this call \fBparam\fR should not be used.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set_default()\fR looks up and sets the default verification
|
|
method to \fBname\fR. This uses the function \fIX509_VERIFY_PARAM_lookup()\fR to
|
|
find an appropriate set of parameters from \fBname\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
|
|
that were used in building the chain following a call to \fIX509_verify_cert()\fR.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set_verify()\fR provides the capability for overriding the default
|
|
verify function. This function is responsible for verifying chain signatures and
|
|
expiration times.
|
|
.PP
|
|
A verify function is defined as an X509_STORE_CTX_verify type which has the
|
|
following signature:
|
|
.PP
|
|
.Vb 1
|
|
\& int (*verify)(X509_STORE_CTX *);
|
|
.Ve
|
|
.PP
|
|
This function should receive the current X509_STORE_CTX as a parameter and
|
|
return 1 on success or 0 on failure.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The certificates and CRLs in a store are used internally and should \fBnot\fR
|
|
be freed up until after the associated \fBX509_STORE_CTX\fR is freed.
|
|
.SH "BUGS"
|
|
.IX Header "BUGS"
|
|
The certificates and CRLs in a context are used internally and should \fBnot\fR
|
|
be freed up until after the associated \fBX509_STORE_CTX\fR is freed. Copies
|
|
should be made or reference counts increased instead.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIX509_STORE_CTX_new()\fR returns an newly allocates context or \fB\s-1NULL\s0\fR is an
|
|
error occurred.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_init()\fR returns 1 for success or 0 if an error occurred.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_get0_param()\fR returns a pointer to an \fBX509_VERIFY_PARAM\fR
|
|
structure or \fB\s-1NULL\s0\fR if an error occurred.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_cleanup()\fR, \fIX509_STORE_CTX_free()\fR,
|
|
\&\fIX509_STORE_CTX_set0_trusted_stack()\fR,
|
|
\&\fIX509_STORE_CTX_set_cert()\fR,
|
|
\&\fIX509_STORE_CTX_set0_crls()\fR and \fIX509_STORE_CTX_set0_param()\fR do not return
|
|
values.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_set_default()\fR returns 1 for success or 0 if an error occurred.
|
|
.PP
|
|
\&\fIX509_STORE_CTX_get_num_untrusted()\fR returns the number of untrusted certificates
|
|
used.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIX509_verify_cert\fR\|(3)
|
|
\&\fIX509_VERIFY_PARAM_set_flags\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fIX509_STORE_CTX_set0_crls()\fR function was added in OpenSSL 1.0.0.
|
|
The \fIX509_STORE_CTX_get_num_untrusted()\fR function was added in OpenSSL 1.1.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2009\-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|