| yuezonghe | 824eb0c | 2024-06-27 02:32:26 -0700 | [diff] [blame^] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | SCT_print, SCT_LIST_print, SCT_validation_status_string - |
| 6 | Prints Signed Certificate Timestamps in a human-readable way |
| 7 | |
| 8 | =head1 SYNOPSIS |
| 9 | |
| 10 | #include <openssl/ct.h> |
| 11 | |
| 12 | void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs); |
| 13 | void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent, |
| 14 | const char *separator, const CTLOG_STORE *logs); |
| 15 | const char *SCT_validation_status_string(const SCT *sct); |
| 16 | |
| 17 | =head1 DESCRIPTION |
| 18 | |
| 19 | SCT_print() prints a single Signed Certificate Timestamp (SCT) to a L<bio> in |
| 20 | a human-readable format. SCT_LIST_print() prints an entire list of SCTs in a |
| 21 | similar way. A separator can be specified to delimit each SCT in the output. |
| 22 | |
| 23 | The output can be indented by a specified number of spaces. If a B<CTLOG_STORE> |
| 24 | is provided, it will be used to print the description of the CT log that issued |
| 25 | each SCT (if that log is in the CTLOG_STORE). Alternatively, NULL can be passed |
| 26 | as the CTLOG_STORE parameter to disable this feature. |
| 27 | |
| 28 | SCT_validation_status_string() will return the validation status of an SCT as |
| 29 | a human-readable string. Call SCT_validate() or SCT_LIST_validate() |
| 30 | beforehand in order to set the validation status of an SCT first. |
| 31 | |
| 32 | =head1 RETURN VALUES |
| 33 | |
| 34 | SCT_validation_status_string() returns a null-terminated string representing |
| 35 | the validation status of an B<SCT> object. |
| 36 | |
| 37 | =head1 SEE ALSO |
| 38 | |
| 39 | L<ct(7)>, |
| 40 | L<bio(7)>, |
| 41 | L<CTLOG_STORE_new(3)>, |
| 42 | L<SCT_validate(3)> |
| 43 | |
| 44 | =head1 HISTORY |
| 45 | |
| 46 | These functions were added in OpenSSL 1.1.0. |
| 47 | |
| 48 | =head1 COPYRIGHT |
| 49 | |
| 50 | Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved. |
| 51 | |
| 52 | Licensed under the OpenSSL license (the "License"). You may not use |
| 53 | this file except in compliance with the License. You can obtain a copy |
| 54 | in the file LICENSE in the source distribution or at |
| 55 | L<https://www.openssl.org/source/license.html>. |
| 56 | |
| 57 | =cut |