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