xref: /freebsd/crypto/openssl/doc/man3/SCT_print.pod (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1=pod
2
3=head1 NAME
4
5SCT_print, SCT_LIST_print, SCT_validation_status_string -
6Prints 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
19SCT_print() prints a single Signed Certificate Timestamp (SCT) to a L<bio> in
20a human-readable format. SCT_LIST_print() prints an entire list of SCTs in a
21similar way. A separator can be specified to delimit each SCT in the output.
22
23The output can be indented by a specified number of spaces. If a B<CTLOG_STORE>
24is provided, it will be used to print the description of the CT log that issued
25each SCT (if that log is in the CTLOG_STORE). Alternatively, NULL can be passed
26as the CTLOG_STORE parameter to disable this feature.
27
28SCT_validation_status_string() will return the validation status of an SCT as
29a human-readable string. Call SCT_validate() or SCT_LIST_validate()
30beforehand in order to set the validation status of an SCT first.
31
32=head1 RETURN VALUES
33
34SCT_validation_status_string() returns a null-terminated string representing
35the validation status of an B<SCT> object.
36
37=head1 SEE ALSO
38
39L<ct(7)>,
40L<bio(7)>,
41L<CTLOG_STORE_new(3)>,
42L<SCT_validate(3)>
43
44=head1 HISTORY
45
46These functions were added in OpenSSL 1.1.0.
47
48=head1 COPYRIGHT
49
50Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
51
52Licensed under the OpenSSL license (the "License").  You may not use
53this file except in compliance with the License.  You can obtain a copy
54in the file LICENSE in the source distribution or at
55L<https://www.openssl.org/source/license.html>.
56
57=cut
58