Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_ctlog_list_file.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 "SSL_CTX_SET_CTLOG_LIST_FILE 3SSL"
58 .TH SSL_CTX_SET_CTLOG_LIST_FILE 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 SSL_CTX_set_default_ctlog_list_file, SSL_CTX_set_ctlog_list_file \-
65 load a Certificate Transparency log list from a file
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/ssl.h>
70 \&
71 \& int SSL_CTX_set_default_ctlog_list_file(SSL_CTX *ctx);
72 \& int SSL_CTX_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_CTX_set_default_ctlog_list_file()\fR loads a list of Certificate Transparency
77 (CT) logs from the default file location, "ct_log_list.cnf", found in the
78 directory where OpenSSL is installed.
79 .PP
80 \&\fBSSL_CTX_set_ctlog_list_file()\fR loads a list of CT logs from a specific path.
81 See \fBCTLOG_STORE_new\fR\|(3) for the file format.
82 .SH NOTES
83 .IX Header "NOTES"
84 These functions will not clear the existing CT log list \- it will be appended
85 to. To replace the existing list, use \fBSSL_CTX_set0_ctlog_store\fR\|(3) first.
86 .PP
87 If an error occurs whilst parsing a particular log entry in the file, that log
88 entry will be skipped.
89 .SH "RETURN VALUES"
90 .IX Header "RETURN VALUES"
91 \&\fBSSL_CTX_set_default_ctlog_list_file()\fR and \fBSSL_CTX_set_ctlog_list_file()\fR
92 return 1 if the log list is successfully loaded, and 0 if an error occurs. In
93 the case of an error, the log list may have been partially loaded.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 \&\fBssl\fR\|(7),
97 \&\fBSSL_CTX_set_ct_validation_callback\fR\|(3),
98 \&\fBCTLOG_STORE_new\fR\|(3)
99 .SH COPYRIGHT
100 .IX Header "COPYRIGHT"
101 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
102 .PP
103 Licensed under the Apache License 2.0 (the "License"). You may not use
104 this file except in compliance with the License. You can obtain a copy
105 in the file LICENSE in the source distribution or at
106 <https://www.openssl.org/source/license.html>.