xref: /netbsd-src/crypto/external/bsd/openssl/dist/doc/man3/SCT_print.pod (revision b0d1725196a7921d003d2c66a14f186abda4176b)
113d40330Schristos=pod
213d40330Schristos
313d40330Schristos=head1 NAME
413d40330Schristos
513d40330SchristosSCT_print, SCT_LIST_print, SCT_validation_status_string -
613d40330SchristosPrints Signed Certificate Timestamps in a human-readable way
713d40330Schristos
813d40330Schristos=head1 SYNOPSIS
913d40330Schristos
1013d40330Schristos #include <openssl/ct.h>
1113d40330Schristos
1213d40330Schristos void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs);
1313d40330Schristos void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
1413d40330Schristos                     const char *separator, const CTLOG_STORE *logs);
1513d40330Schristos const char *SCT_validation_status_string(const SCT *sct);
1613d40330Schristos
1713d40330Schristos=head1 DESCRIPTION
1813d40330Schristos
19*b0d17251SchristosSCT_print() prints a single Signed Certificate Timestamp (SCT) to a B<BIO> in
2013d40330Schristosa human-readable format. SCT_LIST_print() prints an entire list of SCTs in a
2113d40330Schristossimilar way. A separator can be specified to delimit each SCT in the output.
2213d40330Schristos
2313d40330SchristosThe output can be indented by a specified number of spaces. If a B<CTLOG_STORE>
2413d40330Schristosis provided, it will be used to print the description of the CT log that issued
2513d40330Schristoseach SCT (if that log is in the CTLOG_STORE). Alternatively, NULL can be passed
2613d40330Schristosas the CTLOG_STORE parameter to disable this feature.
2713d40330Schristos
2813d40330SchristosSCT_validation_status_string() will return the validation status of an SCT as
2913d40330Schristosa human-readable string. Call SCT_validate() or SCT_LIST_validate()
3013d40330Schristosbeforehand in order to set the validation status of an SCT first.
3113d40330Schristos
3213d40330Schristos=head1 RETURN VALUES
3313d40330Schristos
34*b0d17251SchristosSCT_validation_status_string() returns a NUL-terminated string representing
3513d40330Schristosthe validation status of an B<SCT> object.
3613d40330Schristos
3713d40330Schristos=head1 SEE ALSO
3813d40330Schristos
3913d40330SchristosL<ct(7)>,
4013d40330SchristosL<bio(7)>,
4113d40330SchristosL<CTLOG_STORE_new(3)>,
4213d40330SchristosL<SCT_validate(3)>
4313d40330Schristos
4413d40330Schristos=head1 HISTORY
4513d40330Schristos
4613d40330SchristosThese functions were added in OpenSSL 1.1.0.
4713d40330Schristos
4813d40330Schristos=head1 COPYRIGHT
4913d40330Schristos
50*b0d17251SchristosCopyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
5113d40330Schristos
52*b0d17251SchristosLicensed under the Apache License 2.0 (the "License").  You may not use
5313d40330Schristosthis file except in compliance with the License.  You can obtain a copy
5413d40330Schristosin the file LICENSE in the source distribution or at
5513d40330SchristosL<https://www.openssl.org/source/license.html>.
5613d40330Schristos
5713d40330Schristos=cut
58