278 lines
10 KiB
Groff
Executable File
278 lines
10 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_LOOKUP_HASH_DIR 3"
|
|
.TH X509_LOOKUP_HASH_DIR 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_LOOKUP_hash_dir, X509_LOOKUP_file, X509_LOOKUP_store,
|
|
X509_load_cert_file,
|
|
X509_load_crl_file,
|
|
X509_load_cert_crl_file \- Default OpenSSL certificate
|
|
lookup methods
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/x509_vfy.h>
|
|
\&
|
|
\& X509_LOOKUP_METHOD *X509_LOOKUP_hash_dir(void);
|
|
\& X509_LOOKUP_METHOD *X509_LOOKUP_file(void);
|
|
\& X509_LOOKUP_METHOD *X509_LOOKUP_store(void);
|
|
\&
|
|
\& int X509_load_cert_file(X509_LOOKUP *ctx, const char *file, int type);
|
|
\& int X509_load_crl_file(X509_LOOKUP *ctx, const char *file, int type);
|
|
\& int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fBX509_LOOKUP_hash_dir\fR and \fBX509_LOOKUP_file\fR are two certificate
|
|
lookup methods to use with \fBX509_STORE\fR, provided by OpenSSL library.
|
|
.PP
|
|
Users of the library typically do not need to create instances of these
|
|
methods manually, they would be created automatically by
|
|
\&\fIX509_STORE_load_locations\fR\|(3) or
|
|
\&\fISSL_CTX_load_verify_locations\fR\|(3)
|
|
functions.
|
|
.PP
|
|
Internally loading of certificates and CRLs is implemented via functions
|
|
\&\fBX509_load_cert_crl_file\fR, \fBX509_load_cert_file\fR and
|
|
\&\fBX509_load_crl_file\fR. These functions support parameter \fItype\fR, which
|
|
can be one of constants \fB\s-1FILETYPE_PEM\s0\fR, \fB\s-1FILETYPE_ASN1\s0\fR and
|
|
\&\fB\s-1FILETYPE_DEFAULT\s0\fR. They load certificates and/or CRLs from specified
|
|
file into memory cache of \fBX509_STORE\fR objects which given \fBctx\fR
|
|
parameter is associated with.
|
|
.PP
|
|
Functions \fBX509_load_cert_file\fR and
|
|
\&\fBX509_load_crl_file\fR can load both \s-1PEM\s0 and \s-1DER\s0 formats depending of
|
|
type value. Because \s-1DER\s0 format cannot contain more than one certificate
|
|
or \s-1CRL\s0 object (while \s-1PEM\s0 can contain several concatenated \s-1PEM\s0 objects)
|
|
\&\fBX509_load_cert_crl_file\fR with \fB\s-1FILETYPE_ASN1\s0\fR is equivalent to
|
|
\&\fBX509_load_cert_file\fR.
|
|
.PP
|
|
Constant \fB\s-1FILETYPE_DEFAULT\s0\fR with \s-1NULL\s0 filename causes these functions
|
|
to load default certificate store file (see
|
|
\&\fIX509_STORE_set_default_paths\fR\|(3).
|
|
.PP
|
|
Functions return number of objects loaded from file or 0 in case of
|
|
error.
|
|
.PP
|
|
Both methods support adding several certificate locations into one
|
|
\&\fBX509_STORE\fR.
|
|
.PP
|
|
This page documents certificate store formats used by these methods and
|
|
caching policy.
|
|
.SS "File Method"
|
|
.IX Subsection "File Method"
|
|
The \fBX509_LOOKUP_file\fR method loads all the certificates or CRLs
|
|
present in a file into memory at the time the file is added as a
|
|
lookup source.
|
|
.PP
|
|
File format is \s-1ASCII\s0 text which contains concatenated \s-1PEM\s0 certificates
|
|
and CRLs.
|
|
.PP
|
|
This method should be used by applications which work with a small
|
|
set of CAs.
|
|
.SS "Hashed Directory Method"
|
|
.IX Subsection "Hashed Directory Method"
|
|
\&\fBX509_LOOKUP_hash_dir\fR is a more advanced method, which loads
|
|
certificates and CRLs on demand, and caches them in memory once
|
|
they are loaded. As of OpenSSL 1.0.0, it also checks for newer CRLs
|
|
upon each lookup, so that newer CRLs are as soon as they appear in
|
|
the directory.
|
|
.PP
|
|
The directory should contain one certificate or \s-1CRL\s0 per file in \s-1PEM\s0 format,
|
|
with a filename of the form \fIhash\fR.\fIN\fR for a certificate, or
|
|
\&\fIhash\fR.\fBr\fR\fIN\fR for a \s-1CRL\s0.
|
|
The \fIhash\fR is the value returned by the \fIX509_NAME_hash\fR\|(3) function applied
|
|
to the subject name for certificates or issuer name for CRLs.
|
|
The hash can also be obtained via the \fB\-hash\fR option of the
|
|
\&\fIopenssl\-x509\fR\|(1) or \fIopenssl\-crl\fR\|(1) commands.
|
|
.PP
|
|
The .\fIN\fR or .\fBr\fR\fIN\fR suffix is a sequence number that starts at zero, and is
|
|
incremented consecutively for each certificate or \s-1CRL\s0 with the same \fIhash\fR
|
|
value.
|
|
Gaps in the sequence numbers are not supported, it is assumed that there are no
|
|
more objects with the same hash beyond the first missing number in the
|
|
sequence.
|
|
.PP
|
|
Sequence numbers make it possible for the directory to contain multiple
|
|
certificates with same subject name hash value.
|
|
For example, it is possible to have in the store several certificates with same
|
|
subject or several CRLs with same issuer (and, for example, different validity
|
|
period).
|
|
.PP
|
|
When checking for new CRLs once one \s-1CRL\s0 for given hash value is
|
|
loaded, hash_dir lookup method checks only for certificates with
|
|
sequence number greater than that of the already cached \s-1CRL\s0.
|
|
.PP
|
|
Note that the hash algorithm used for subject name hashing changed in OpenSSL
|
|
1.0.0, and all certificate stores have to be rehashed when moving from OpenSSL
|
|
0.9.8 to 1.0.0.
|
|
.PP
|
|
OpenSSL includes a \fIopenssl\-rehash\fR\|(1) utility which creates symlinks with
|
|
hashed names for all files with \fI.pem\fR suffix in a given directory.
|
|
.SS "\s-1OSSL_STORE\s0 Method"
|
|
.IX Subsection "OSSL_STORE Method"
|
|
\&\fBX509_LOOKUP_store\fR is a method that allows access to any store of
|
|
certificates and CRLs through any loader supported by
|
|
\&\fIossl_store\fR\|(7).
|
|
It works with the help of URIs, which can be direct references to
|
|
certificates or CRLs, but can also be references to catalogues of such
|
|
objects (that behave like directories).
|
|
.PP
|
|
This method overlaps the \*(L"File Method\*(R" and \*(L"Hashed Directory Method\*(R"
|
|
because of the 'file:' scheme loader.
|
|
It does no caching of its own, but can use a caching \fIossl_store\fR\|(7)
|
|
loader, and therefore depends on the loader's capability.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIX509_LOOKUP_hash_dir()\fR, \fIX509_LOOKUP_file()\fR and \fIX509_LOOKUP_store()\fR
|
|
always return a valid \fBX509_LOOKUP_METHOD\fR structure.
|
|
.PP
|
|
\&\fIX509_load_cert_file()\fR, \fIX509_load_crl_file()\fR and \fIX509_load_cert_crl_file()\fR return
|
|
the number of loaded objects or 0 on error.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIPEM_read_PrivateKey\fR\|(3),
|
|
\&\fIX509_STORE_load_locations\fR\|(3),
|
|
\&\fIX509_store_add_lookup\fR\|(3),
|
|
\&\fISSL_CTX_load_verify_locations\fR\|(3),
|
|
\&\fIX509_LOOKUP_meth_new\fR\|(3),
|
|
\&\fIossl_store\fR\|(7)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
\&\fBX509_LOOKUP_store\fR was added in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-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>.
|