CTLOG_STORE_get0_log_by_id.pod 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. =pod
  2. =head1 NAME
  3. CTLOG_STORE_get0_log_by_id -
  4. Get a Certificate Transparency log from a CTLOG_STORE
  5. =head1 SYNOPSIS
  6. #include <openssl/ct.h>
  7. const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
  8. const uint8_t *log_id,
  9. size_t log_id_len);
  10. =head1 DESCRIPTION
  11. A Signed Certificate Timestamp (SCT) identifies the Certificate Transparency
  12. (CT) log that issued it using the log's LogID (see RFC 6962, Section 3.2).
  13. Therefore, it is useful to be able to look up more information about a log
  14. (e.g. its public key) using this LogID.
  15. CTLOG_STORE_get0_log_by_id() provides a way to do this. It will find a CTLOG
  16. in a CTLOG_STORE that has a given LogID.
  17. =head1 RETURN VALUES
  18. B<CTLOG_STORE_get0_log_by_id> returns a CTLOG with the given LogID, if it
  19. exists in the given CTLOG_STORE, otherwise it returns NULL.
  20. =head1 SEE ALSO
  21. L<ct(7)>,
  22. L<CTLOG_STORE_new(3)>
  23. =head1 HISTORY
  24. The CTLOG_STORE_get0_log_by_id() function was added in OpenSSL 1.1.0.
  25. =head1 COPYRIGHT
  26. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  27. Licensed under the Apache License 2.0 (the "License"). You may not use
  28. this file except in compliance with the License. You can obtain a copy
  29. in the file LICENSE in the source distribution or at
  30. L<https://www.openssl.org/source/license.html>.
  31. =cut