Blame doc/man3/SCT_print.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SCT_print, SCT_LIST_print, SCT_validation_status_string -
Packit c4476c
Prints Signed Certificate Timestamps in a human-readable way
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ct.h>
Packit c4476c
Packit c4476c
 void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs);
Packit c4476c
 void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
Packit c4476c
                     const char *separator, const CTLOG_STORE *logs);
Packit c4476c
 const char *SCT_validation_status_string(const SCT *sct);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SCT_print() prints a single Signed Certificate Timestamp (SCT) to a L<bio> in
Packit c4476c
a human-readable format. SCT_LIST_print() prints an entire list of SCTs in a
Packit c4476c
similar way. A separator can be specified to delimit each SCT in the output.
Packit c4476c
Packit c4476c
The output can be indented by a specified number of spaces. If a B<CTLOG_STORE>
Packit c4476c
is provided, it will be used to print the description of the CT log that issued
Packit c4476c
each SCT (if that log is in the CTLOG_STORE). Alternatively, NULL can be passed
Packit c4476c
as the CTLOG_STORE parameter to disable this feature.
Packit c4476c
Packit c4476c
SCT_validation_status_string() will return the validation status of an SCT as
Packit c4476c
a human-readable string. Call SCT_validate() or SCT_LIST_validate()
Packit c4476c
beforehand in order to set the validation status of an SCT first.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SCT_validation_status_string() returns a null-terminated string representing
Packit c4476c
the validation status of an B<SCT> object.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ct(7)>,
Packit c4476c
L<bio(7)>,
Packit c4476c
L<CTLOG_STORE_new(3)>,
Packit c4476c
L<SCT_validate(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
These functions were added in OpenSSL 1.1.0.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut