Debian Codegraph @

upstream/debian-unstable/man1/openssl-s_time.1ssl

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 "OPENSSL-S_TIME 1SSL"
58 .TH OPENSSL-S_TIME 1SSL 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 openssl\-s_time \- SSL/TLS performance timing program
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl\fR \fBs_time\fR
68 [\fB\-help\fR]
69 [\fB\-connect\fR \fIhost\fR:\fIport\fR]
70 [\fB\-www\fR \fIpage\fR]
71 [\fB\-cert\fR \fIfilename\fR]
72 [\fB\-key\fR \fIfilename\fR]
73 [\fB\-reuse\fR]
74 [\fB\-new\fR]
75 [\fB\-verify\fR \fIdepth\fR]
76 [\fB\-time\fR \fIseconds\fR]
77 [\fB\-ssl3\fR]
78 [\fB\-tls1\fR]
79 [\fB\-tls1_1\fR]
80 [\fB\-tls1_2\fR]
81 [\fB\-tls1_3\fR]
82 [\fB\-bugs\fR]
83 [\fB\-cipher\fR \fIcipherlist\fR]
84 [\fB\-ciphersuites\fR \fIval\fR]
85 [\fB\-nameopt\fR \fIoption\fR]
86 [\fB\-cafile\fR \fIfile\fR]
87 [\fB\-CAfile\fR \fIfile\fR]
88 [\fB\-no\-CAfile\fR]
89 [\fB\-CApath\fR \fIdir\fR]
90 [\fB\-no\-CApath\fR]
91 [\fB\-CAstore\fR \fIuri\fR]
92 [\fB\-no\-CAstore\fR]
93 [\fB\-provider\fR \fIname\fR]
94 [\fB\-provider\-path\fR \fIpath\fR]
95 [\fB\-provparam\fR \fI[name:]key=value\fR]
96 [\fB\-propquery\fR \fIpropq\fR]
97 .SH DESCRIPTION
98 .IX Header "DESCRIPTION"
99 This command implements a generic SSL/TLS client which
100 connects to a remote host using SSL/TLS. It can request a page from the server
101 and includes the time to transfer the payload data in its timing measurements.
102 It measures the number of connections within a given timeframe, the amount of
103 data transferred (if any), and calculates the average time spent for one
104 connection.
105 .SH OPTIONS
106 .IX Header "OPTIONS"
107 .IP \fB\-help\fR 4
108 .IX Item "-help"
109 Print out a usage message.
110 .IP "\fB\-connect\fR \fIhost\fR:\fIport\fR" 4
111 .IX Item "-connect host:port"
112 This specifies the host and optional port to connect to.
113 If the host string is an IPv6 address, it must be enclosed in \f(CW\*(C`[\*(C'\fR and \f(CW\*(C`]\*(C'\fR.
114 .IP "\fB\-www\fR \fIpage\fR" 4
115 .IX Item "-www page"
116 This specifies the page to GET from the server. A value of '/' gets the
117 \&\fIindex.html\fR page. If this parameter is not specified, then this command
118 will only perform the handshake to establish SSL connections but not transfer
119 any payload data.
120 .IP "\fB\-cert\fR \fIcertname\fR" 4
121 .IX Item "-cert certname"
122 The certificate to use, if one is requested by the server. The default is
123 not to use a certificate. The file is in PEM format.
124 .IP "\fB\-key\fR \fIkeyfile\fR" 4
125 .IX Item "-key keyfile"
126 The private key to use. If not specified then the certificate file will
127 be used. The file is in PEM format.
128 .IP "\fB\-verify\fR \fIdepth\fR" 4
129 .IX Item "-verify depth"
130 The verify depth to use. This specifies the maximum length of the
131 server certificate chain and turns on server certificate verification.
132 Currently the verify operation continues after errors so all the problems
133 with a certificate chain can be seen. As a side effect the connection
134 will never fail due to a server certificate verify failure.
135 .IP \fB\-new\fR 4
136 .IX Item "-new"
137 Performs the timing test using a new session ID for each connection.
138 If neither \fB\-new\fR nor \fB\-reuse\fR are specified, they are both on by default
139 and executed in sequence.
140 .IP \fB\-reuse\fR 4
141 .IX Item "-reuse"
142 Performs the timing test using the same session ID; this can be used as a test
143 that session caching is working. If neither \fB\-new\fR nor \fB\-reuse\fR are
144 specified, they are both on by default and executed in sequence.
145 .IP \fB\-bugs\fR 4
146 .IX Item "-bugs"
147 There are several known bugs in SSL and TLS implementations. Adding this
148 option enables various workarounds.
149 .IP "\fB\-cipher\fR \fIcipherlist\fR" 4
150 .IX Item "-cipher cipherlist"
151 This allows the TLSv1.2 and below cipher list sent by the client to be modified.
152 This list will be combined with any TLSv1.3 ciphersuites that have been
153 configured. Although the server determines which cipher suite is used it should
154 take the first supported cipher in the list sent by the client. See
155 \&\fBopenssl\-ciphers\fR\|(1) for more information.
156 .IP "\fB\-ciphersuites\fR \fIval\fR" 4
157 .IX Item "-ciphersuites val"
158 This allows the TLSv1.3 ciphersuites sent by the client to be modified. This
159 list will be combined with any TLSv1.2 and below ciphersuites that have been
160 configured. Although the server determines which cipher suite is used it should
161 take the first supported cipher in the list sent by the client. See
162 \&\fBopenssl\-ciphers\fR\|(1) for more information. The format for this list is a
163 simple colon (":") separated list of TLSv1.3 ciphersuite names.
164 .IP "\fB\-time\fR \fIlength\fR" 4
165 .IX Item "-time length"
166 Specifies how long (in seconds) this command should establish connections
167 and optionally transfer payload data from a server. Server and client
168 performance and the link speed determine how many connections it
169 can establish.
170 .IP "\fB\-nameopt\fR \fIoption\fR" 4
171 .IX Item "-nameopt option"
172 This specifies how the subject or issuer names are displayed.
173 See \fBopenssl\-namedisplay\-options\fR\|(1) for details.
174 .IP "\fB\-CAfile\fR \fIfile\fR, \fB\-no\-CAfile\fR, \fB\-CApath\fR \fIdir\fR, \fB\-no\-CApath\fR, \fB\-CAstore\fR \fIuri\fR, \fB\-no\-CAstore\fR" 4
175 .IX Item "-CAfile file, -no-CAfile, -CApath dir, -no-CApath, -CAstore uri, -no-CAstore"
176 See "Trusted Certificate Options" in \fBopenssl\-verification\-options\fR\|(1) for details.
177 .IP "\fB\-provider\fR \fIname\fR" 4
178 .IX Item "-provider name"
179 .PD 0
180 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
181 .IX Item "-provider-path path"
182 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
183 .IX Item "-provparam [name:]key=value"
184 .IP "\fB\-propquery\fR \fIpropq\fR" 4
185 .IX Item "-propquery propq"
186 .PD
187 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
188 .IP "\fB\-cafile\fR \fIfile\fR" 4
189 .IX Item "-cafile file"
190 This is an obsolete synonym for \fB\-CAfile\fR.
191 .IP "\fB\-ssl3\fR, \fB\-tls1\fR, \fB\-tls1_1\fR, \fB\-tls1_2\fR, \fB\-tls1_3\fR" 4
192 .IX Item "-ssl3, -tls1, -tls1_1, -tls1_2, -tls1_3"
193 See "TLS Version Options" in \fBopenssl\fR\|(1).
194 .SH ENVIRONMENT
195 .IX Header "ENVIRONMENT"
196 .IP \fBSSL_CIPHER\fR 4
197 .IX Item "SSL_CIPHER"
198 If the \fB\-cipher\fR option is not specified, the contents of this environment
199 variable are used to modify the TLSv1.2 and below cipher list sent
200 by the client the same way the aforementioned option does.
201 .SH NOTES
202 .IX Header "NOTES"
203 This command can be used to measure the performance of an SSL connection.
204 To connect to an SSL HTTP server and get the default page the command
205 .PP
206 .Vb 1
207 \& openssl s_time \-connect servername:443 \-www / \-CApath yourdir \-CAfile yourfile.pem \-cipher commoncipher [\-ssl3]
208 .Ve
209 .PP
210 would typically be used (https uses port 443). \fIcommoncipher\fR is a cipher to
211 which both client and server can agree, see the \fBopenssl\-ciphers\fR\|(1) command
212 for details.
213 .PP
214 If the handshake fails then there are several possible causes, if it is
215 nothing obvious like no client certificate then the \fB\-bugs\fR and
216 \&\fB\-ssl3\fR options can be tried
217 in case it is a buggy server. In particular you should play with these
218 options \fBbefore\fR submitting a bug report to an OpenSSL mailing list.
219 .PP
220 A frequent problem when attempting to get client certificates working
221 is that a web client complains it has no certificates or gives an empty
222 list to choose from. This is normally because the server is not sending
223 the clients certificate authority in its "acceptable CA list" when it
224 requests a certificate. By using \fBopenssl\-s_client\fR\|(1) the CA list can be
225 viewed and checked. However, some servers only request client authentication
226 after a specific URL is requested. To obtain the list in this case it
227 is necessary to use the \fB\-prexit\fR option of \fBopenssl\-s_client\fR\|(1) and
228 send an HTTP request for an appropriate page.
229 .PP
230 If a certificate is specified on the command line using the \fB\-cert\fR
231 option it will not be used unless the server specifically requests
232 a client certificate. Therefore, merely including a client certificate
233 on the command line is no guarantee that the certificate works.
234 .SH BUGS
235 .IX Header "BUGS"
236 Because this program does not have all the options of the
237 \&\fBopenssl\-s_client\fR\|(1) program to turn protocols on and off, you may not
238 be able to measure the performance of all protocols with all servers.
239 .PP
240 The \fB\-verify\fR option should really exit if the server verification
241 fails.
242 .SH HISTORY
243 .IX Header "HISTORY"
244 The \fB\-cafile\fR option was deprecated in OpenSSL 3.0.
245 .SH "SEE ALSO"
246 .IX Header "SEE ALSO"
247 \&\fBopenssl\fR\|(1),
248 \&\fBopenssl\-s_client\fR\|(1),
249 \&\fBopenssl\-s_server\fR\|(1),
250 \&\fBopenssl\-ciphers\fR\|(1),
251 \&\fBossl_store\-file\fR\|(7)
252 .SH COPYRIGHT
253 .IX Header "COPYRIGHT"
254 Copyright 2004\-2025 The OpenSSL Project Authors. All Rights Reserved.
255 .PP
256 Licensed under the Apache License 2.0 (the "License"). You may not use
257 this file except in compliance with the License. You can obtain a copy
258 in the file LICENSE in the source distribution or at
259 <https://www.openssl.org/source/license.html>.