Debian Codegraph @

upstream/debian-unstable/man3/SCT_print.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SCT_PRINT 3SSL"
58 .TH SCT_PRINT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SCT_print, SCT_LIST_print, SCT_validation_status_string \-
65 Prints Signed Certificate Timestamps in a human\-readable way
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ct.h>
70 \&
71 \& void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs);
72 \& void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
73 \& const char *separator, const CTLOG_STORE *logs);
74 \& const char *SCT_validation_status_string(const SCT *sct);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBSCT_print()\fR prints a single Signed Certificate Timestamp (SCT) to a \fBBIO\fR in
79 a human-readable format. \fBSCT_LIST_print()\fR prints an entire list of SCTs in a
80 similar way. A separator can be specified to delimit each SCT in the output.
81 .PP
82 The output can be indented by a specified number of spaces. If a \fBCTLOG_STORE\fR
83 is provided, it will be used to print the description of the CT log that issued
84 each SCT (if that log is in the CTLOG_STORE). Alternatively, NULL can be passed
85 as the CTLOG_STORE parameter to disable this feature.
86 .PP
87 \&\fBSCT_validation_status_string()\fR will return the validation status of an SCT as
88 a human-readable string. Call \fBSCT_validate()\fR or \fBSCT_LIST_validate()\fR
89 beforehand in order to set the validation status of an SCT first.
90 .SH "RETURN VALUES"
91 .IX Header "RETURN VALUES"
92 \&\fBSCT_validation_status_string()\fR returns a NUL-terminated string representing
93 the validation status of an \fBSCT\fR object.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBct\fR\|(7),
97 \&\fBbio\fR\|(7),
98 \&\fBCTLOG_STORE_new\fR\|(3),
99 \&\fBSCT_validate\fR\|(3)
100 .SH HISTORY
101 .IX Header "HISTORY"
102 These functions were added in OpenSSL 1.1.0.
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright 2016\-2018 The OpenSSL Project Authors. All Rights Reserved.
106 .PP
107 Licensed under the Apache License 2.0 (the "License"). You may not use
108 this file except in compliance with the License. You can obtain a copy
109 in the file LICENSE in the source distribution or at
110 <https://www.openssl.org/source/license.html>.