Fix descriptions of credentials and verification options for various apps
[openssl.git] / apps / s_time.c
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13
14 #include <openssl/opensslconf.h>
15
16 #ifndef OPENSSL_NO_SOCK
17
18 #include "apps.h"
19 #include "progs.h"
20 #include <openssl/x509.h>
21 #include <openssl/ssl.h>
22 #include <openssl/pem.h>
23 #include "s_apps.h"
24 #include <openssl/err.h>
25 #include <internal/sockets.h>
26 #if !defined(OPENSSL_SYS_MSDOS)
27 # include <unistd.h>
28 #endif
29
30 #define SSL_CONNECT_NAME        "localhost:4433"
31
32 #define SECONDS 30
33 #define SECONDSSTR "30"
34
35 static SSL *doConnection(SSL *scon, const char *host, SSL_CTX *ctx);
36
37 /*
38  * Define a HTTP get command globally.
39  * Also define the size of the command, this is two bytes less than
40  * the size of the string because the %s is replaced by the URL.
41  */
42 static const char fmt_http_get_cmd[] = "GET %s HTTP/1.0\r\n\r\n";
43 static const size_t fmt_http_get_cmd_size = sizeof(fmt_http_get_cmd) - 2;
44
45 typedef enum OPTION_choice {
46     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
47     OPT_CONNECT, OPT_CIPHER, OPT_CIPHERSUITES, OPT_CERT, OPT_NAMEOPT, OPT_KEY,
48     OPT_CAPATH, OPT_CAFILE, OPT_CASTORE,
49     OPT_NOCAPATH, OPT_NOCAFILE, OPT_NOCASTORE,
50     OPT_NEW, OPT_REUSE, OPT_BUGS, OPT_VERIFY, OPT_TIME, OPT_SSL3,
51     OPT_WWW, OPT_TLS1, OPT_TLS1_1, OPT_TLS1_2, OPT_TLS1_3,
52     OPT_PROV_ENUM
53 } OPTION_CHOICE;
54
55 const OPTIONS s_time_options[] = {
56     OPT_SECTION("General"),
57     {"help", OPT_HELP, '-', "Display this summary"},
58
59     OPT_SECTION("Connection"),
60     {"connect", OPT_CONNECT, 's',
61      "Where to connect as post:port (default is " SSL_CONNECT_NAME ")"},
62     {"new", OPT_NEW, '-', "Just time new connections"},
63     {"reuse", OPT_REUSE, '-', "Just time connection reuse"},
64     {"bugs", OPT_BUGS, '-', "Turn on SSL bug compatibility"},
65     {"cipher", OPT_CIPHER, 's', "TLSv1.2 and below cipher list to be used"},
66     {"ciphersuites", OPT_CIPHERSUITES, 's',
67      "Specify TLSv1.3 ciphersuites to be used"},
68 #ifndef OPENSSL_NO_SSL3
69     {"ssl3", OPT_SSL3, '-', "Just use SSLv3"},
70 #endif
71 #ifndef OPENSSL_NO_TLS1
72     {"tls1", OPT_TLS1, '-', "Just use TLSv1.0"},
73 #endif
74 #ifndef OPENSSL_NO_TLS1_1
75     {"tls1_1", OPT_TLS1_1, '-', "Just use TLSv1.1"},
76 #endif
77 #ifndef OPENSSL_NO_TLS1_2
78     {"tls1_2", OPT_TLS1_2, '-', "Just use TLSv1.2"},
79 #endif
80 #ifndef OPENSSL_NO_TLS1_3
81     {"tls1_3", OPT_TLS1_3, '-', "Just use TLSv1.3"},
82 #endif
83     {"verify", OPT_VERIFY, 'p',
84      "Turn on peer certificate verification, set depth"},
85     {"time", OPT_TIME, 'p', "Seconds to collect data, default " SECONDSSTR},
86     {"www", OPT_WWW, 's', "Fetch specified page from the site"},
87
88     OPT_SECTION("Certificate"),
89     {"nameopt", OPT_NAMEOPT, 's', "Certificate subject/issuer name printing options"},
90     {"cert", OPT_CERT, '<', "Cert file to use, PEM format assumed"},
91     {"key", OPT_KEY, '<', "File with key, PEM; default is -cert file"},
92     {"cafile", OPT_CAFILE, '<', "PEM format file of CA's"},
93     {"CAfile", OPT_CAFILE, '<', "PEM format file of CA's"},
94     {"CApath", OPT_CAPATH, '/', "PEM format directory of CA's"},
95     {"CAstore", OPT_CASTORE, ':', "URI to store of CA's"},
96     {"no-CAfile", OPT_NOCAFILE, '-',
97      "Do not load the default certificates file"},
98     {"no-CApath", OPT_NOCAPATH, '-',
99      "Do not load certificates from the default certificates directory"},
100     {"no-CAstore", OPT_NOCASTORE, '-',
101      "Do not load certificates from the default certificates store URI"},
102
103     OPT_PROV_OPTIONS,
104     {NULL}
105 };
106
107 #define START   0
108 #define STOP    1
109
110 static double tm_Time_F(int s)
111 {
112     return app_tminterval(s, 1);
113 }
114
115 int s_time_main(int argc, char **argv)
116 {
117     char buf[1024 * 8];
118     SSL *scon = NULL;
119     SSL_CTX *ctx = NULL;
120     const SSL_METHOD *meth = NULL;
121     char *CApath = NULL, *CAfile = NULL, *CAstore = NULL;
122     char *cipher = NULL, *ciphersuites = NULL;
123     char *www_path = NULL;
124     char *host = SSL_CONNECT_NAME, *certfile = NULL, *keyfile = NULL, *prog;
125     double totalTime = 0.0;
126     int noCApath = 0, noCAfile = 0, noCAstore = 0;
127     int maxtime = SECONDS, nConn = 0, perform = 3, ret = 1, i, st_bugs = 0;
128     long bytes_read = 0, finishtime = 0;
129     OPTION_CHOICE o;
130     int min_version = 0, max_version = 0, ver, buf_len;
131     size_t buf_size;
132
133     meth = TLS_client_method();
134
135     prog = opt_init(argc, argv, s_time_options);
136     while ((o = opt_next()) != OPT_EOF) {
137         switch (o) {
138         case OPT_EOF:
139         case OPT_ERR:
140  opthelp:
141             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
142             goto end;
143         case OPT_HELP:
144             opt_help(s_time_options);
145             ret = 0;
146             goto end;
147         case OPT_CONNECT:
148             host = opt_arg();
149             break;
150         case OPT_REUSE:
151             perform = 2;
152             break;
153         case OPT_NEW:
154             perform = 1;
155             break;
156         case OPT_VERIFY:
157             if (!opt_int(opt_arg(), &verify_args.depth))
158                 goto opthelp;
159             BIO_printf(bio_err, "%s: verify depth is %d\n",
160                        prog, verify_args.depth);
161             break;
162         case OPT_CERT:
163             certfile = opt_arg();
164             break;
165         case OPT_NAMEOPT:
166             if (!set_nameopt(opt_arg()))
167                 goto end;
168             break;
169         case OPT_KEY:
170             keyfile = opt_arg();
171             break;
172         case OPT_CAPATH:
173             CApath = opt_arg();
174             break;
175         case OPT_CAFILE:
176             CAfile = opt_arg();
177             break;
178         case OPT_NOCAPATH:
179             noCApath = 1;
180             break;
181         case OPT_NOCAFILE:
182             noCAfile = 1;
183             break;
184         case OPT_CASTORE:
185             CAstore = opt_arg();
186             break;
187         case OPT_NOCASTORE:
188             noCAstore = 1;
189             break;
190         case OPT_CIPHER:
191             cipher = opt_arg();
192             break;
193         case OPT_CIPHERSUITES:
194             ciphersuites = opt_arg();
195             break;
196         case OPT_BUGS:
197             st_bugs = 1;
198             break;
199         case OPT_TIME:
200             if (!opt_int(opt_arg(), &maxtime))
201                 goto opthelp;
202             break;
203         case OPT_WWW:
204             www_path = opt_arg();
205             buf_size = strlen(www_path) + fmt_http_get_cmd_size;
206             if (buf_size > sizeof(buf)) {
207                 BIO_printf(bio_err, "%s: -www option is too long\n", prog);
208                 goto end;
209             }
210             break;
211         case OPT_SSL3:
212             min_version = SSL3_VERSION;
213             max_version = SSL3_VERSION;
214             break;
215         case OPT_TLS1:
216             min_version = TLS1_VERSION;
217             max_version = TLS1_VERSION;
218             break;
219         case OPT_TLS1_1:
220             min_version = TLS1_1_VERSION;
221             max_version = TLS1_1_VERSION;
222             break;
223         case OPT_TLS1_2:
224             min_version = TLS1_2_VERSION;
225             max_version = TLS1_2_VERSION;
226             break;
227         case OPT_TLS1_3:
228             min_version = TLS1_3_VERSION;
229             max_version = TLS1_3_VERSION;
230             break;
231         case OPT_PROV_CASES:
232             if (!opt_provider(o))
233                 goto end;
234             break;
235         }
236     }
237     argc = opt_num_rest();
238     if (argc != 0)
239         goto opthelp;
240
241     if (cipher == NULL)
242         cipher = getenv("SSL_CIPHER");
243
244     if ((ctx = SSL_CTX_new(meth)) == NULL)
245         goto end;
246
247     SSL_CTX_set_mode(ctx, SSL_MODE_AUTO_RETRY);
248     SSL_CTX_set_quiet_shutdown(ctx, 1);
249     if (SSL_CTX_set_min_proto_version(ctx, min_version) == 0)
250         goto end;
251     if (SSL_CTX_set_max_proto_version(ctx, max_version) == 0)
252         goto end;
253
254     if (st_bugs)
255         SSL_CTX_set_options(ctx, SSL_OP_ALL);
256     if (cipher != NULL && !SSL_CTX_set_cipher_list(ctx, cipher))
257         goto end;
258     if (ciphersuites != NULL && !SSL_CTX_set_ciphersuites(ctx, ciphersuites))
259         goto end;
260     if (!set_cert_stuff(ctx, certfile, keyfile))
261         goto end;
262
263     if (!ctx_set_verify_locations(ctx, CAfile, noCAfile, CApath, noCApath,
264                                   CAstore, noCAstore)) {
265         ERR_print_errors(bio_err);
266         goto end;
267     }
268     if (!(perform & 1))
269         goto next;
270     printf("Collecting connection statistics for %d seconds\n", maxtime);
271
272     /* Loop and time how long it takes to make connections */
273
274     bytes_read = 0;
275     finishtime = (long)time(NULL) + maxtime;
276     tm_Time_F(START);
277     for (;;) {
278         if (finishtime < (long)time(NULL))
279             break;
280
281         if ((scon = doConnection(NULL, host, ctx)) == NULL)
282             goto end;
283
284         if (www_path != NULL) {
285             buf_len = BIO_snprintf(buf, sizeof(buf), fmt_http_get_cmd,
286                                    www_path);
287             if (buf_len <= 0 || SSL_write(scon, buf, buf_len) <= 0)
288                 goto end;
289             while ((i = SSL_read(scon, buf, sizeof(buf))) > 0)
290                 bytes_read += i;
291         }
292         SSL_set_shutdown(scon, SSL_SENT_SHUTDOWN | SSL_RECEIVED_SHUTDOWN);
293         BIO_closesocket(SSL_get_fd(scon));
294
295         nConn += 1;
296         if (SSL_session_reused(scon)) {
297             ver = 'r';
298         } else {
299             ver = SSL_version(scon);
300             if (ver == TLS1_VERSION)
301                 ver = 't';
302             else if (ver == SSL3_VERSION)
303                 ver = '3';
304             else
305                 ver = '*';
306         }
307         fputc(ver, stdout);
308         fflush(stdout);
309
310         SSL_free(scon);
311         scon = NULL;
312     }
313     totalTime += tm_Time_F(STOP); /* Add the time for this iteration */
314
315     i = (int)((long)time(NULL) - finishtime + maxtime);
316     printf
317         ("\n\n%d connections in %.2fs; %.2f connections/user sec, bytes read %ld\n",
318          nConn, totalTime, ((double)nConn / totalTime), bytes_read);
319     printf
320         ("%d connections in %ld real seconds, %ld bytes read per connection\n",
321          nConn, (long)time(NULL) - finishtime + maxtime, bytes_read / nConn);
322
323     /*
324      * Now loop and time connections using the same session id over and over
325      */
326
327  next:
328     if (!(perform & 2))
329         goto end;
330     printf("\n\nNow timing with session id reuse.\n");
331
332     /* Get an SSL object so we can reuse the session id */
333     if ((scon = doConnection(NULL, host, ctx)) == NULL) {
334         BIO_printf(bio_err, "Unable to get connection\n");
335         goto end;
336     }
337
338     if (www_path != NULL) {
339         buf_len = BIO_snprintf(buf, sizeof(buf), fmt_http_get_cmd, www_path);
340         if (buf_len <= 0 || SSL_write(scon, buf, buf_len) <= 0)
341             goto end;
342         while ((i = SSL_read(scon, buf, sizeof(buf))) > 0)
343             continue;
344     }
345     SSL_set_shutdown(scon, SSL_SENT_SHUTDOWN | SSL_RECEIVED_SHUTDOWN);
346     BIO_closesocket(SSL_get_fd(scon));
347
348     nConn = 0;
349     totalTime = 0.0;
350
351     finishtime = (long)time(NULL) + maxtime;
352
353     printf("starting\n");
354     bytes_read = 0;
355     tm_Time_F(START);
356
357     for (;;) {
358         if (finishtime < (long)time(NULL))
359             break;
360
361         if ((doConnection(scon, host, ctx)) == NULL)
362             goto end;
363
364         if (www_path != NULL) {
365             buf_len = BIO_snprintf(buf, sizeof(buf), fmt_http_get_cmd,
366                                    www_path);
367             if (buf_len <= 0 || SSL_write(scon, buf, buf_len) <= 0)
368                 goto end;
369             while ((i = SSL_read(scon, buf, sizeof(buf))) > 0)
370                 bytes_read += i;
371         }
372         SSL_set_shutdown(scon, SSL_SENT_SHUTDOWN | SSL_RECEIVED_SHUTDOWN);
373         BIO_closesocket(SSL_get_fd(scon));
374
375         nConn += 1;
376         if (SSL_session_reused(scon)) {
377             ver = 'r';
378         } else {
379             ver = SSL_version(scon);
380             if (ver == TLS1_VERSION)
381                 ver = 't';
382             else if (ver == SSL3_VERSION)
383                 ver = '3';
384             else
385                 ver = '*';
386         }
387         fputc(ver, stdout);
388         fflush(stdout);
389     }
390     totalTime += tm_Time_F(STOP); /* Add the time for this iteration */
391
392     printf
393         ("\n\n%d connections in %.2fs; %.2f connections/user sec, bytes read %ld\n",
394          nConn, totalTime, ((double)nConn / totalTime), bytes_read);
395     printf
396         ("%d connections in %ld real seconds, %ld bytes read per connection\n",
397          nConn, (long)time(NULL) - finishtime + maxtime, bytes_read / nConn);
398
399     ret = 0;
400
401  end:
402     SSL_free(scon);
403     SSL_CTX_free(ctx);
404     return ret;
405 }
406
407 /*-
408  * doConnection - make a connection
409  */
410 static SSL *doConnection(SSL *scon, const char *host, SSL_CTX *ctx)
411 {
412     BIO *conn;
413     SSL *serverCon;
414     int i;
415
416     if ((conn = BIO_new(BIO_s_connect())) == NULL)
417         return NULL;
418
419     BIO_set_conn_hostname(conn, host);
420     BIO_set_conn_mode(conn, BIO_SOCK_NODELAY);
421
422     if (scon == NULL)
423         serverCon = SSL_new(ctx);
424     else {
425         serverCon = scon;
426         SSL_set_connect_state(serverCon);
427     }
428
429     SSL_set_bio(serverCon, conn, conn);
430
431     /* ok, lets connect */
432     i = SSL_connect(serverCon);
433     if (i <= 0) {
434         BIO_printf(bio_err, "ERROR\n");
435         if (verify_args.error != X509_V_OK)
436             BIO_printf(bio_err, "verify error:%s\n",
437                        X509_verify_cert_error_string(verify_args.error));
438         else
439             ERR_print_errors(bio_err);
440         if (scon == NULL)
441             SSL_free(serverCon);
442         return NULL;
443     }
444
445 #if defined(SOL_SOCKET) && defined(SO_LINGER)
446     {
447         struct linger no_linger;
448         int fd;
449
450         no_linger.l_onoff  = 1;
451         no_linger.l_linger = 0;
452         fd = SSL_get_fd(serverCon);
453         if (fd >= 0)
454             (void)setsockopt(fd, SOL_SOCKET, SO_LINGER, (char*)&no_linger,
455                              sizeof(no_linger));
456     }
457 #endif
458
459     return serverCon;
460 }
461 #endif /* OPENSSL_NO_SOCK */