blob: daa1d7daf7e093f442619dfd2e9c90b0e4961115 [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
David Horstmann661c0882024-07-01 17:04:17 +010019DATA_FILES_PATH = '../framework/data_files'
Jerry Yu882c30d2021-12-01 10:59:59 +080020# define certificates configuration entry
21Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile'])
22# define the certificate parameters for signature algorithms
Jerry Yu305bfc32021-11-24 16:04:47 +080023CERTIFICATES = {
David Horstmann661c0882024-07-01 17:04:17 +010024 'ecdsa_secp256r1_sha256': Certificate(DATA_FILES_PATH + '/test-ca2.crt',
25 DATA_FILES_PATH + '/ecdsa_secp256r1.crt',
26 DATA_FILES_PATH + '/ecdsa_secp256r1.key'),
27 'ecdsa_secp384r1_sha384': Certificate(DATA_FILES_PATH + '/test-ca2.crt',
28 DATA_FILES_PATH + '/ecdsa_secp384r1.crt',
29 DATA_FILES_PATH + '/ecdsa_secp384r1.key'),
30 'ecdsa_secp521r1_sha512': Certificate(DATA_FILES_PATH + '/test-ca2.crt',
31 DATA_FILES_PATH + '/ecdsa_secp521r1.crt',
32 DATA_FILES_PATH + '/ecdsa_secp521r1.key'),
33 'rsa_pss_rsae_sha256': Certificate(DATA_FILES_PATH + '/test-ca_cat12.crt',
34 DATA_FILES_PATH + '/server2-sha256.crt',
35 DATA_FILES_PATH + '/server2.key')
Jerry Yu29deed42021-11-25 11:09:54 +080036}
Jerry Yu305bfc32021-11-24 16:04:47 +080037
38CIPHER_SUITE_IANA_VALUE = {
39 "TLS_AES_128_GCM_SHA256": 0x1301,
40 "TLS_AES_256_GCM_SHA384": 0x1302,
41 "TLS_CHACHA20_POLY1305_SHA256": 0x1303,
42 "TLS_AES_128_CCM_SHA256": 0x1304,
43 "TLS_AES_128_CCM_8_SHA256": 0x1305
44}
45
46SIG_ALG_IANA_VALUE = {
47 "ecdsa_secp256r1_sha256": 0x0403,
48 "ecdsa_secp384r1_sha384": 0x0503,
49 "ecdsa_secp521r1_sha512": 0x0603,
Jerry Yu29deed42021-11-25 11:09:54 +080050 'rsa_pss_rsae_sha256': 0x0804,
Jerry Yu305bfc32021-11-24 16:04:47 +080051}
52
53NAMED_GROUP_IANA_VALUE = {
54 'secp256r1': 0x17,
55 'secp384r1': 0x18,
56 'secp521r1': 0x19,
57 'x25519': 0x1d,
58 'x448': 0x1e,
Przemek Stekiel615cbcd2023-07-06 11:08:39 +020059 # Only one finite field group to keep testing time within reasonable bounds.
Przemek Stekielae3209c2023-06-13 15:09:03 +020060 'ffdhe2048': 0x100,
Jerry Yu305bfc32021-11-24 16:04:47 +080061}
62
Jerry Yub7c12a42022-06-12 20:53:02 +080063class TLSProgram:
Jerry Yu305bfc32021-11-24 16:04:47 +080064 """
65 Base class for generate server/client command.
66 """
Jerry Yub7c12a42022-06-12 20:53:02 +080067
Jerry Yu7de79852022-03-23 16:50:47 +080068 # pylint: disable=too-many-arguments
XiaokangQiana1931442022-03-25 11:58:22 +000069 def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None,
70 cert_sig_alg=None, compat_mode=True):
Jerry Yu7918efe2021-12-01 15:29:10 +080071 self._ciphers = []
72 self._sig_algs = []
73 self._named_groups = []
Jerry Yu7de79852022-03-23 16:50:47 +080074 self._cert_sig_algs = []
75 if ciphersuite:
76 self.add_ciphersuites(ciphersuite)
77 if named_group:
78 self.add_named_groups(named_group)
79 if signature_algorithm:
80 self.add_signature_algorithms(signature_algorithm)
81 if cert_sig_alg:
82 self.add_cert_signature_algorithms(cert_sig_alg)
Ronald Cronae937252021-12-10 09:55:15 +010083 self._compat_mode = compat_mode
Jerry Yu305bfc32021-11-24 16:04:47 +080084
Jerry Yu7918efe2021-12-01 15:29:10 +080085 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080086 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +080087 self._ciphers.extend(
88 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +080089
Jerry Yu7918efe2021-12-01 15:29:10 +080090 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080091 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +080092 self._sig_algs.extend(
93 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +080094
Jerry Yu7de79852022-03-23 16:50:47 +080095 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080096 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +080097 self._named_groups.extend(
98 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +080099
Jerry Yu7de79852022-03-23 16:50:47 +0800100 # add_cert_signature_algorithms should not override by sub class
101 def add_cert_signature_algorithms(self, *signature_algorithms):
102 self._cert_sig_algs.extend(
103 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
104
Jerry Yub7c12a42022-06-12 20:53:02 +0800105 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800106 def pre_checks(self):
107 return []
108
Jerry Yub7c12a42022-06-12 20:53:02 +0800109 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800110 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800111 if not self._cert_sig_algs:
112 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yub7c12a42022-06-12 20:53:02 +0800113 return self.pre_cmd()
Jerry Yu305bfc32021-11-24 16:04:47 +0800114
Jerry Yub7c12a42022-06-12 20:53:02 +0800115 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800116 def post_checks(self):
117 return []
118
Jerry Yub7c12a42022-06-12 20:53:02 +0800119 # pylint: disable=no-self-use
XiaokangQianb1847a22022-06-08 07:49:31 +0000120 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800121 return ['false']
Jerry Yu305bfc32021-11-24 16:04:47 +0800122
Jerry Yub7c12a42022-06-12 20:53:02 +0800123 # pylint: disable=unused-argument,no-self-use
XiaokangQian9b938b72022-06-10 03:10:59 +0000124 def hrr_post_checks(self, named_group):
125 return []
126
XiaokangQianb1847a22022-06-08 07:49:31 +0000127
128class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800129 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000130 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800131 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800132
133 NAMED_GROUP = {
134 'secp256r1': 'P-256',
135 'secp384r1': 'P-384',
136 'secp521r1': 'P-521',
137 'x25519': 'X25519',
138 'x448': 'X448',
Przemek Stekielae3209c2023-06-13 15:09:03 +0200139 'ffdhe2048': 'ffdhe2048',
Jerry Yu305bfc32021-11-24 16:04:47 +0800140 }
141
Jerry Yu305bfc32021-11-24 16:04:47 +0800142 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800143 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000144
145 if self._ciphers:
146 ciphersuites = ':'.join(self._ciphers)
147 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
148
149 if self._sig_algs:
150 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
151 signature_algorithms = ':'.join(signature_algorithms)
152 ret += ["-sigalgs {signature_algorithms}".format(
153 signature_algorithms=signature_algorithms)]
154
155 if self._named_groups:
156 named_groups = ':'.join(
157 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
158 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
159
160 ret += ['-msg -tls1_3']
161 if not self._compat_mode:
162 ret += ['-no_middlebox']
163
XiaokangQianb1847a22022-06-08 07:49:31 +0000164 return ret
165
166 def pre_checks(self):
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200167 ret = ["requires_openssl_tls1_3"]
168
169 # ffdh groups require at least openssl 3.0
Przemek Stekiel3484db42023-06-28 13:31:38 +0200170 ffdh_groups = ['ffdhe2048']
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200171
172 if any(x in ffdh_groups for x in self._named_groups):
Przemek Stekiel8bfe8972023-06-26 12:59:45 +0200173 ret = ["requires_openssl_tls1_3_with_ffdh"]
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200174
175 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000176
XiaokangQianb1847a22022-06-08 07:49:31 +0000177
178class OpenSSLServ(OpenSSLBase):
179 """
180 Generate test commands for OpenSSL server.
181 """
182
183 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800184 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000185 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800186 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000187
XiaokangQiand5d5b602022-05-23 09:16:20 +0000188 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000189 return ['-c "HTTP/1.0 200 ok"']
190
191 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800192 ret = ['$O_NEXT_SRV_NO_CERT']
193 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
194 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
195 return ret
196
197
198class OpenSSLCli(OpenSSLBase):
199 """
200 Generate test commands for OpenSSL client.
201 """
202
203 def pre_cmd(self):
204 return ['$O_NEXT_CLI_NO_CERT',
205 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000206
207
XiaokangQianb1847a22022-06-08 07:49:31 +0000208class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000209 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000210 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000211 """
212
213 CIPHER_SUITE = {
214 'TLS_AES_256_GCM_SHA384': [
215 'AES-256-GCM',
216 'SHA384',
217 'AEAD'],
218 'TLS_AES_128_GCM_SHA256': [
219 'AES-128-GCM',
220 'SHA256',
221 'AEAD'],
222 'TLS_CHACHA20_POLY1305_SHA256': [
223 'CHACHA20-POLY1305',
224 'SHA256',
225 'AEAD'],
226 'TLS_AES_128_CCM_SHA256': [
227 'AES-128-CCM',
228 'SHA256',
229 'AEAD'],
230 'TLS_AES_128_CCM_8_SHA256': [
231 'AES-128-CCM-8',
232 'SHA256',
233 'AEAD']}
234
235 SIGNATURE_ALGORITHM = {
236 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
237 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
238 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
239 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
240
241 NAMED_GROUP = {
242 'secp256r1': ['GROUP-SECP256R1'],
243 'secp384r1': ['GROUP-SECP384R1'],
244 'secp521r1': ['GROUP-SECP521R1'],
245 'x25519': ['GROUP-X25519'],
246 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200247 'ffdhe2048': ['GROUP-FFDHE2048'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000248 }
249
250 def pre_checks(self):
251 return ["requires_gnutls_tls1_3",
252 "requires_gnutls_next_no_ticket",
253 "requires_gnutls_next_disable_tls13_compat", ]
254
XiaokangQiand5d5b602022-05-23 09:16:20 +0000255 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800256 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000257
258 priority_string_list = []
259
260 def update_priority_string_list(items, map_table):
261 for item in items:
262 for i in map_table[item]:
263 if i not in priority_string_list:
264 yield i
265
266 if self._ciphers:
267 priority_string_list.extend(update_priority_string_list(
268 self._ciphers, self.CIPHER_SUITE))
269 else:
270 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
271
272 if self._sig_algs:
273 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
274 priority_string_list.extend(update_priority_string_list(
275 signature_algorithms, self.SIGNATURE_ALGORITHM))
276 else:
277 priority_string_list.append('SIGN-ALL')
278
279
280 if self._named_groups:
281 priority_string_list.extend(update_priority_string_list(
282 self._named_groups, self.NAMED_GROUP))
283 else:
284 priority_string_list.append('GROUP-ALL')
285
286 priority_string_list = ['NONE'] + \
287 priority_string_list + ['VERS-TLS1.3']
288
289 priority_string = ':+'.join(priority_string_list)
290 priority_string += ':%NO_TICKETS'
291
292 if not self._compat_mode:
293 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
294
295 ret += ['--priority={priority_string}'.format(
296 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000297 return ret
298
299class GnuTLSServ(GnuTLSBase):
300 """
301 Generate test commands for GnuTLS server.
302 """
303
Jerry Yub7c12a42022-06-12 20:53:02 +0800304 def pre_cmd(self):
305 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000306
Jerry Yub7c12a42022-06-12 20:53:02 +0800307 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
308 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
309 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000310 return ret
311
Jerry Yub7c12a42022-06-12 20:53:02 +0800312 def post_checks(self):
313 return ['-c "HTTP/1.0 200 OK"']
314
315
316class GnuTLSCli(GnuTLSBase):
317 """
318 Generate test commands for GnuTLS client.
319 """
320
XiaokangQianb1847a22022-06-08 07:49:31 +0000321 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800322 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
323 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000324
XiaokangQianb1847a22022-06-08 07:49:31 +0000325
326class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800327 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000328 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800329 """
Jerry Yu29deed42021-11-25 11:09:54 +0800330
Jerry Yu305bfc32021-11-24 16:04:47 +0800331 CIPHER_SUITE = {
332 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
333 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
334 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
335 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
336 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
337
Jerry Yu7918efe2021-12-01 15:29:10 +0800338 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800339 ret = super().cmd()
340 ret += ['debug_level=4']
341
Jerry Yu305bfc32021-11-24 16:04:47 +0800342
XiaokangQiana1931442022-03-25 11:58:22 +0000343 if self._ciphers:
344 ciphers = ','.join(
345 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
346 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800347
XiaokangQiana1931442022-03-25 11:58:22 +0000348 if self._sig_algs + self._cert_sig_algs:
349 ret += ['sig_algs={sig_algs}'.format(
350 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800351
Jerry Yu7918efe2021-12-01 15:29:10 +0800352 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000353 named_groups = ','.join(self._named_groups)
Przemek Stekiel45255e42023-06-29 13:56:36 +0200354 ret += ["groups={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000355 return ret
356
Valerio Setti18371ee2024-01-18 09:49:39 +0100357 #pylint: disable=missing-function-docstring
358 def add_ffdh_group_requirements(self, requirement_list):
359 if 'ffdhe2048' in self._named_groups:
360 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
361 if 'ffdhe3072' in self._named_groups:
362 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
363 if 'ffdhe4096' in self._named_groups:
364 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
365 if 'ffdhe6144' in self._named_groups:
366 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
367 if 'ffdhe8192' in self._named_groups:
368 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
369
XiaokangQianb1847a22022-06-08 07:49:31 +0000370 def pre_checks(self):
371 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200372 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000373
374 if self._compat_mode:
375 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
376
377 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
378 ret.append(
379 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200380
381 ec_groups = ['secp256r1', 'secp384r1', 'secp521r1', 'x25519', 'x448']
Valerio Setti18371ee2024-01-18 09:49:39 +0100382 ffdh_groups = ['ffdhe2048', 'ffdhe3072', 'ffdhe4096', 'ffdhe6144', 'ffdhe8192']
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200383
384 if any(x in ec_groups for x in self._named_groups):
Przemek Stekielc31a7982023-06-27 10:53:33 +0200385 ret.append('requires_config_enabled PSA_WANT_ALG_ECDH')
386
387 if any(x in ffdh_groups for x in self._named_groups):
388 ret.append('requires_config_enabled PSA_WANT_ALG_FFDH')
Valerio Setti18371ee2024-01-18 09:49:39 +0100389 self.add_ffdh_group_requirements(ret)
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200390
XiaokangQianb1847a22022-06-08 07:49:31 +0000391 return ret
392
XiaokangQianb1847a22022-06-08 07:49:31 +0000393
394class MbedTLSServ(MbedTLSBase):
395 """
396 Generate test commands for mbedTLS server.
397 """
398
399 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800400 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000401 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800402 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800403
404 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000405 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800406
407 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100408 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800409 if self._ciphers:
410 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000411 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
412 self.CIPHER_SUITE[self._ciphers[0]],
413 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
414 if self._sig_algs:
415 check_strings.append(
416 "received signature algorithm: 0x{:x}".format(
417 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
418
419 for named_group in self._named_groups:
420 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
421 named_group=named_group,
422 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
423
Ronald Croneac00ad2022-09-13 10:16:31 +0200424 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000425 return ['-s "{}"'.format(i) for i in check_strings]
426
427 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800428 ret = ['$P_SRV']
429 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
430 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
431 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000432
XiaokangQian9b938b72022-06-10 03:10:59 +0000433 def hrr_post_checks(self, named_group):
434 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
435
XiaokangQianb1847a22022-06-08 07:49:31 +0000436
XiaokangQianb1847a22022-06-08 07:49:31 +0000437class MbedTLSCli(MbedTLSBase):
438 """
439 Generate test commands for mbedTLS client.
440 """
441
XiaokangQianb1847a22022-06-08 07:49:31 +0000442 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800443 return ['$P_CLI',
444 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000445
446 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000447 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000448
XiaokangQian9b938b72022-06-10 03:10:59 +0000449 def hrr_post_checks(self, named_group):
450 ret = ['-c "received HelloRetryRequest message"']
451 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000452 return ret
453
454 def post_checks(self):
455 check_strings = ["Protocol is TLSv1.3"]
456 if self._ciphers:
457 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800458 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
459 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
460 self.CIPHER_SUITE[self._ciphers[0]]))
461 if self._sig_algs:
462 check_strings.append(
463 "Certificate Verify: Signature algorithm ( {:04x} )".format(
464 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
465
466 for named_group in self._named_groups:
467 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
468 named_group=named_group,
469 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
470
471 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800472 return ['-c "{}"'.format(i) for i in check_strings]
473
Jerry Yu305bfc32021-11-24 16:04:47 +0800474
XiaokangQianb1847a22022-06-08 07:49:31 +0000475SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
476CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800477
478
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200479def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800480 """
481 Generate test case with `ssl-opt.sh` format.
482 """
Jerry Yudda036d2021-11-30 11:19:41 +0800483 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200484 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800485
486 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
487 named_group=named_group,
488 signature_algorithm=sig_alg,
489 cert_sig_alg=sig_alg)
490 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
491 named_group=named_group,
492 signature_algorithm=sig_alg,
493 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800494
Jerry Yub7c12a42022-06-12 20:53:02 +0800495 cmd = ['run_test "{}"'.format(name),
496 '"{}"'.format(' '.join(server_object.cmd())),
497 '"{}"'.format(' '.join(client_object.cmd())),
498 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000499 cmd += server_object.post_checks()
500 cmd += client_object.post_checks()
501 cmd += ['-C "received HelloRetryRequest message"']
502 prefix = ' \\\n' + (' '*9)
503 cmd = prefix.join(cmd)
504 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
505
506
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200507def generate_hrr_compat_test(client=None, server=None,
508 client_named_group=None, server_named_group=None,
509 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000510 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000511 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000512 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000513 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000514 client=client, server=server, c_named_group=client_named_group,
515 s_named_group=server_named_group)
516 server_object = SERVER_CLASSES[server](named_group=server_named_group,
517 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000518
XiaokangQian2e17fb82022-03-28 03:30:05 +0000519 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
520 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000521 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000522
Jerry Yub7c12a42022-06-12 20:53:02 +0800523 cmd = ['run_test "{}"'.format(name),
524 '"{}"'.format(' '.join(server_object.cmd())),
525 '"{}"'.format(' '.join(client_object.cmd())),
526 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000527 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000528 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000529 cmd += server_object.hrr_post_checks(server_named_group)
530 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000531 prefix = ' \\\n' + (' '*9)
532 cmd = prefix.join(cmd)
533 return '\n'.join(server_object.pre_checks() +
534 client_object.pre_checks() +
535 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800536
537SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800538
539# {filename}
540#
541# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +0000542# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yucdcb6832021-11-29 16:50:13 +0800543#
544# Purpose
545#
546# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000547# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800548#
549# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
550# AND REGENERATE THIS FILE.
551#
552'''
Jerry Yu29deed42021-11-25 11:09:54 +0800553
Jerry Yu305bfc32021-11-24 16:04:47 +0800554def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800555 """
556 Main function of this program
557 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800558 parser = argparse.ArgumentParser()
559
Jerry Yucdcb6832021-11-29 16:50:13 +0800560 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800561 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800562
Jerry Yuc4aa1522021-11-26 11:13:58 +0800563 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
564 default=False, help='Generate all available tls13 compat tests')
565
Jerry Yu305bfc32021-11-24 16:04:47 +0800566 parser.add_argument('--list-ciphers', action='store_true',
567 default=False, help='List supported ciphersuites')
568
569 parser.add_argument('--list-sig-algs', action='store_true',
570 default=False, help='List supported signature algorithms')
571
572 parser.add_argument('--list-named-groups', action='store_true',
573 default=False, help='List supported named groups')
574
575 parser.add_argument('--list-servers', action='store_true',
576 default=False, help='List supported TLS servers')
577
578 parser.add_argument('--list-clients', action='store_true',
579 default=False, help='List supported TLS Clients')
580
Jerry Yub4ac8f32021-12-01 10:41:37 +0800581 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
582 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800583 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800584 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
585 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800586 help='Choose TLS client program for test')
587 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
588 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
589 help='Choose cipher suite for test')
590 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
591 default=list(SIG_ALG_IANA_VALUE.keys())[0],
592 help='Choose cipher suite for test')
593 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
594 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
595 help='Choose cipher suite for test')
596
597 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800598
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800599 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800600 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200601 for client, server, cipher, named_group, sig_alg in \
602 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800603 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200604 CIPHER_SUITE_IANA_VALUE.keys(),
605 NAMED_GROUP_IANA_VALUE.keys(),
606 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000607 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000608 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000609 cipher=cipher, named_group=named_group,
610 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000611
XiaokangQiand5d5b602022-05-23 09:16:20 +0000612
XiaokangQiana1931442022-03-25 11:58:22 +0000613 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000614 for client, server, client_named_group, server_named_group in \
615 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000616 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000617 NAMED_GROUP_IANA_VALUE.keys(),
618 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800619
XiaokangQian9b938b72022-06-10 03:10:59 +0000620 if (client == 'mbedTLS' or server == 'mbedTLS') and \
621 client_named_group != server_named_group:
622 yield generate_hrr_compat_test(client=client, server=server,
623 client_named_group=client_named_group,
624 server_named_group=server_named_group,
625 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000626
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800627 if args.generate_all_tls13_compat_tests:
628 if args.output:
629 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800630 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000631 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800632 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800633 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800634 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800635 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800636 return 0
637
Jerry Yu305bfc32021-11-24 16:04:47 +0800638 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800639 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800640 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800641 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800642 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800643 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800644 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800645 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800646 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800647 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800648 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800649 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800650 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800651
XiaokangQiana1931442022-03-25 11:58:22 +0000652 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
653 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800654 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800655
Jerry Yu29deed42021-11-25 11:09:54 +0800656
Jerry Yu305bfc32021-11-24 16:04:47 +0800657if __name__ == "__main__":
658 sys.exit(main())