Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..

..

.. 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 -- \(*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\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, 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.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . 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 . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . 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 .\} ========================================================================

Title "X509_LOOKUP_HASH_DIR 3ossl" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
X509_LOOKUP_hash_dir, X509_LOOKUP_file, X509_LOOKUP_store, X509_load_cert_file_ex, X509_load_cert_file, X509_load_crl_file, X509_load_cert_crl_file_ex, X509_load_cert_crl_file \- Default OpenSSL certificate lookup methods 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_ex(X509_LOOKUP *ctx, const char *file, int type, OSSL_LIB_CTX *libctx, const char *propq); 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_ex(X509_LOOKUP *ctx, const char *file, int type, OSSL_LIB_CTX *libctx, const char *propq); int X509_load_cert_crl_file(X509_LOOKUP *ctx, const char *file, int type); .Ve Header "DESCRIPTION" \fBX509_LOOKUP_hash_dir and X509_LOOKUP_file are two certificate lookup methods to use with X509_STORE, provided by OpenSSL library.

Users of the library typically do not need to create instances of these methods manually, they would be created automatically by \fBX509_STORE_load_locations\|(3) or \fBSSL_CTX_load_verify_locations\|(3) functions.

Internally loading of certificates and CRLs is implemented via functions \fBX509_load_cert_crl_file, X509_load_cert_file and \fBX509_load_crl_file. These functions support parameter type, which can be one of constants \s-1FILETYPE_PEM\s0, \s-1FILETYPE_ASN1\s0 and \fB\s-1FILETYPE_DEFAULT\s0. They load certificates and/or CRLs from specified file into memory cache of X509_STORE objects which given ctx parameter is associated with.

Functions X509_load_cert_file and \fBX509_load_crl_file 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 with \s-1FILETYPE_ASN1\s0 is equivalent to \fBX509_load_cert_file.

Constant \s-1FILETYPE_DEFAULT\s0 with \s-1NULL\s0 filename causes these functions to load default certificate store file (see \fBX509_STORE_set_default_paths\|(3).

Functions return number of objects loaded from file or 0 in case of error.

Both methods support adding several certificate locations into one \fBX509_STORE.

This page documents certificate store formats used by these methods and caching policy.

Subsection "File Method" The X509_LOOKUP_file method loads all the certificates or CRLs present in a file into memory at the time the file is added as a lookup source.

File format is \s-1ASCII\s0 text which contains concatenated \s-1PEM\s0 certificates and CRLs.

This method should be used by applications which work with a small set of CAs.

Subsection "Hashed Directory Method" \fBX509_LOOKUP_hash_dir 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.

The directory should contain one certificate or \s-1CRL\s0 per file in \s-1PEM\s0 format, with a filename of the form hash.N for a certificate, or \fIhash.rN for a \s-1CRL.\s0 The hash is the value returned by the X509_NAME_hash_ex\|(3) function applied to the subject name for certificates or issuer name for CRLs. The hash can also be obtained via the -hash option of the \fBopenssl-x509\|(1) or openssl-crl\|(1) commands.

The .N or .rN suffix is a sequence number that starts at zero, and is incremented consecutively for each certificate or \s-1CRL\s0 with the same hash 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.

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).

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

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.

OpenSSL includes a openssl-rehash\|(1) utility which creates symlinks with hashed names for all files with .pem suffix in a given directory.

Subsection "OSSL_STORE Method" \fBX509_LOOKUP_store is a method that allows access to any store of certificates and CRLs through any loader supported by \fBossl_store\|(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).

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 ossl_store\|(7) loader, and therefore depends on the loader's capability.

Header "RETURN VALUES" \fBX509_LOOKUP_hash_dir(), X509_LOOKUP_file() and X509_LOOKUP_store() always return a valid X509_LOOKUP_METHOD structure.

\fBX509_load_cert_file(), X509_load_crl_file() and X509_load_cert_crl_file() return the number of loaded objects or 0 on error.

Header "SEE ALSO" \fBPEM_read_PrivateKey\|(3), \fBX509_STORE_load_locations\|(3), \fBSSL_CTX_load_verify_locations\|(3), \fBX509_LOOKUP_meth_new\|(3), \fBossl_store\|(7) Header "HISTORY" The functions X509_load_cert_file_ex(), \fBX509_load_cert_crl_file_ex() and X509_LOOKUP_store() were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.

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>.