test/ssl_test_ctx.h

   1 /*
   2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 #ifndef HEADER_SSL_TEST_CTX_H
  11 #define HEADER_SSL_TEST_CTX_H
  12
  13 #include <openssl/conf.h>
  14 #include <openssl/ssl.h>
  15
  16 typedef enum {
  17     SSL_TEST_SUCCESS = 0,  /* Default */
  18     SSL_TEST_SERVER_FAIL,
  19     SSL_TEST_CLIENT_FAIL,
  20     SSL_TEST_INTERNAL_ERROR,
  21     /* Couldn't test resumption/renegotiation: original handshake failed. */
  22     SSL_TEST_FIRST_HANDSHAKE_FAILED
  23 } ssl_test_result_t;
  24
  25 typedef enum {
  26     SSL_TEST_VERIFY_NONE = 0, /* Default */
  27     SSL_TEST_VERIFY_ACCEPT_ALL,
  28     SSL_TEST_VERIFY_REJECT_ALL
  29 } ssl_verify_callback_t;
  30
  31 typedef enum {
  32     SSL_TEST_SERVERNAME_NONE = 0, /* Default */
  33     SSL_TEST_SERVERNAME_SERVER1,
  34     SSL_TEST_SERVERNAME_SERVER2,
  35     SSL_TEST_SERVERNAME_INVALID
  36 } ssl_servername_t;
  37
  38 typedef enum {
  39     SSL_TEST_SERVERNAME_CB_NONE = 0,  /* Default */
  40     SSL_TEST_SERVERNAME_IGNORE_MISMATCH,
  41     SSL_TEST_SERVERNAME_REJECT_MISMATCH,
  42     SSL_TEST_SERVERNAME_EARLY_IGNORE_MISMATCH,
  43     SSL_TEST_SERVERNAME_EARLY_REJECT_MISMATCH,
  44     SSL_TEST_SERVERNAME_EARLY_NO_V12
  45 } ssl_servername_callback_t;
  46
  47 typedef enum {
  48     SSL_TEST_SESSION_TICKET_IGNORE = 0, /* Default */
  49     SSL_TEST_SESSION_TICKET_YES,
  50     SSL_TEST_SESSION_TICKET_NO,
  51     SSL_TEST_SESSION_TICKET_BROKEN /* Special test */
  52 } ssl_session_ticket_t;
  53
  54 typedef enum {
  55     SSL_TEST_COMPRESSION_NO = 0, /* Default */
  56     SSL_TEST_COMPRESSION_YES
  57 } ssl_compression_t;
  58
  59 typedef enum {
  60     SSL_TEST_METHOD_TLS = 0, /* Default */
  61     SSL_TEST_METHOD_DTLS
  62 } ssl_test_method_t;
  63
  64 typedef enum {
  65     SSL_TEST_HANDSHAKE_SIMPLE = 0, /* Default */
  66     SSL_TEST_HANDSHAKE_RESUME,
  67     SSL_TEST_HANDSHAKE_RENEG_SERVER,
  68     SSL_TEST_HANDSHAKE_RENEG_CLIENT,
  69     SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER,
  70     SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
  71 } ssl_handshake_mode_t;
  72
  73 typedef enum {
  74     SSL_TEST_CT_VALIDATION_NONE = 0, /* Default */
  75     SSL_TEST_CT_VALIDATION_PERMISSIVE,
  76     SSL_TEST_CT_VALIDATION_STRICT
  77 } ssl_ct_validation_t;
  78
  79 typedef enum {
  80     SSL_TEST_CERT_STATUS_NONE = 0, /* Default */
  81     SSL_TEST_CERT_STATUS_GOOD_RESPONSE,
  82     SSL_TEST_CERT_STATUS_BAD_RESPONSE
  83 } ssl_cert_status_t;
  84 /*
  85  * Server/client settings that aren't supported by the SSL CONF library,
  86  * such as callbacks.
  87  */
  88 typedef struct {
  89     /* One of a number of predefined custom callbacks. */
  90     ssl_verify_callback_t verify_callback;
  91     /* One of a number of predefined server names use by the client */
  92     ssl_servername_t servername;
  93     /* Supported NPN and ALPN protocols. A comma-separated list. */
  94     char *npn_protocols;
  95     char *alpn_protocols;
  96     ssl_ct_validation_t ct_validation;
  97     /* Ciphersuites to set on a renegotiation */
  98     char *reneg_ciphers;
  99 } SSL_TEST_CLIENT_CONF;
 100
 101 typedef struct {
 102     /* SNI callback (server-side). */
 103     ssl_servername_callback_t servername_callback;
 104     /* Supported NPN and ALPN protocols. A comma-separated list. */
 105     char *npn_protocols;
 106     char *alpn_protocols;
 107     /* Whether to set a broken session ticket callback. */
 108     int broken_session_ticket;
 109     /* Should we send a CertStatus message? */
 110     ssl_cert_status_t cert_status;
 111 } SSL_TEST_SERVER_CONF;
 112
 113 typedef struct {
 114     SSL_TEST_CLIENT_CONF client;
 115     SSL_TEST_SERVER_CONF server;
 116     SSL_TEST_SERVER_CONF server2;
 117 } SSL_TEST_EXTRA_CONF;
 118
 119 typedef struct {
 120     /*
 121      * Global test configuration. Does not change between handshakes.
 122      */
 123     /* Whether the server/client CTX should use DTLS or TLS. */
 124     ssl_test_method_t method;
 125     /* Whether to test a resumed/renegotiated handshake. */
 126     ssl_handshake_mode_t handshake_mode;
 127     /*
 128      * How much application data to exchange (default is 256 bytes).
 129      * Both peers will send |app_data_size| bytes interleaved.
 130      */
 131     int app_data_size;
 132     /* Maximum send fragment size. */
 133     int max_fragment_size;
 134     /* KeyUpdate type */
 135     int key_update_type;
 136
 137     /*
 138      * Extra server/client configurations. Per-handshake.
 139      */
 140     /* First handshake. */
 141     SSL_TEST_EXTRA_CONF extra;
 142     /* Resumed handshake. */
 143     SSL_TEST_EXTRA_CONF resume_extra;
 144
 145     /*
 146      * Test expectations. These apply to the LAST handshake.
 147      */
 148     /* Defaults to SUCCESS. */
 149     ssl_test_result_t expected_result;
 150     /* Alerts. 0 if no expectation. */
 151     /* See ssl.h for alert codes. */
 152     /* Alert sent by the client / received by the server. */
 153     int expected_client_alert;
 154     /* Alert sent by the server / received by the client. */
 155     int expected_server_alert;
 156     /* Negotiated protocol version. 0 if no expectation. */
 157     /* See ssl.h for protocol versions. */
 158     int expected_protocol;
 159     /*
 160      * The expected SNI context to use.
 161      * We test server-side that the server switched to the expected context.
 162      * Set by the callback upon success, so if the callback wasn't called or
 163      * terminated with an alert, the servername will match with
 164      * SSL_TEST_SERVERNAME_NONE.
 165      * Note: in the event that the servername was accepted, the client should
 166      * also receive an empty SNI extension back but we have no way of probing
 167      * client-side via the API that this was the case.
 168      */
 169     ssl_servername_t expected_servername;
 170     ssl_session_ticket_t session_ticket_expected;
 171     int compression_expected;
 172     /* The expected NPN/ALPN protocol to negotiate. */
 173     char *expected_npn_protocol;
 174     char *expected_alpn_protocol;
 175     /* Whether the second handshake is resumed or a full handshake (boolean). */
 176     int resumption_expected;
 177     /* Expected temporary key type */
 178     int expected_tmp_key_type;
 179     /* Expected server certificate key type */
 180     int expected_server_cert_type;
 181     /* Expected server signing hash */
 182     int expected_server_sign_hash;
 183     /* Expected server signature type */
 184     int expected_server_sign_type;
 185     /* Expected client certificate key type */
 186     int expected_client_cert_type;
 187     /* Expected client signing hash */
 188     int expected_client_sign_hash;
 189     /* Expected client signature type */
 190     int expected_client_sign_type;
 191 } SSL_TEST_CTX;
 192
 193 const char *ssl_test_result_name(ssl_test_result_t result);
 194 const char *ssl_alert_name(int alert);
 195 const char *ssl_protocol_name(int protocol);
 196 const char *ssl_verify_callback_name(ssl_verify_callback_t verify_callback);
 197 const char *ssl_servername_name(ssl_servername_t server);
 198 const char *ssl_servername_callback_name(ssl_servername_callback_t
 199                                          servername_callback);
 200 const char *ssl_session_ticket_name(ssl_session_ticket_t server);
 201 const char *ssl_test_method_name(ssl_test_method_t method);
 202 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode);
 203 const char *ssl_ct_validation_name(ssl_ct_validation_t mode);
 204 const char *ssl_certstatus_name(ssl_cert_status_t cert_status);
 205
 206 /*
 207  * Load the test case context from |conf|.
 208  * See test/README.ssltest.md for details on the conf file format.
 209  */
 210 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section);
 211
 212 SSL_TEST_CTX *SSL_TEST_CTX_new(void);
 213
 214 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx);
 215
 216 #endif  /* HEADER_SSL_TEST_CTX_H */