root/usr.bin/openssl/s_time.c
/* $OpenBSD: s_time.c,v 1.39 2025/01/02 13:10:03 tb Exp $ */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 *
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 *
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 *
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

/*-----------------------------------------
   s_time - SSL client connection timer program
   Written and donated by Larry Streepy <streepy@healthcare.com>
  -----------------------------------------*/

#include <sys/types.h>
#include <sys/socket.h>

#include <stdio.h>
#include <stdlib.h>
#include <limits.h>
#include <string.h>
#include <unistd.h>
#include <poll.h>

#include "apps.h"

#include <openssl/err.h>
#include <openssl/pem.h>
#include <openssl/ssl.h>
#include <openssl/x509.h>

#define SSL_CONNECT_NAME        "localhost:4433"

#define BUFSIZZ 1024*10

#define MYBUFSIZ 1024*8

#define SECONDS 30
extern int verify_depth;

static void s_time_usage(void);
static int run_test(SSL *);
static int benchmark(int);
static void print_tally_mark(SSL *);

static SSL_CTX *tm_ctx = NULL;
static const SSL_METHOD *s_time_meth = NULL;
static long bytes_read = 0;

static struct {
        int bugs;
        char *CAfile;
        char *CApath;
        char *certfile;
        char *cipher;
        char *host;
        char *keyfile;
        time_t maxtime;
        int nbio;
        int no_shutdown;
        int perform;
        int verify;
        int verify_depth;
        char *www_path;
} cfg;

static const struct option s_time_options[] = {
        {
                .name = "bugs",
                .desc = "Enable workarounds for known SSL/TLS bugs",
                .type = OPTION_FLAG,
                .opt.flag = &cfg.bugs,
        },
        {
                .name = "CAfile",
                .argname = "file",
                .desc = "File containing trusted certificates in PEM format",
                .type = OPTION_ARG,
                .opt.arg = &cfg.CAfile,
        },
        {
                .name = "CApath",
                .argname = "path",
                .desc = "Directory containing trusted certificates",
                .type = OPTION_ARG,
                .opt.arg = &cfg.CApath,
        },
        {
                .name = "cert",
                .argname = "file",
                .desc = "Client certificate to use, if one is requested",
                .type = OPTION_ARG,
                .opt.arg = &cfg.certfile,
        },
        {
                .name = "cipher",
                .argname = "list",
                .desc = "List of cipher suites to send to the server",
                .type = OPTION_ARG,
                .opt.arg = &cfg.cipher,
        },
        {
                .name = "connect",
                .argname = "host:port",
                .desc = "Host and port to connect to (default "
                    SSL_CONNECT_NAME ")",
                .type = OPTION_ARG,
                .opt.arg = &cfg.host,
        },
        {
                .name = "key",
                .argname = "file",
                .desc = "Client private key to use, if one is required",
                .type = OPTION_ARG,
                .opt.arg = &cfg.keyfile,
        },
        {
                .name = "nbio",
                .desc = "Use non-blocking I/O",
                .type = OPTION_FLAG,
                .opt.flag = &cfg.nbio,
        },
        {
                .name = "new",
                .desc = "Use a new session ID for each connection",
                .type = OPTION_VALUE,
                .opt.value = &cfg.perform,
                .value = 1,
        },
        {
                .name = "no_shutdown",
                .desc = "Shut down the connection without notifying the server",
                .type = OPTION_FLAG,
                .opt.flag = &cfg.no_shutdown,
        },
        {
                .name = "reuse",
                .desc = "Reuse the same session ID for each connection",
                .type = OPTION_VALUE,
                .opt.value = &cfg.perform,
                .value = 2,
        },
        {
                .name = "time",
                .argname = "seconds",
                .desc = "Duration to perform timing tests for (default 30)",
                .type = OPTION_ARG_TIME,
                .opt.tvalue = &cfg.maxtime,
        },
        {
                .name = "verify",
                .argname = "depth",
                .desc = "Enable peer certificate verification with given depth",
                .type = OPTION_ARG_INT,
                .opt.value = &cfg.verify_depth,
        },
        {
                .name = "www",
                .argname = "page",
                .desc = "Page to GET from the server (default none)",
                .type = OPTION_ARG,
                .opt.arg = &cfg.www_path,
        },
        { NULL },
};

static void
s_time_usage(void)
{
        fprintf(stderr,
            "usage: s_time "
            "[-bugs] [-CAfile file] [-CApath directory] [-cert file]\n"
            "    [-cipher cipherlist] [-connect host:port] [-key keyfile]\n"
            "    [-nbio] [-new] [-no_shutdown] [-reuse] [-time seconds]\n"
            "    [-verify depth] [-www page]\n\n");
        options_usage(s_time_options);
}

/***********************************************************************
 * MAIN - main processing area for client
 *                      real name depends on MONOLITH
 */
int
s_time_main(int argc, char **argv)
{
        int ret = 1;

        if (pledge("stdio rpath inet dns", NULL) == -1) {
                perror("pledge");
                exit(1);
        }

        s_time_meth = TLS_client_method();

        verify_depth = 0;

        memset(&cfg, 0, sizeof(cfg));

        cfg.host = SSL_CONNECT_NAME;
        cfg.maxtime = SECONDS;
        cfg.perform = 3;
        cfg.verify = SSL_VERIFY_NONE;
        cfg.verify_depth = -1;

        if (options_parse(argc, argv, s_time_options, NULL, NULL) != 0) {
                s_time_usage();
                goto end;
        }

        if (cfg.verify_depth >= 0) {
                cfg.verify = SSL_VERIFY_PEER | SSL_VERIFY_CLIENT_ONCE;
                verify_depth = cfg.verify_depth;
                BIO_printf(bio_err, "verify depth is %d\n", verify_depth);
        }

        if (cfg.www_path != NULL &&
            strlen(cfg.www_path) > MYBUFSIZ - 100) {
                BIO_printf(bio_err, "-www option too long\n");
                goto end;
        }

        if ((tm_ctx = SSL_CTX_new(s_time_meth)) == NULL)
                return (1);

        SSL_CTX_set_quiet_shutdown(tm_ctx, 1);

        if (cfg.bugs)
                SSL_CTX_set_options(tm_ctx, SSL_OP_ALL);

        if (cfg.cipher != NULL) {
                if (!SSL_CTX_set_cipher_list(tm_ctx, cfg.cipher)) {
                        BIO_printf(bio_err, "error setting cipher list\n");
                        ERR_print_errors(bio_err);
                        goto end;
                }
        }

        SSL_CTX_set_verify(tm_ctx, cfg.verify, NULL);

        if (!set_cert_stuff(tm_ctx, cfg.certfile,
            cfg.keyfile))
                goto end;

        if ((!SSL_CTX_load_verify_locations(tm_ctx, cfg.CAfile,
            cfg.CApath)) ||
            (!SSL_CTX_set_default_verify_paths(tm_ctx))) {
                /*
                 * BIO_printf(bio_err,"error setting default verify
                 * locations\n");
                 */
                ERR_print_errors(bio_err);
                /* goto end; */
        }

        /* Loop and time how long it takes to make connections */
        if (cfg.perform & 1) {
                printf("Collecting connection statistics for %lld seconds\n",
                    (long long)cfg.maxtime);
                if (benchmark(0))
                        goto end;
        }
        /*
         * Now loop and time connections using the same session id over and
         * over
         */
        if (cfg.perform & 2) {
                printf("\n\nNow timing with session id reuse.\n");
                if (benchmark(1))
                        goto end;
        }
        ret = 0;
 end:
        if (tm_ctx != NULL) {
                SSL_CTX_free(tm_ctx);
                tm_ctx = NULL;
        }

        return (ret);
}

/***********************************************************************
 * run_test - make a connection, get a file, and shut down the connection
 *      
 * Args:
 *              scon    = SSL connection
 * Returns:
 *              1 on success, 0 on error
 */
static int
run_test(SSL *scon)
{
        char buf[1024 * 8];
        struct pollfd pfd[1];
        BIO *conn;
        long verify_error;
        int i, retval;

        if ((conn = BIO_new(BIO_s_connect())) == NULL)
                return 0;
        BIO_set_conn_hostname(conn, cfg.host);
        SSL_set_connect_state(scon);
        SSL_set_bio(scon, conn, conn);
        for (;;) {
                i = SSL_connect(scon);
                if (BIO_sock_should_retry(i)) {
                        BIO_printf(bio_err, "DELAY\n");
                        pfd[0].fd = SSL_get_fd(scon);
                        pfd[0].events = POLLIN;
                        poll(pfd, 1, -1);
                        continue;
                }
                break;
        }
        if (i <= 0) {
                BIO_printf(bio_err, "ERROR\n");
                verify_error = SSL_get_verify_result(scon);
                if (verify_error != X509_V_OK)
                        BIO_printf(bio_err, "verify error:%s\n",
                            X509_verify_cert_error_string(verify_error));
                else
                        ERR_print_errors(bio_err);
                return 0;
        }
        if (cfg.www_path != NULL) {
                retval = snprintf(buf, sizeof buf,
                    "GET %s HTTP/1.0\r\n\r\n", cfg.www_path);
                if (retval < 0 || retval >= sizeof buf) {
                        fprintf(stderr, "URL too long\n");
                        return 0;
                }
                if (SSL_write(scon, buf, retval) != retval)
                        return 0;
                while ((i = SSL_read(scon, buf, sizeof(buf))) > 0)
                        bytes_read += i;
        }
        if (cfg.no_shutdown)
                SSL_set_shutdown(scon, SSL_SENT_SHUTDOWN |
                    SSL_RECEIVED_SHUTDOWN);
        else
                SSL_shutdown(scon);
        return 1;
}

static void
print_tally_mark(SSL *scon)
{
        int ver;

        if (SSL_session_reused(scon))
                ver = 'r';
        else {
                ver = SSL_version(scon);
                if (ver == TLS1_VERSION)
                        ver = 't';
                else
                        ver = '*';
        }
        fputc(ver, stdout);
        fflush(stdout);
}

static int
benchmark(int reuse_session)
{
        double elapsed, totalTime;
        int nConn = 0;
        SSL *scon = NULL;
        int ret = 1;

        if (reuse_session) {
                /* Get an SSL object so we can reuse the session id */
                if ((scon = SSL_new(tm_ctx)) == NULL)
                        goto end;
                if (!run_test(scon)) {
                        fprintf(stderr, "Unable to get connection\n");
                        goto end;
                }
                printf("starting\n");
        }

        nConn = 0;
        bytes_read = 0;

        app_timer_real(TM_RESET);
        app_timer_user(TM_RESET);
        for (;;) {
                elapsed = app_timer_real(TM_GET);
                if (elapsed > cfg.maxtime)
                        break;
                if (scon == NULL) {
                        if ((scon = SSL_new(tm_ctx)) == NULL)
                                goto end;
                }
                if (!run_test(scon))
                        goto end;
                nConn += 1;
                print_tally_mark(scon);
                if (!reuse_session) {
                        SSL_free(scon);
                        scon = NULL;
                }
        }
        totalTime = app_timer_user(TM_GET);

        printf("\n\n%d connections in %.2fs; %.2f connections/user sec, bytes read %ld\n",
            nConn, totalTime, ((double) nConn / totalTime), bytes_read);
        printf("%d connections in %.0f real seconds, %ld bytes read per connection\n",
            nConn, elapsed, nConn > 0 ? bytes_read / nConn : 0);

        ret = 0;
 end:
        SSL_free(scon);
        return ret;
}