• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* Copyright (c) 2014, Google Inc.
2  *
3  * Permission to use, copy, modify, and/or distribute this software for any
4  * purpose with or without fee is hereby granted, provided that the above
5  * copyright notice and this permission notice appear in all copies.
6  *
7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14 
15 #ifndef HEADER_TEST_CONFIG
16 #define HEADER_TEST_CONFIG
17 
18 #include <string>
19 #include <utility>
20 #include <vector>
21 
22 #include <openssl/base.h>
23 #include <openssl/x509.h>
24 
25 #include "test_state.h"
26 
27 struct TestConfig {
28   int port = 0;
29   bool ipv6 = false;
30   uint64_t shim_id = 0;
31   bool is_server = false;
32   bool is_dtls = false;
33   bool is_quic = false;
34   int resume_count = 0;
35   std::string write_settings;
36   bool fallback_scsv = false;
37   std::vector<uint16_t> signing_prefs;
38   std::vector<uint16_t> verify_prefs;
39   std::vector<uint16_t> expect_peer_verify_prefs;
40   std::vector<uint16_t> curves;
41   std::string key_file;
42   std::string cert_file;
43   std::string expect_server_name;
44   bool enable_ech_grease = false;
45   std::vector<std::string> ech_server_configs;
46   std::vector<std::string> ech_server_keys;
47   std::vector<int> ech_is_retry_config;
48   bool expect_ech_accept = false;
49   std::string expect_ech_name_override;
50   bool expect_no_ech_name_override = false;
51   std::string expect_ech_retry_configs;
52   bool expect_no_ech_retry_configs = false;
53   std::string ech_config_list;
54   std::string expect_certificate_types;
55   bool require_any_client_certificate = false;
56   std::string advertise_npn;
57   std::string expect_next_proto;
58   bool false_start = false;
59   std::string select_next_proto;
60   bool async = false;
61   bool write_different_record_sizes = false;
62   bool cbc_record_splitting = false;
63   bool partial_write = false;
64   bool no_tls13 = false;
65   bool no_tls12 = false;
66   bool no_tls11 = false;
67   bool no_tls1 = false;
68   bool no_ticket = false;
69   std::string expect_channel_id;
70   bool enable_channel_id = false;
71   std::string send_channel_id;
72   bool shim_writes_first = false;
73   std::string host_name;
74   std::string advertise_alpn;
75   std::string expect_alpn;
76   std::string expect_late_alpn;
77   std::string expect_advertised_alpn;
78   std::string select_alpn;
79   bool decline_alpn = false;
80   bool reject_alpn = false;
81   bool select_empty_alpn = false;
82   bool defer_alps = false;
83   std::vector<std::pair<std::string, std::string>> application_settings;
84   std::unique_ptr<std::string> expect_peer_application_settings;
85   bool alps_use_new_codepoint = false;
86   std::string quic_transport_params;
87   std::string expect_quic_transport_params;
88   // Set quic_use_legacy_codepoint to 0 or 1 to configure, -1 uses default.
89   int quic_use_legacy_codepoint = -1;
90   bool expect_session_miss = false;
91   bool expect_extended_master_secret = false;
92   std::string psk;
93   std::string psk_identity;
94   std::string srtp_profiles;
95   bool enable_ocsp_stapling = false;
96   std::string expect_ocsp_response;
97   bool enable_signed_cert_timestamps = false;
98   std::string expect_signed_cert_timestamps;
99   uint16_t min_version = 0;
100   uint16_t max_version = 0;
101   uint16_t expect_version = 0;
102   int mtu = 0;
103   bool implicit_handshake = false;
104   bool use_early_callback = false;
105   bool fail_early_callback = false;
106   bool install_ddos_callback = false;
107   bool fail_ddos_callback = false;
108   bool fail_cert_callback = false;
109   std::string cipher;
110   bool handshake_never_done = false;
111   int export_keying_material = 0;
112   std::string export_label;
113   std::string export_context;
114   bool use_export_context = false;
115   bool tls_unique = false;
116   bool expect_ticket_renewal = false;
117   bool expect_no_session = false;
118   bool expect_ticket_supports_early_data = false;
119   bool expect_accept_early_data = false;
120   bool expect_reject_early_data = false;
121   bool expect_no_offer_early_data = false;
122   bool use_ticket_callback = false;
123   bool renew_ticket = false;
124   bool enable_early_data = false;
125   std::string ocsp_response;
126   bool check_close_notify = false;
127   bool shim_shuts_down = false;
128   bool verify_fail = false;
129   bool verify_peer = false;
130   bool verify_peer_if_no_obc = false;
131   bool expect_verify_result = false;
132   std::string signed_cert_timestamps;
133   int expect_total_renegotiations = 0;
134   bool renegotiate_once = false;
135   bool renegotiate_freely = false;
136   bool renegotiate_ignore = false;
137   bool renegotiate_explicit = false;
138   bool forbid_renegotiation_after_handshake = false;
139   uint16_t expect_peer_signature_algorithm = 0;
140   uint16_t expect_curve_id = 0;
141   bool use_old_client_cert_callback = false;
142   int initial_timeout_duration_ms = 0;
143   std::string use_client_ca_list;
144   std::string expect_client_ca_list;
145   bool send_alert = false;
146   bool peek_then_read = false;
147   bool enable_grease = false;
148   bool permute_extensions = false;
149   int max_cert_list = 0;
150   std::string ticket_key;
151   bool use_exporter_between_reads = false;
152   uint16_t expect_cipher_aes = 0;
153   uint16_t expect_cipher_no_aes = 0;
154   uint16_t expect_cipher = 0;
155   std::string expect_peer_cert_file;
156   int resumption_delay = 0;
157   bool retain_only_sha256_client_cert = false;
158   bool expect_sha256_client_cert = false;
159   bool read_with_unfinished_write = false;
160   bool expect_secure_renegotiation = false;
161   bool expect_no_secure_renegotiation = false;
162   int max_send_fragment = 0;
163   int read_size = 0;
164   bool expect_session_id = false;
165   bool expect_no_session_id = false;
166   int expect_ticket_age_skew = 0;
167   bool no_op_extra_handshake = false;
168   bool handshake_twice = false;
169   bool allow_unknown_alpn_protos = false;
170   bool use_custom_verify_callback = false;
171   std::string expect_msg_callback;
172   bool allow_false_start_without_alpn = false;
173   bool handoff = false;
174   bool handshake_hints = false;
175   bool allow_hint_mismatch = false;
176   bool use_ocsp_callback = false;
177   bool set_ocsp_in_callback = false;
178   bool decline_ocsp_callback = false;
179   bool fail_ocsp_callback = false;
180   bool install_cert_compression_algs = false;
181   int install_one_cert_compression_alg = 0;
182   bool reverify_on_resume = false;
183   bool ignore_rsa_key_usage = false;
184   bool expect_key_usage_invalid = false;
185   bool is_handshaker_supported = false;
186   bool handshaker_resume = false;
187   std::string handshaker_path;
188   bool jdk11_workaround = false;
189   bool server_preference = false;
190   bool export_traffic_secrets = false;
191   bool key_update = false;
192   bool expect_delegated_credential_used = false;
193   std::string delegated_credential;
194   std::string expect_early_data_reason;
195   bool expect_hrr = false;
196   bool expect_no_hrr = false;
197   bool wait_for_debugger = false;
198   std::string quic_early_data_context;
199   int early_write_after_message = 0;
200   bool fips_202205 = false;
201   bool wpa_202304 = false;
202 
203   std::vector<const char*> handshaker_args;
204 
205   bssl::UniquePtr<SSL_CTX> SetupCtx(SSL_CTX *old_ctx) const;
206 
207   bssl::UniquePtr<SSL> NewSSL(SSL_CTX *ssl_ctx, SSL_SESSION *session,
208                               std::unique_ptr<TestState> test_state) const;
209 };
210 
211 bool ParseConfig(int argc, char **argv, bool is_shim, TestConfig *out_initial,
212                  TestConfig *out_resume, TestConfig *out_retry);
213 
214 bool SetTestConfig(SSL *ssl, const TestConfig *config);
215 
216 const TestConfig *GetTestConfig(const SSL *ssl);
217 
218 bool LoadCertificate(bssl::UniquePtr<X509> *out_x509,
219                      bssl::UniquePtr<STACK_OF(X509)> *out_chain,
220                      const std::string &file);
221 
222 bssl::UniquePtr<EVP_PKEY> LoadPrivateKey(const std::string &file);
223 
224 #endif  // HEADER_TEST_CONFIG
225