doc/crypto/CTLOG_STORE_get0_log_by_id.pod

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