SSL_CTX_set_ctlog_list_file.pod 1.5 KB

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