xref: /freebsd/secure/lib/libcrypto/man/man3/CTLOG_new.3 (revision 02e9120893770924227138ba49df1edb3896112a)
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_NEW 3ossl"
CTLOG_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_new_ex, CTLOG_new, CTLOG_new_from_base64, CTLOG_new_from_base64_ex, CTLOG_free, CTLOG_get0_name, CTLOG_get0_log_id, CTLOG_get0_public_key - encapsulates information about a Certificate Transparency log
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/ct.h> \& CTLOG *CTLOG_new_ex(EVP_PKEY *public_key, const char *name, OSSL_LIB_CTX *libctx, const char *propq); CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name); \& int CTLOG_new_from_base64_ex(CTLOG **ct_log, const char *pkey_base64, const char *name, OSSL_LIB_CTX *libctx, const char *propq); int CTLOG_new_from_base64(CTLOG ** ct_log, const char *pkey_base64, const char *name); void CTLOG_free(CTLOG *log); const char *CTLOG_get0_name(const CTLOG *log); void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id, size_t *log_id_len); EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBCTLOG_new_ex() returns a new \s-1CTLOG\s0 that represents the Certificate Transparency (\s-1CT\s0) log with the given public key and associates it with the library context libctx and property query string propq. A name must also be provided that can be used to help users identify this log. Ownership of the public key is transferred.

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

\fBCTLOG_new_from_base64_ex() also creates a new \s-1CTLOG,\s0 but takes the public key in base64-encoded \s-1DER\s0 form and sets the ct_log pointer to point to the new \s-1CTLOG.\s0 The base64 will be decoded and the public key parsed. The \s-1CTLOG\s0 will be associated with the given library context libctx and property query string propq.

\fBCTLOG_new_from_base64() does the same thing as \fBCTLOG_new_from_base64_ex() except that the default library context and property query string are used.

Regardless of whether CTLOG_new() or CTLOG_new_from_base64() is used, it is the caller's responsibility to pass the \s-1CTLOG\s0 to CTLOG_free() once it is no longer needed. This will delete it and, if created by CTLOG_new(), the \s-1EVP_PKEY\s0 that was passed to it.

\fBCTLOG_get0_name() returns the name of the log, as provided when the \s-1CTLOG\s0 was created. Ownership of the string remains with the \s-1CTLOG.\s0

\fBCTLOG_get0_log_id() sets *log_id to point to a string containing that log's LogID (see \s-1RFC 6962\s0). It sets *log_id_len to the length of that LogID. For a v1 \s-1CT\s0 log, the LogID will be a \s-1SHA-256\s0 hash (i.e. 32 bytes long). Ownership of the string remains with the \s-1CTLOG.\s0

\fBCTLOG_get0_public_key() returns the public key of the \s-1CT\s0 log. Ownership of the \s-1EVP_PKEY\s0 remains with the \s-1CTLOG.\s0

"RETURN VALUES"
Header "RETURN VALUES" \fBCTLOG_new() will return \s-1NULL\s0 if an error occurs.

\fBCTLOG_new_from_base64() will return 1 on success, 0 otherwise.

"SEE ALSO"
Header "SEE ALSO" \fBct\|(7)
"HISTORY"
Header "HISTORY" The functions CTLOG_new_ex() and CTLOG_new_from_base64_ex() were 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>.