CTLOG_STORE_new.pod 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. =pod
  2. =head1 NAME
  3. CTLOG_STORE_new_ex,
  4. CTLOG_STORE_new, CTLOG_STORE_free,
  5. CTLOG_STORE_load_default_file, CTLOG_STORE_load_file -
  6. Create and populate a Certificate Transparency log list
  7. =head1 SYNOPSIS
  8. #include <openssl/ct.h>
  9. CTLOG_STORE *CTLOG_STORE_new_ex(OPENSSL_CTX *libctx, const char *propq);
  10. CTLOG_STORE *CTLOG_STORE_new(void);
  11. void CTLOG_STORE_free(CTLOG_STORE *store);
  12. int CTLOG_STORE_load_default_file(CTLOG_STORE *store);
  13. int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file);
  14. =head1 DESCRIPTION
  15. A CTLOG_STORE is a container for a list of CTLOGs (Certificate Transparency
  16. logs). The list can be loaded from one or more files and then searched by LogID
  17. (see RFC 6962, Section 3.2, for the definition of a LogID).
  18. CTLOG_STORE_new_ex() creates an empty list of CT logs associated with
  19. the library context I<libctx> and the property query string I<propq>.
  20. CTLOG_STORE_new() does the same thing as CTLOG_STORE_new_ex() but with
  21. the default library context and property query string.
  22. The CTLOG_STORE is then populated by CTLOG_STORE_load_default_file() or
  23. CTLOG_STORE_load_file(). CTLOG_STORE_load_default_file() loads from the default
  24. file, which is named F<ct_log_list.cnf> in OPENSSLDIR (see the output of
  25. L<openssl-version(1)>). This can be overridden using an environment variable
  26. named B<CTLOG_FILE>. CTLOG_STORE_load_file() loads from a caller-specified file
  27. path instead. Both of these functions append any loaded CT logs to the
  28. CTLOG_STORE.
  29. The expected format of the file is:
  30. enabled_logs=foo,bar
  31. [foo]
  32. description = Log 1
  33. key = <base64-encoded DER SubjectPublicKeyInfo here>
  34. [bar]
  35. description = Log 2
  36. key = <base64-encoded DER SubjectPublicKeyInfo here>
  37. Once a CTLOG_STORE is no longer required, it should be passed to
  38. CTLOG_STORE_free(). This will delete all of the CTLOGs stored within, along
  39. with the CTLOG_STORE itself.
  40. =head1 NOTES
  41. If there are any invalid CT logs in a file, they are skipped and the remaining
  42. valid logs will still be added to the CTLOG_STORE. A CT log will be considered
  43. invalid if it is missing a "key" or "description" field.
  44. =head1 RETURN VALUES
  45. Both B<CTLOG_STORE_load_default_file> and B<CTLOG_STORE_load_file> return 1 if
  46. all CT logs in the file are successfully parsed and loaded, 0 otherwise.
  47. =head1 SEE ALSO
  48. L<ct(7)>,
  49. L<CTLOG_STORE_get0_log_by_id(3)>,
  50. L<SSL_CTX_set_ctlog_list_file(3)>
  51. =head1 HISTORY
  52. CTLOG_STORE_new_ex was added in OpenSSL 3.0. All other functions were
  53. added in OpenSSL 1.1.0.
  54. =head1 COPYRIGHT
  55. Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
  56. Licensed under the Apache License 2.0 (the "License"). You may not use
  57. this file except in compliance with the License. You can obtain a copy
  58. in the file LICENSE in the source distribution or at
  59. L<https://www.openssl.org/source/license.html>.
  60. =cut