summaryrefslogtreecommitdiffstats
path: root/doc/man3/CTLOG_STORE_get0_log_by_id.pod
diff options
context:
space:
mode:
authorRich Salz <rsalz@openssl.org>2016-10-26 13:56:48 -0400
committerRich Salz <rsalz@openssl.org>2016-10-26 13:59:52 -0400
commit99d63d4662e16afbeff49f29b48f1c87d5558ed0 (patch)
tree6512ff02cd93985526080f05ab2b5408235b19a9 /doc/man3/CTLOG_STORE_get0_log_by_id.pod
parent4f3015bb30b7d95bb97408776b70e6a35fb91e8a (diff)
Move manpages to man[1357] structure.
Move manpages to manX directories Add Windows/VMS install fix from Richard Levitte Update README Fix typo's Remove some duplicates Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/man3/CTLOG_STORE_get0_log_by_id.pod')
-rw-r--r--doc/man3/CTLOG_STORE_get0_log_by_id.pod49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/man3/CTLOG_STORE_get0_log_by_id.pod b/doc/man3/CTLOG_STORE_get0_log_by_id.pod
new file mode 100644
index 0000000000..c517e95e0f
--- /dev/null
+++ b/doc/man3/CTLOG_STORE_get0_log_by_id.pod
@@ -0,0 +1,49 @@
+=pod
+
+=head1 NAME
+
+CTLOG_STORE_get0_log_by_id -
+Get a Certificate Transparency log from a CTLOG_STORE
+
+=head1 SYNOPSIS
+
+ #include <openssl/ct.h>
+
+ const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
+ const uint8_t *log_id,
+ size_t log_id_len);
+
+=head1 DESCRIPTION
+
+A Signed Certificate Timestamp (SCT) identifies the Certificate Transparency
+(CT) log that issued it using the log's LogID (see RFC 6962, Section 3.2).
+Therefore, it is useful to be able to look up more information about a log
+(e.g. its public key) using this LogID.
+
+CTLOG_STORE_get0_log_by_id() provides a way to do this. It will find a CTLOG
+in a CTLOG_STORE that has a given LogID.
+
+=head1 RETURN VALUES
+
+B<CTLOG_STORE_get0_log_by_id> returns a CTLOG with the given LogID, if it
+exists in the given CTLOG_STORE, otherwise it returns NULL.
+
+=head1 SEE ALSO
+
+L<ct(3)>,
+L<CTLOG_STORE_new(3)>
+
+=head1 HISTORY
+
+This function was added in OpenSSL 1.1.0.
+
+=head1 COPYRIGHT
+
+Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
+
+Licensed under the OpenSSL license (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
+=cut