262 lines
9.8 KiB
Groff
Executable File
262 lines
9.8 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_ADD_CERT 3"
|
|
.TH X509_STORE_ADD_CERT 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,
|
|
X509_STORE_add_cert, X509_STORE_add_crl, X509_STORE_set_depth,
|
|
X509_STORE_set_flags, X509_STORE_set_purpose, X509_STORE_set_trust,
|
|
X509_STORE_add_lookup,
|
|
X509_STORE_load_file, X509_STORE_load_path, X509_STORE_load_store,
|
|
X509_STORE_set_default_paths,
|
|
X509_STORE_load_locations
|
|
\&\- X509_STORE manipulation
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/x509_vfy.h>
|
|
\&
|
|
\& typedef x509_store_st X509_STORE;
|
|
\&
|
|
\& int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
|
|
\& int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
|
|
\& int X509_STORE_set_depth(X509_STORE *store, int depth);
|
|
\& int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags);
|
|
\& int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
|
|
\& int X509_STORE_set_trust(X509_STORE *ctx, int trust);
|
|
\&
|
|
\& X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *store,
|
|
\& X509_LOOKUP_METHOD *meth);
|
|
\&
|
|
\& int X509_STORE_set_default_paths(X509_STORE *ctx);
|
|
\& int X509_STORE_load_file(X509_STORE *ctx, const char *file);
|
|
\& int X509_STORE_load_path(X509_STORE *ctx, const char *dir);
|
|
\& int X509_STORE_load_store(X509_STORE *ctx, const char *uri);
|
|
.Ve
|
|
.PP
|
|
Deprecated:
|
|
.PP
|
|
.Vb 2
|
|
\& int X509_STORE_load_locations(X509_STORE *ctx,
|
|
\& const char *file, const char *dir);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The \fBX509_STORE\fR structure is intended to be a consolidated mechanism for
|
|
holding information about X.509 certificates and CRLs, and constructing
|
|
and validating chains of certificates terminating in trusted roots.
|
|
It admits multiple lookup mechanisms and efficient scaling performance
|
|
with large numbers of certificates, and a great deal of flexibility in
|
|
how validation and policy checks are performed.
|
|
.PP
|
|
\&\fIX509_STORE_new\fR\|(3) creates an empty \fBX509_STORE\fR structure, which contains
|
|
no information about trusted certificates or where such certificates
|
|
are located on disk, and is generally not usable. Normally, trusted
|
|
certificates will be added to the \fBX509_STORE\fR to prepare it for use,
|
|
via mechanisms such as \fIX509_STORE_add_lookup()\fR and \fIX509_LOOKUP_file()\fR, or
|
|
\&\fIPEM_read_bio_X509_AUX()\fR and \fIX509_STORE_add_cert()\fR. CRLs can also be added,
|
|
and many behaviors configured as desired.
|
|
.PP
|
|
Once the \fBX509_STORE\fR is suitably configured, \fIX509_STORE_CTX_new()\fR is
|
|
used to instantiate a single-use \fBX509_STORE_CTX\fR for each chain-building
|
|
and verification operation. That process includes providing the end-entity
|
|
certificate to be verified and an additional set of untrusted certificates
|
|
that may be used in chain-building. As such, it is expected that the
|
|
certificates included in the \fBX509_STORE\fR are certificates that represent
|
|
trusted entities such as root certificate authorities (CAs).
|
|
OpenSSL represents these trusted certificates internally as \fBX509\fR objects
|
|
with an associated \fBX509_CERT_AUX\fR, as are produced by
|
|
\&\fIPEM_read_bio_X509_AUX()\fR and similar routines that refer to X509_AUX.
|
|
The public interfaces that operate on such trusted certificates still
|
|
operate on pointers to \fBX509\fR objects, though.
|
|
.PP
|
|
\&\fIX509_STORE_add_cert()\fR and \fIX509_STORE_add_crl()\fR add the respective object
|
|
to the \fBX509_STORE\fR's local storage. Untrusted objects should not be
|
|
added in this way. The added object's reference count is incremented by one,
|
|
hence the caller retains ownership of the object and needs to free it when it
|
|
is no longer needed.
|
|
.PP
|
|
\&\fIX509_STORE_set_depth()\fR, \fIX509_STORE_set_flags()\fR, \fIX509_STORE_set_purpose()\fR,
|
|
\&\fIX509_STORE_set_trust()\fR, and \fIX509_STORE_set1_param()\fR set the default values
|
|
for the corresponding values used in certificate chain validation. Their
|
|
behavior is documented in the corresponding \fBX509_VERIFY_PARAM\fR manual
|
|
pages, e.g., \fIX509_VERIFY_PARAM_set_depth\fR\|(3).
|
|
.PP
|
|
\&\fIX509_STORE_add_lookup()\fR finds or creates a \fIX509_LOOKUP\fR\|(3) with the
|
|
\&\fIX509_LOOKUP_METHOD\fR\|(3) \fImeth\fR and adds it to the \fBX509_STORE\fR
|
|
\&\fIstore\fR. This also associates the \fBX509_STORE\fR with the lookup, so
|
|
\&\fBX509_LOOKUP\fR functions can look up objects in that store.
|
|
.PP
|
|
\&\fIX509_STORE_load_file()\fR loads trusted certificate(s) into an
|
|
\&\fBX509_STORE\fR from a given file.
|
|
.PP
|
|
\&\fIX509_STORE_load_path()\fR loads trusted certificate(s) into an
|
|
\&\fBX509_STORE\fR from a given directory path.
|
|
The certificates in the directory must be in hashed form, as
|
|
documented in \fIX509_LOOKUP_hash_dir\fR\|(3).
|
|
.PP
|
|
\&\fIX509_STORE_load_store()\fR loads trusted certificate(s) into an
|
|
\&\fBX509_STORE\fR from a store at a given \s-1URI\s0.
|
|
.PP
|
|
\&\fIX509_STORE_load_locations()\fR combines \fIX509_STORE_load_file()\fR and
|
|
\&\fIX509_STORE_load_dir()\fR for a given file and/or directory path.
|
|
It is permitted to specify just a file, just a directory, or both
|
|
paths.
|
|
.PP
|
|
\&\fIX509_STORE_set_default_paths()\fR is somewhat misnamed, in that it does not
|
|
set what default paths should be used for loading certificates. Instead,
|
|
it loads certificates into the \fBX509_STORE\fR from the hardcoded default
|
|
paths.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIX509_STORE_add_cert()\fR, \fIX509_STORE_add_crl()\fR, \fIX509_STORE_set_depth()\fR,
|
|
\&\fIX509_STORE_set_flags()\fR, \fIX509_STORE_set_purpose()\fR,
|
|
\&\fIX509_STORE_set_trust()\fR, \fIX509_STORE_load_file()\fR,
|
|
\&\fIX509_STORE_load_path()\fR, \fIX509_STORE_load_store()\fR,
|
|
\&\fIX509_STORE_load_locations()\fR, and \fIX509_STORE_set_default_paths()\fR return
|
|
1 on success or 0 on failure.
|
|
.PP
|
|
\&\fIX509_STORE_add_lookup()\fR returns the found or created
|
|
\&\fIX509_LOOKUP\fR\|(3), or \s-1NULL\s0 on error.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIX509_LOOKUP_hash_dir\fR\|(3).
|
|
\&\fIX509_VERIFY_PARAM_set_depth\fR\|(3).
|
|
\&\fIX509_STORE_new\fR\|(3),
|
|
\&\fIX509_STORE_get0_param\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2017\-2019 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>.
|