blob: 8b28590b8742232689568b19b7f44151b5975f2e [file] [log] [blame]
Jerry Yu305bfc32021-11-24 16:04:47 +08001#!/usr/bin/env python3
2
3# generate_tls13_compat_tests.py
4#
5# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yu305bfc32021-11-24 16:04:47 +08007
8"""
9Generate TLSv1.3 Compat test cases
10
11"""
12
13import sys
Jerry Yudda036d2021-11-30 11:19:41 +080014import os
Jerry Yu305bfc32021-11-24 16:04:47 +080015import argparse
Jerry Yuc4aa1522021-11-26 11:13:58 +080016import itertools
Jerry Yu882c30d2021-12-01 10:59:59 +080017from collections import namedtuple
Jerry Yu305bfc32021-11-24 16:04:47 +080018
Jerry Yu882c30d2021-12-01 10:59:59 +080019# define certificates configuration entry
20Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile'])
21# define the certificate parameters for signature algorithms
Jerry Yu305bfc32021-11-24 16:04:47 +080022CERTIFICATES = {
Jerry Yu882c30d2021-12-01 10:59:59 +080023 'ecdsa_secp256r1_sha256': Certificate('data_files/test-ca2.crt',
24 'data_files/ecdsa_secp256r1.crt',
25 'data_files/ecdsa_secp256r1.key'),
26 'ecdsa_secp384r1_sha384': Certificate('data_files/test-ca2.crt',
27 'data_files/ecdsa_secp384r1.crt',
28 'data_files/ecdsa_secp384r1.key'),
29 'ecdsa_secp521r1_sha512': Certificate('data_files/test-ca2.crt',
30 'data_files/ecdsa_secp521r1.crt',
31 'data_files/ecdsa_secp521r1.key'),
32 'rsa_pss_rsae_sha256': Certificate('data_files/test-ca_cat12.crt',
33 'data_files/server2-sha256.crt', 'data_files/server2.key'
34 )
Jerry Yu29deed42021-11-25 11:09:54 +080035}
Jerry Yu305bfc32021-11-24 16:04:47 +080036
37CIPHER_SUITE_IANA_VALUE = {
38 "TLS_AES_128_GCM_SHA256": 0x1301,
39 "TLS_AES_256_GCM_SHA384": 0x1302,
40 "TLS_CHACHA20_POLY1305_SHA256": 0x1303,
41 "TLS_AES_128_CCM_SHA256": 0x1304,
42 "TLS_AES_128_CCM_8_SHA256": 0x1305
43}
44
45SIG_ALG_IANA_VALUE = {
46 "ecdsa_secp256r1_sha256": 0x0403,
47 "ecdsa_secp384r1_sha384": 0x0503,
48 "ecdsa_secp521r1_sha512": 0x0603,
Jerry Yu29deed42021-11-25 11:09:54 +080049 'rsa_pss_rsae_sha256': 0x0804,
Jerry Yu305bfc32021-11-24 16:04:47 +080050}
51
52NAMED_GROUP_IANA_VALUE = {
53 'secp256r1': 0x17,
54 'secp384r1': 0x18,
55 'secp521r1': 0x19,
56 'x25519': 0x1d,
57 'x448': 0x1e,
Przemek Stekiel615cbcd2023-07-06 11:08:39 +020058 # Only one finite field group to keep testing time within reasonable bounds.
Przemek Stekielae3209c2023-06-13 15:09:03 +020059 'ffdhe2048': 0x100,
Jerry Yu305bfc32021-11-24 16:04:47 +080060}
61
Jerry Yub7c12a42022-06-12 20:53:02 +080062class TLSProgram:
Jerry Yu305bfc32021-11-24 16:04:47 +080063 """
64 Base class for generate server/client command.
65 """
Jerry Yub7c12a42022-06-12 20:53:02 +080066
Jerry Yu7de79852022-03-23 16:50:47 +080067 # pylint: disable=too-many-arguments
XiaokangQiana1931442022-03-25 11:58:22 +000068 def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None,
69 cert_sig_alg=None, compat_mode=True):
Jerry Yu7918efe2021-12-01 15:29:10 +080070 self._ciphers = []
71 self._sig_algs = []
72 self._named_groups = []
Jerry Yu7de79852022-03-23 16:50:47 +080073 self._cert_sig_algs = []
74 if ciphersuite:
75 self.add_ciphersuites(ciphersuite)
76 if named_group:
77 self.add_named_groups(named_group)
78 if signature_algorithm:
79 self.add_signature_algorithms(signature_algorithm)
80 if cert_sig_alg:
81 self.add_cert_signature_algorithms(cert_sig_alg)
Ronald Cronae937252021-12-10 09:55:15 +010082 self._compat_mode = compat_mode
Jerry Yu305bfc32021-11-24 16:04:47 +080083
Jerry Yu7918efe2021-12-01 15:29:10 +080084 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080085 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +080086 self._ciphers.extend(
87 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +080088
Jerry Yu7918efe2021-12-01 15:29:10 +080089 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080090 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +080091 self._sig_algs.extend(
92 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +080093
Jerry Yu7de79852022-03-23 16:50:47 +080094 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080095 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +080096 self._named_groups.extend(
97 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +080098
Jerry Yu7de79852022-03-23 16:50:47 +080099 # add_cert_signature_algorithms should not override by sub class
100 def add_cert_signature_algorithms(self, *signature_algorithms):
101 self._cert_sig_algs.extend(
102 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
103
Jerry Yub7c12a42022-06-12 20:53:02 +0800104 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800105 def pre_checks(self):
106 return []
107
Jerry Yub7c12a42022-06-12 20:53:02 +0800108 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800109 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800110 if not self._cert_sig_algs:
111 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yub7c12a42022-06-12 20:53:02 +0800112 return self.pre_cmd()
Jerry Yu305bfc32021-11-24 16:04:47 +0800113
Jerry Yub7c12a42022-06-12 20:53:02 +0800114 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800115 def post_checks(self):
116 return []
117
Jerry Yub7c12a42022-06-12 20:53:02 +0800118 # pylint: disable=no-self-use
XiaokangQianb1847a22022-06-08 07:49:31 +0000119 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800120 return ['false']
Jerry Yu305bfc32021-11-24 16:04:47 +0800121
Jerry Yub7c12a42022-06-12 20:53:02 +0800122 # pylint: disable=unused-argument,no-self-use
XiaokangQian9b938b72022-06-10 03:10:59 +0000123 def hrr_post_checks(self, named_group):
124 return []
125
XiaokangQianb1847a22022-06-08 07:49:31 +0000126
127class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800128 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000129 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800130 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800131
132 NAMED_GROUP = {
133 'secp256r1': 'P-256',
134 'secp384r1': 'P-384',
135 'secp521r1': 'P-521',
136 'x25519': 'X25519',
137 'x448': 'X448',
Przemek Stekielae3209c2023-06-13 15:09:03 +0200138 'ffdhe2048': 'ffdhe2048',
Jerry Yu305bfc32021-11-24 16:04:47 +0800139 }
140
Jerry Yu305bfc32021-11-24 16:04:47 +0800141 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800142 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000143
144 if self._ciphers:
145 ciphersuites = ':'.join(self._ciphers)
146 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
147
148 if self._sig_algs:
149 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
150 signature_algorithms = ':'.join(signature_algorithms)
151 ret += ["-sigalgs {signature_algorithms}".format(
152 signature_algorithms=signature_algorithms)]
153
154 if self._named_groups:
155 named_groups = ':'.join(
156 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
157 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
158
159 ret += ['-msg -tls1_3']
160 if not self._compat_mode:
161 ret += ['-no_middlebox']
162
XiaokangQianb1847a22022-06-08 07:49:31 +0000163 return ret
164
165 def pre_checks(self):
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200166 ret = ["requires_openssl_tls1_3"]
167
168 # ffdh groups require at least openssl 3.0
Przemek Stekiel3484db42023-06-28 13:31:38 +0200169 ffdh_groups = ['ffdhe2048']
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200170
171 if any(x in ffdh_groups for x in self._named_groups):
Przemek Stekiel8bfe8972023-06-26 12:59:45 +0200172 ret = ["requires_openssl_tls1_3_with_ffdh"]
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200173
174 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000175
XiaokangQianb1847a22022-06-08 07:49:31 +0000176
177class OpenSSLServ(OpenSSLBase):
178 """
179 Generate test commands for OpenSSL server.
180 """
181
182 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800183 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000184 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800185 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000186
XiaokangQiand5d5b602022-05-23 09:16:20 +0000187 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000188 return ['-c "HTTP/1.0 200 ok"']
189
190 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800191 ret = ['$O_NEXT_SRV_NO_CERT']
192 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
193 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
194 return ret
195
196
197class OpenSSLCli(OpenSSLBase):
198 """
199 Generate test commands for OpenSSL client.
200 """
201
202 def pre_cmd(self):
203 return ['$O_NEXT_CLI_NO_CERT',
204 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000205
206
XiaokangQianb1847a22022-06-08 07:49:31 +0000207class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000208 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000209 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000210 """
211
212 CIPHER_SUITE = {
213 'TLS_AES_256_GCM_SHA384': [
214 'AES-256-GCM',
215 'SHA384',
216 'AEAD'],
217 'TLS_AES_128_GCM_SHA256': [
218 'AES-128-GCM',
219 'SHA256',
220 'AEAD'],
221 'TLS_CHACHA20_POLY1305_SHA256': [
222 'CHACHA20-POLY1305',
223 'SHA256',
224 'AEAD'],
225 'TLS_AES_128_CCM_SHA256': [
226 'AES-128-CCM',
227 'SHA256',
228 'AEAD'],
229 'TLS_AES_128_CCM_8_SHA256': [
230 'AES-128-CCM-8',
231 'SHA256',
232 'AEAD']}
233
234 SIGNATURE_ALGORITHM = {
235 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
236 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
237 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
238 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
239
240 NAMED_GROUP = {
241 'secp256r1': ['GROUP-SECP256R1'],
242 'secp384r1': ['GROUP-SECP384R1'],
243 'secp521r1': ['GROUP-SECP521R1'],
244 'x25519': ['GROUP-X25519'],
245 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200246 'ffdhe2048': ['GROUP-FFDHE2048'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000247 }
248
249 def pre_checks(self):
250 return ["requires_gnutls_tls1_3",
251 "requires_gnutls_next_no_ticket",
252 "requires_gnutls_next_disable_tls13_compat", ]
253
XiaokangQiand5d5b602022-05-23 09:16:20 +0000254 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800255 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000256
257 priority_string_list = []
258
259 def update_priority_string_list(items, map_table):
260 for item in items:
261 for i in map_table[item]:
262 if i not in priority_string_list:
263 yield i
264
265 if self._ciphers:
266 priority_string_list.extend(update_priority_string_list(
267 self._ciphers, self.CIPHER_SUITE))
268 else:
269 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
270
271 if self._sig_algs:
272 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
273 priority_string_list.extend(update_priority_string_list(
274 signature_algorithms, self.SIGNATURE_ALGORITHM))
275 else:
276 priority_string_list.append('SIGN-ALL')
277
278
279 if self._named_groups:
280 priority_string_list.extend(update_priority_string_list(
281 self._named_groups, self.NAMED_GROUP))
282 else:
283 priority_string_list.append('GROUP-ALL')
284
285 priority_string_list = ['NONE'] + \
286 priority_string_list + ['VERS-TLS1.3']
287
288 priority_string = ':+'.join(priority_string_list)
289 priority_string += ':%NO_TICKETS'
290
291 if not self._compat_mode:
292 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
293
294 ret += ['--priority={priority_string}'.format(
295 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000296 return ret
297
298class GnuTLSServ(GnuTLSBase):
299 """
300 Generate test commands for GnuTLS server.
301 """
302
Jerry Yub7c12a42022-06-12 20:53:02 +0800303 def pre_cmd(self):
304 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000305
Jerry Yub7c12a42022-06-12 20:53:02 +0800306 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
307 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
308 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000309 return ret
310
Jerry Yub7c12a42022-06-12 20:53:02 +0800311 def post_checks(self):
312 return ['-c "HTTP/1.0 200 OK"']
313
314
315class GnuTLSCli(GnuTLSBase):
316 """
317 Generate test commands for GnuTLS client.
318 """
319
XiaokangQianb1847a22022-06-08 07:49:31 +0000320 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800321 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
322 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000323
XiaokangQianb1847a22022-06-08 07:49:31 +0000324
325class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800326 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000327 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800328 """
Jerry Yu29deed42021-11-25 11:09:54 +0800329
Jerry Yu305bfc32021-11-24 16:04:47 +0800330 CIPHER_SUITE = {
331 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
332 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
333 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
334 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
335 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
336
Jerry Yu7918efe2021-12-01 15:29:10 +0800337 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800338 ret = super().cmd()
339 ret += ['debug_level=4']
340
Jerry Yu305bfc32021-11-24 16:04:47 +0800341
XiaokangQiana1931442022-03-25 11:58:22 +0000342 if self._ciphers:
343 ciphers = ','.join(
344 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
345 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800346
XiaokangQiana1931442022-03-25 11:58:22 +0000347 if self._sig_algs + self._cert_sig_algs:
348 ret += ['sig_algs={sig_algs}'.format(
349 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800350
Jerry Yu7918efe2021-12-01 15:29:10 +0800351 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000352 named_groups = ','.join(self._named_groups)
Przemek Stekiel45255e42023-06-29 13:56:36 +0200353 ret += ["groups={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000354 return ret
355
Valerio Setti18371ee2024-01-18 09:49:39 +0100356 #pylint: disable=missing-function-docstring
357 def add_ffdh_group_requirements(self, requirement_list):
358 if 'ffdhe2048' in self._named_groups:
359 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
360 if 'ffdhe3072' in self._named_groups:
361 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
362 if 'ffdhe4096' in self._named_groups:
363 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
364 if 'ffdhe6144' in self._named_groups:
365 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
366 if 'ffdhe8192' in self._named_groups:
367 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
368
XiaokangQianb1847a22022-06-08 07:49:31 +0000369 def pre_checks(self):
370 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200371 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000372
373 if self._compat_mode:
374 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
375
376 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
377 ret.append(
378 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200379
380 ec_groups = ['secp256r1', 'secp384r1', 'secp521r1', 'x25519', 'x448']
Valerio Setti18371ee2024-01-18 09:49:39 +0100381 ffdh_groups = ['ffdhe2048', 'ffdhe3072', 'ffdhe4096', 'ffdhe6144', 'ffdhe8192']
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200382
383 if any(x in ec_groups for x in self._named_groups):
Przemek Stekielc31a7982023-06-27 10:53:33 +0200384 ret.append('requires_config_enabled PSA_WANT_ALG_ECDH')
385
386 if any(x in ffdh_groups for x in self._named_groups):
387 ret.append('requires_config_enabled PSA_WANT_ALG_FFDH')
Valerio Setti18371ee2024-01-18 09:49:39 +0100388 self.add_ffdh_group_requirements(ret)
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200389
XiaokangQianb1847a22022-06-08 07:49:31 +0000390 return ret
391
XiaokangQianb1847a22022-06-08 07:49:31 +0000392
393class MbedTLSServ(MbedTLSBase):
394 """
395 Generate test commands for mbedTLS server.
396 """
397
398 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800399 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000400 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800401 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800402
403 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000404 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800405
406 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100407 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800408 if self._ciphers:
409 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000410 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
411 self.CIPHER_SUITE[self._ciphers[0]],
412 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
413 if self._sig_algs:
414 check_strings.append(
415 "received signature algorithm: 0x{:x}".format(
416 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
417
418 for named_group in self._named_groups:
419 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
420 named_group=named_group,
421 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
422
Ronald Croneac00ad2022-09-13 10:16:31 +0200423 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000424 return ['-s "{}"'.format(i) for i in check_strings]
425
426 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800427 ret = ['$P_SRV']
428 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
429 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
430 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000431
XiaokangQian9b938b72022-06-10 03:10:59 +0000432 def hrr_post_checks(self, named_group):
433 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
434
XiaokangQianb1847a22022-06-08 07:49:31 +0000435
XiaokangQianb1847a22022-06-08 07:49:31 +0000436class MbedTLSCli(MbedTLSBase):
437 """
438 Generate test commands for mbedTLS client.
439 """
440
XiaokangQianb1847a22022-06-08 07:49:31 +0000441 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800442 return ['$P_CLI',
443 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000444
445 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000446 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000447
XiaokangQian9b938b72022-06-10 03:10:59 +0000448 def hrr_post_checks(self, named_group):
449 ret = ['-c "received HelloRetryRequest message"']
450 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000451 return ret
452
453 def post_checks(self):
454 check_strings = ["Protocol is TLSv1.3"]
455 if self._ciphers:
456 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800457 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
458 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
459 self.CIPHER_SUITE[self._ciphers[0]]))
460 if self._sig_algs:
461 check_strings.append(
462 "Certificate Verify: Signature algorithm ( {:04x} )".format(
463 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
464
465 for named_group in self._named_groups:
466 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
467 named_group=named_group,
468 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
469
470 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800471 return ['-c "{}"'.format(i) for i in check_strings]
472
Jerry Yu305bfc32021-11-24 16:04:47 +0800473
XiaokangQianb1847a22022-06-08 07:49:31 +0000474SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
475CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800476
477
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200478def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800479 """
480 Generate test case with `ssl-opt.sh` format.
481 """
Jerry Yudda036d2021-11-30 11:19:41 +0800482 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200483 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800484
485 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
486 named_group=named_group,
487 signature_algorithm=sig_alg,
488 cert_sig_alg=sig_alg)
489 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
490 named_group=named_group,
491 signature_algorithm=sig_alg,
492 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800493
Jerry Yub7c12a42022-06-12 20:53:02 +0800494 cmd = ['run_test "{}"'.format(name),
495 '"{}"'.format(' '.join(server_object.cmd())),
496 '"{}"'.format(' '.join(client_object.cmd())),
497 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000498 cmd += server_object.post_checks()
499 cmd += client_object.post_checks()
500 cmd += ['-C "received HelloRetryRequest message"']
501 prefix = ' \\\n' + (' '*9)
502 cmd = prefix.join(cmd)
503 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
504
505
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200506def generate_hrr_compat_test(client=None, server=None,
507 client_named_group=None, server_named_group=None,
508 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000509 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000510 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000511 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000512 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000513 client=client, server=server, c_named_group=client_named_group,
514 s_named_group=server_named_group)
515 server_object = SERVER_CLASSES[server](named_group=server_named_group,
516 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000517
XiaokangQian2e17fb82022-03-28 03:30:05 +0000518 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
519 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000520 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000521
Jerry Yub7c12a42022-06-12 20:53:02 +0800522 cmd = ['run_test "{}"'.format(name),
523 '"{}"'.format(' '.join(server_object.cmd())),
524 '"{}"'.format(' '.join(client_object.cmd())),
525 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000526 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000527 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000528 cmd += server_object.hrr_post_checks(server_named_group)
529 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000530 prefix = ' \\\n' + (' '*9)
531 cmd = prefix.join(cmd)
532 return '\n'.join(server_object.pre_checks() +
533 client_object.pre_checks() +
534 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800535
536SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800537
538# {filename}
539#
540# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +0000541# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yucdcb6832021-11-29 16:50:13 +0800542#
543# Purpose
544#
545# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000546# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800547#
548# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
549# AND REGENERATE THIS FILE.
550#
551'''
Jerry Yu29deed42021-11-25 11:09:54 +0800552
Jerry Yu305bfc32021-11-24 16:04:47 +0800553def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800554 """
555 Main function of this program
556 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800557 parser = argparse.ArgumentParser()
558
Jerry Yucdcb6832021-11-29 16:50:13 +0800559 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800560 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800561
Jerry Yuc4aa1522021-11-26 11:13:58 +0800562 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
563 default=False, help='Generate all available tls13 compat tests')
564
Jerry Yu305bfc32021-11-24 16:04:47 +0800565 parser.add_argument('--list-ciphers', action='store_true',
566 default=False, help='List supported ciphersuites')
567
568 parser.add_argument('--list-sig-algs', action='store_true',
569 default=False, help='List supported signature algorithms')
570
571 parser.add_argument('--list-named-groups', action='store_true',
572 default=False, help='List supported named groups')
573
574 parser.add_argument('--list-servers', action='store_true',
575 default=False, help='List supported TLS servers')
576
577 parser.add_argument('--list-clients', action='store_true',
578 default=False, help='List supported TLS Clients')
579
Jerry Yub4ac8f32021-12-01 10:41:37 +0800580 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
581 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800582 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800583 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
584 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800585 help='Choose TLS client program for test')
586 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
587 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
588 help='Choose cipher suite for test')
589 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
590 default=list(SIG_ALG_IANA_VALUE.keys())[0],
591 help='Choose cipher suite for test')
592 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
593 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
594 help='Choose cipher suite for test')
595
596 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800597
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800598 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800599 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200600 for client, server, cipher, named_group, sig_alg in \
601 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800602 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200603 CIPHER_SUITE_IANA_VALUE.keys(),
604 NAMED_GROUP_IANA_VALUE.keys(),
605 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000606 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000607 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000608 cipher=cipher, named_group=named_group,
609 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000610
XiaokangQiand5d5b602022-05-23 09:16:20 +0000611
XiaokangQiana1931442022-03-25 11:58:22 +0000612 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000613 for client, server, client_named_group, server_named_group in \
614 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000615 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000616 NAMED_GROUP_IANA_VALUE.keys(),
617 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800618
XiaokangQian9b938b72022-06-10 03:10:59 +0000619 if (client == 'mbedTLS' or server == 'mbedTLS') and \
620 client_named_group != server_named_group:
621 yield generate_hrr_compat_test(client=client, server=server,
622 client_named_group=client_named_group,
623 server_named_group=server_named_group,
624 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000625
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800626 if args.generate_all_tls13_compat_tests:
627 if args.output:
628 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800629 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000630 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800631 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800632 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800633 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800634 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800635 return 0
636
Jerry Yu305bfc32021-11-24 16:04:47 +0800637 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800638 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800639 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800640 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800641 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800642 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800643 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800644 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800645 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800646 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800647 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800648 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800649 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800650
XiaokangQiana1931442022-03-25 11:58:22 +0000651 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
652 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800653 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800654
Jerry Yu29deed42021-11-25 11:09:54 +0800655
Jerry Yu305bfc32021-11-24 16:04:47 +0800656if __name__ == "__main__":
657 sys.exit(main())