doc/man3/SSL_CTX_set_ctlog_list_file.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_set_default_ctlog_list_file, SSL_CTX_set_ctlog_list_file -
   6 load a Certificate Transparency log list from a file
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ssl.h>
  11
  12  int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
  13  int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_CTX_set_default_ctlog_list_file() loads a list of Certificate Transparency
  18 (CT) logs from the default file location, "ct_log_list.cnf", found in the
  19 directory where OpenSSL is installed.
  20
  21 SSL_CTX_set_ctlog_list_file() loads a list of CT logs from a specific path.
  22 See L<CTLOG_STORE_new(3)> for the file format.
  23
  24 =head1 NOTES
  25
  26 These functions will not clear the existing CT log list - it will be appended
  27 to. To replace the existing list, use L<SSL_CTX_set0_ctlog_store> first.
  28
  29 If an error occurs whilst parsing a particular log entry in the file, that log
  30 entry will be skipped.
  31
  32 =head1 RETURN VALUES
  33
  34 SSL_CTX_set_default_ctlog_list_file() and SSL_CTX_set_ctlog_list_file()
  35 return 1 if the log list is successfully loaded, and 0 if an error occurs. In
  36 the case of an error, the log list may have been partially loaded.
  37
  38 =head1 SEE ALSO
  39
  40 L<ssl(7)>,
  41 L<SSL_CTX_set_ct_validation_callback(3)>,
  42 L<CTLOG_STORE_new(3)>
  43
  44 =head1 COPYRIGHT
  45
  46 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  47
  48 Licensed under the OpenSSL license (the "License").  You may not use
  49 this file except in compliance with the License.  You can obtain a copy
  50 in the file LICENSE in the source distribution or at
  51 L<https://www.openssl.org/source/license.html>.
  52
  53 =cut