xref: /freebsd/secure/lib/libcrypto/man/man3/CTLOG_STORE_new.3 (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
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 "CTLOG_STORE_NEW 3ossl"
CTLOG_STORE_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
CTLOG_STORE_new_ex, CTLOG_STORE_new, CTLOG_STORE_free, CTLOG_STORE_load_default_file, CTLOG_STORE_load_file - Create and populate a Certificate Transparency log list
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/ct.h> \& CTLOG_STORE *CTLOG_STORE_new_ex(OSSL_LIB_CTX *libctx, const char *propq); CTLOG_STORE *CTLOG_STORE_new(void); void CTLOG_STORE_free(CTLOG_STORE *store); \& int CTLOG_STORE_load_default_file(CTLOG_STORE *store); int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file); .Ve
"DESCRIPTION"
Header "DESCRIPTION" A \s-1CTLOG_STORE\s0 is a container for a list of CTLOGs (Certificate Transparency logs). The list can be loaded from one or more files and then searched by LogID (see \s-1RFC 6962,\s0 Section 3.2, for the definition of a LogID).

\fBCTLOG_STORE_new_ex() creates an empty list of \s-1CT\s0 logs associated with the library context libctx and the property query string propq.

\fBCTLOG_STORE_new() does the same thing as CTLOG_STORE_new_ex() but with the default library context and property query string.

The \s-1CTLOG_STORE\s0 is then populated by CTLOG_STORE_load_default_file() or \fBCTLOG_STORE_load_file(). CTLOG_STORE_load_default_file() loads from the default file, which is named ct_log_list.cnf in \s-1OPENSSLDIR\s0 (see the output of \fBopenssl-version\|(1)). This can be overridden using an environment variable named \s-1CTLOG_FILE\s0. CTLOG_STORE_load_file() loads from a caller-specified file path instead. Both of these functions append any loaded \s-1CT\s0 logs to the \s-1CTLOG_STORE.\s0

The expected format of the file is:

.Vb 1 enabled_logs=foo,bar \& [foo] description = Log 1 key = <base64-encoded DER SubjectPublicKeyInfo here> \& [bar] description = Log 2 key = <base64-encoded DER SubjectPublicKeyInfo here> .Ve

Once a \s-1CTLOG_STORE\s0 is no longer required, it should be passed to \fBCTLOG_STORE_free(). This will delete all of the CTLOGs stored within, along with the \s-1CTLOG_STORE\s0 itself.

"NOTES"
Header "NOTES" If there are any invalid \s-1CT\s0 logs in a file, they are skipped and the remaining valid logs will still be added to the \s-1CTLOG_STORE. A CT\s0 log will be considered invalid if it is missing a \*(L"key\*(R" or \*(L"description\*(R" field.
"RETURN VALUES"
Header "RETURN VALUES" Both CTLOG_STORE_load_default_file and CTLOG_STORE_load_file return 1 if all \s-1CT\s0 logs in the file are successfully parsed and loaded, 0 otherwise.
"SEE ALSO"
Header "SEE ALSO" \fBct\|(7), \fBCTLOG_STORE_get0_log_by_id\|(3), \fBSSL_CTX_set_ctlog_list_file\|(3)
"HISTORY"
Header "HISTORY" CTLOG_STORE_new_ex was added in OpenSSL 3.0. All other functions were added in OpenSSL 1.1.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2016-2020 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>.