Remove needless license terms (for docs)

[thirdparty/openssl.git] / doc / ssl / SSL_CTX_set_ctlog_list_file.pod

=pod

=head1 NAME

SSL_CTX_set_default_ctlog_list_file, SSL_CTX_set_ctlog_list_file -
load a Certificate Transparency log list from a file

=head1 SYNOPSIS

 #include <openssl/ssl.h>

 int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
 int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);

=head1 DESCRIPTION

SSL_CTX_set_default_ctlog_list_file() loads a list of Certificate Transparency
(CT) logs from the default file location, "ct_log_list.cnf", found in the
directory where OpenSSL is installed.

SSL_CTX_set_ctlog_list_file() loads a list of CT logs from a given path.

The expected format of the log list file is:

 enabled_logs=foo,bar

 [foo]
 description = Log 1
 key = <base64-encoded public key here>

 [bar]
 description = Log 2
 key = <base64-encoded public key here>

=head1 NOTES

These functions will not clear the existing CT log list - it will be appended
to.

If an error occurs whilst parsing a particular log entry in the file, that log
entry will be skipped.

=head1 RETURN VALUES

SSL_CTX_set_default_ctlog_list_file() and SSL_CTX_set_ctlog_list_file()
return 1 if the log list is successfully loaded, and 0 if an error occurs. In
the case of an error, the log list may have been partially loaded.

=head1 SEE ALSO

L<ssl(3)>,
L<ssl_ct_validation_cb(3)>

=cut