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_servername_callback_t;
  43
  44 typedef enum {
  45     SSL_TEST_SESSION_TICKET_IGNORE = 0, /* Default */
  46     SSL_TEST_SESSION_TICKET_YES,
  47     SSL_TEST_SESSION_TICKET_NO,
  48     SSL_TEST_SESSION_TICKET_BROKEN /* Special test */
  49 } ssl_session_ticket_t;
  50
  51 typedef enum {
  52     SSL_TEST_METHOD_TLS = 0, /* Default */
  53     SSL_TEST_METHOD_DTLS
  54 } ssl_test_method_t;
  55
  56 typedef enum {
  57     SSL_TEST_HANDSHAKE_SIMPLE = 0, /* Default */
  58     SSL_TEST_HANDSHAKE_RESUME,
  59     /* Not yet implemented */
  60     SSL_TEST_HANDSHAKE_RENEGOTIATE
  61 } ssl_handshake_mode_t;
  62
  63 typedef enum {
  64     SSL_TEST_CT_VALIDATION_NONE = 0, /* Default */
  65     SSL_TEST_CT_VALIDATION_PERMISSIVE,
  66     SSL_TEST_CT_VALIDATION_STRICT
  67 } ssl_ct_validation_t;
  68 /*
  69  * Server/client settings that aren't supported by the SSL CONF library,
  70  * such as callbacks.
  71  */
  72 typedef struct {
  73     /* One of a number of predefined custom callbacks. */
  74     ssl_verify_callback_t verify_callback;
  75     /* One of a number of predefined server names use by the client */
  76     ssl_servername_t servername;
  77     /* Supported NPN and ALPN protocols. A comma-separated list. */
  78     char *npn_protocols;
  79     char *alpn_protocols;
  80     ssl_ct_validation_t ct_validation;
  81 } SSL_TEST_CLIENT_CONF;
  82
  83 typedef struct {
  84     /* SNI callback (server-side). */
  85     ssl_servername_callback_t servername_callback;
  86     /* Supported NPN and ALPN protocols. A comma-separated list. */
  87     char *npn_protocols;
  88     char *alpn_protocols;
  89     /* Whether to set a broken session ticket callback. */
  90     int broken_session_ticket;
  91 } SSL_TEST_SERVER_CONF;
  92
  93 typedef struct {
  94     SSL_TEST_CLIENT_CONF client;
  95     SSL_TEST_SERVER_CONF server;
  96     SSL_TEST_SERVER_CONF server2;
  97 } SSL_TEST_EXTRA_CONF;
  98
  99 typedef struct {
 100     /*
 101      * Global test configuration. Does not change between handshakes.
 102      */
 103     /* Whether the server/client CTX should use DTLS or TLS. */
 104     ssl_test_method_t method;
 105     /* Whether to test a resumed/renegotiated handshake. */
 106     ssl_handshake_mode_t handshake_mode;
 107
 108     /*
 109      * Extra server/client configurations. Per-handshake.
 110      */
 111     /* First handshake. */
 112     SSL_TEST_EXTRA_CONF extra;
 113     /* Resumed handshake. */
 114     SSL_TEST_EXTRA_CONF resume_extra;
 115
 116     /*
 117      * Test expectations. These apply to the LAST handshake.
 118      */
 119     /* Defaults to SUCCESS. */
 120     ssl_test_result_t expected_result;
 121     /* Alerts. 0 if no expectation. */
 122     /* See ssl.h for alert codes. */
 123     /* Alert sent by the client / received by the server. */
 124     int expected_client_alert;
 125     /* Alert sent by the server / received by the client. */
 126     int expected_server_alert;
 127     /* Negotiated protocol version. 0 if no expectation. */
 128     /* See ssl.h for protocol versions. */
 129     int expected_protocol;
 130     /*
 131      * The expected SNI context to use.
 132      * We test server-side that the server switched to the expected context.
 133      * Set by the callback upon success, so if the callback wasn't called or
 134      * terminated with an alert, the servername will match with
 135      * SSL_TEST_SERVERNAME_NONE.
 136      * Note: in the event that the servername was accepted, the client should
 137      * also receive an empty SNI extension back but we have no way of probing
 138      * client-side via the API that this was the case.
 139      */
 140     ssl_servername_t expected_servername;
 141     ssl_session_ticket_t session_ticket_expected;
 142     /* The expected NPN/ALPN protocol to negotiate. */
 143     char *expected_npn_protocol;
 144     char *expected_alpn_protocol;
 145     /* Whether the second handshake is resumed or a full handshake (boolean). */
 146     int resumption_expected;
 147 } SSL_TEST_CTX;
 148
 149 const char *ssl_test_result_name(ssl_test_result_t result);
 150 const char *ssl_alert_name(int alert);
 151 const char *ssl_protocol_name(int protocol);
 152 const char *ssl_verify_callback_name(ssl_verify_callback_t verify_callback);
 153 const char *ssl_servername_name(ssl_servername_t server);
 154 const char *ssl_servername_callback_name(ssl_servername_callback_t
 155                                          servername_callback);
 156 const char *ssl_session_ticket_name(ssl_session_ticket_t server);
 157 const char *ssl_test_method_name(ssl_test_method_t method);
 158 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode);
 159 const char *ssl_ct_validation_name(ssl_ct_validation_t mode);
 160
 161 /*
 162  * Load the test case context from |conf|.
 163  * See test/README.ssltest.md for details on the conf file format.
 164  */
 165 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section);
 166
 167 SSL_TEST_CTX *SSL_TEST_CTX_new(void);
 168
 169 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx);
 170
 171 #endif  /* HEADER_SSL_TEST_CTX_H */