blob: b9dcff4e1030f3879b970cc2f92c3f1de19a0974 [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 = {
David Horstmannb51ed612024-07-03 13:41:32 +010023 'ecdsa_secp256r1_sha256': Certificate('$DATA_FILES_PATH/test-ca2.crt',
24 '$DATA_FILES_PATH/ecdsa_secp256r1.crt',
25 '$DATA_FILES_PATH/ecdsa_secp256r1.key'),
26 'ecdsa_secp384r1_sha384': Certificate('$DATA_FILES_PATH/test-ca2.crt',
27 '$DATA_FILES_PATH/ecdsa_secp384r1.crt',
28 '$DATA_FILES_PATH/ecdsa_secp384r1.key'),
29 'ecdsa_secp521r1_sha512': Certificate('$DATA_FILES_PATH/test-ca2.crt',
30 '$DATA_FILES_PATH/ecdsa_secp521r1.crt',
31 '$DATA_FILES_PATH/ecdsa_secp521r1.key'),
32 'rsa_pss_rsae_sha256': Certificate('$DATA_FILES_PATH/test-ca_cat12.crt',
33 '$DATA_FILES_PATH/server2-sha256.crt',
34 '$DATA_FILES_PATH/server2.key')
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,
Gilles Peskineae5a35f2024-09-13 15:18:07 +020069 cert_sig_alg=None):
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)
Jerry Yu305bfc32021-11-24 16:04:47 +080082
Jerry Yu7918efe2021-12-01 15:29:10 +080083 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080084 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +080085 self._ciphers.extend(
86 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +080087
Jerry Yu7918efe2021-12-01 15:29:10 +080088 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080089 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +080090 self._sig_algs.extend(
91 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +080092
Jerry Yu7de79852022-03-23 16:50:47 +080093 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080094 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +080095 self._named_groups.extend(
96 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +080097
Jerry Yu7de79852022-03-23 16:50:47 +080098 # add_cert_signature_algorithms should not override by sub class
99 def add_cert_signature_algorithms(self, *signature_algorithms):
100 self._cert_sig_algs.extend(
101 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
102
Jerry Yub7c12a42022-06-12 20:53:02 +0800103 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800104 def pre_checks(self):
105 return []
106
Jerry Yub7c12a42022-06-12 20:53:02 +0800107 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800108 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800109 if not self._cert_sig_algs:
110 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yub7c12a42022-06-12 20:53:02 +0800111 return self.pre_cmd()
Jerry Yu305bfc32021-11-24 16:04:47 +0800112
Jerry Yub7c12a42022-06-12 20:53:02 +0800113 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800114 def post_checks(self):
115 return []
116
Jerry Yub7c12a42022-06-12 20:53:02 +0800117 # pylint: disable=no-self-use
XiaokangQianb1847a22022-06-08 07:49:31 +0000118 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800119 return ['false']
Jerry Yu305bfc32021-11-24 16:04:47 +0800120
Jerry Yub7c12a42022-06-12 20:53:02 +0800121 # pylint: disable=unused-argument,no-self-use
XiaokangQian9b938b72022-06-10 03:10:59 +0000122 def hrr_post_checks(self, named_group):
123 return []
124
XiaokangQianb1847a22022-06-08 07:49:31 +0000125
126class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800127 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000128 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800129 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800130
131 NAMED_GROUP = {
132 'secp256r1': 'P-256',
133 'secp384r1': 'P-384',
134 'secp521r1': 'P-521',
135 'x25519': 'X25519',
136 'x448': 'X448',
Przemek Stekielae3209c2023-06-13 15:09:03 +0200137 'ffdhe2048': 'ffdhe2048',
Jerry Yu305bfc32021-11-24 16:04:47 +0800138 }
139
Jerry Yu305bfc32021-11-24 16:04:47 +0800140 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800141 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000142
143 if self._ciphers:
144 ciphersuites = ':'.join(self._ciphers)
145 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
146
147 if self._sig_algs:
148 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
149 signature_algorithms = ':'.join(signature_algorithms)
150 ret += ["-sigalgs {signature_algorithms}".format(
151 signature_algorithms=signature_algorithms)]
152
153 if self._named_groups:
154 named_groups = ':'.join(
155 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
156 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
157
158 ret += ['-msg -tls1_3']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000159
XiaokangQianb1847a22022-06-08 07:49:31 +0000160 return ret
161
162 def pre_checks(self):
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200163 ret = ["requires_openssl_tls1_3"]
164
165 # ffdh groups require at least openssl 3.0
Przemek Stekiel3484db42023-06-28 13:31:38 +0200166 ffdh_groups = ['ffdhe2048']
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200167
168 if any(x in ffdh_groups for x in self._named_groups):
Przemek Stekiel8bfe8972023-06-26 12:59:45 +0200169 ret = ["requires_openssl_tls1_3_with_ffdh"]
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200170
171 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000172
XiaokangQianb1847a22022-06-08 07:49:31 +0000173
174class OpenSSLServ(OpenSSLBase):
175 """
176 Generate test commands for OpenSSL server.
177 """
178
179 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800180 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000181 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800182 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000183
XiaokangQiand5d5b602022-05-23 09:16:20 +0000184 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000185 return ['-c "HTTP/1.0 200 ok"']
186
187 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800188 ret = ['$O_NEXT_SRV_NO_CERT']
189 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
190 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
191 return ret
192
193
194class OpenSSLCli(OpenSSLBase):
195 """
196 Generate test commands for OpenSSL client.
197 """
198
199 def pre_cmd(self):
200 return ['$O_NEXT_CLI_NO_CERT',
201 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000202
203
XiaokangQianb1847a22022-06-08 07:49:31 +0000204class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000205 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000206 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000207 """
208
209 CIPHER_SUITE = {
210 'TLS_AES_256_GCM_SHA384': [
211 'AES-256-GCM',
212 'SHA384',
213 'AEAD'],
214 'TLS_AES_128_GCM_SHA256': [
215 'AES-128-GCM',
216 'SHA256',
217 'AEAD'],
218 'TLS_CHACHA20_POLY1305_SHA256': [
219 'CHACHA20-POLY1305',
220 'SHA256',
221 'AEAD'],
222 'TLS_AES_128_CCM_SHA256': [
223 'AES-128-CCM',
224 'SHA256',
225 'AEAD'],
226 'TLS_AES_128_CCM_8_SHA256': [
227 'AES-128-CCM-8',
228 'SHA256',
229 'AEAD']}
230
231 SIGNATURE_ALGORITHM = {
232 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
233 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
234 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
235 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
236
237 NAMED_GROUP = {
238 'secp256r1': ['GROUP-SECP256R1'],
239 'secp384r1': ['GROUP-SECP384R1'],
240 'secp521r1': ['GROUP-SECP521R1'],
241 'x25519': ['GROUP-X25519'],
242 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200243 'ffdhe2048': ['GROUP-FFDHE2048'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000244 }
245
246 def pre_checks(self):
247 return ["requires_gnutls_tls1_3",
Gilles Peskine1e01b4a2024-09-19 19:05:35 +0200248 "requires_gnutls_next_no_ticket"]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000249
XiaokangQiand5d5b602022-05-23 09:16:20 +0000250 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800251 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000252
253 priority_string_list = []
254
255 def update_priority_string_list(items, map_table):
256 for item in items:
257 for i in map_table[item]:
258 if i not in priority_string_list:
259 yield i
260
261 if self._ciphers:
262 priority_string_list.extend(update_priority_string_list(
263 self._ciphers, self.CIPHER_SUITE))
264 else:
265 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
266
267 if self._sig_algs:
268 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
269 priority_string_list.extend(update_priority_string_list(
270 signature_algorithms, self.SIGNATURE_ALGORITHM))
271 else:
272 priority_string_list.append('SIGN-ALL')
273
274
275 if self._named_groups:
276 priority_string_list.extend(update_priority_string_list(
277 self._named_groups, self.NAMED_GROUP))
278 else:
279 priority_string_list.append('GROUP-ALL')
280
281 priority_string_list = ['NONE'] + \
282 priority_string_list + ['VERS-TLS1.3']
283
284 priority_string = ':+'.join(priority_string_list)
285 priority_string += ':%NO_TICKETS'
286
XiaokangQiand5d5b602022-05-23 09:16:20 +0000287 ret += ['--priority={priority_string}'.format(
288 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000289 return ret
290
291class GnuTLSServ(GnuTLSBase):
292 """
293 Generate test commands for GnuTLS server.
294 """
295
Jerry Yub7c12a42022-06-12 20:53:02 +0800296 def pre_cmd(self):
297 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000298
Jerry Yub7c12a42022-06-12 20:53:02 +0800299 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
300 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
301 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000302 return ret
303
Jerry Yub7c12a42022-06-12 20:53:02 +0800304 def post_checks(self):
305 return ['-c "HTTP/1.0 200 OK"']
306
307
308class GnuTLSCli(GnuTLSBase):
309 """
310 Generate test commands for GnuTLS client.
311 """
312
XiaokangQianb1847a22022-06-08 07:49:31 +0000313 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800314 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
315 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000316
XiaokangQianb1847a22022-06-08 07:49:31 +0000317
318class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800319 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000320 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800321 """
Jerry Yu29deed42021-11-25 11:09:54 +0800322
Jerry Yu305bfc32021-11-24 16:04:47 +0800323 CIPHER_SUITE = {
324 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
325 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
326 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
327 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
328 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
329
Jerry Yu7918efe2021-12-01 15:29:10 +0800330 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800331 ret = super().cmd()
332 ret += ['debug_level=4']
333
Jerry Yu305bfc32021-11-24 16:04:47 +0800334
XiaokangQiana1931442022-03-25 11:58:22 +0000335 if self._ciphers:
336 ciphers = ','.join(
337 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
338 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800339
XiaokangQiana1931442022-03-25 11:58:22 +0000340 if self._sig_algs + self._cert_sig_algs:
341 ret += ['sig_algs={sig_algs}'.format(
342 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800343
Jerry Yu7918efe2021-12-01 15:29:10 +0800344 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000345 named_groups = ','.join(self._named_groups)
Przemek Stekiel45255e42023-06-29 13:56:36 +0200346 ret += ["groups={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000347 return ret
348
Valerio Setti18371ee2024-01-18 09:49:39 +0100349 #pylint: disable=missing-function-docstring
350 def add_ffdh_group_requirements(self, requirement_list):
351 if 'ffdhe2048' in self._named_groups:
352 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
353 if 'ffdhe3072' in self._named_groups:
354 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
355 if 'ffdhe4096' in self._named_groups:
356 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
357 if 'ffdhe6144' in self._named_groups:
358 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
359 if 'ffdhe8192' in self._named_groups:
360 requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048')
361
XiaokangQianb1847a22022-06-08 07:49:31 +0000362 def pre_checks(self):
363 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200364 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000365
XiaokangQianb1847a22022-06-08 07:49:31 +0000366 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
367 ret.append(
368 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200369
370 ec_groups = ['secp256r1', 'secp384r1', 'secp521r1', 'x25519', 'x448']
Valerio Setti18371ee2024-01-18 09:49:39 +0100371 ffdh_groups = ['ffdhe2048', 'ffdhe3072', 'ffdhe4096', 'ffdhe6144', 'ffdhe8192']
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200372
373 if any(x in ec_groups for x in self._named_groups):
Przemek Stekielc31a7982023-06-27 10:53:33 +0200374 ret.append('requires_config_enabled PSA_WANT_ALG_ECDH')
375
376 if any(x in ffdh_groups for x in self._named_groups):
377 ret.append('requires_config_enabled PSA_WANT_ALG_FFDH')
Valerio Setti18371ee2024-01-18 09:49:39 +0100378 self.add_ffdh_group_requirements(ret)
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200379
XiaokangQianb1847a22022-06-08 07:49:31 +0000380 return ret
381
XiaokangQianb1847a22022-06-08 07:49:31 +0000382
383class MbedTLSServ(MbedTLSBase):
384 """
385 Generate test commands for mbedTLS server.
386 """
387
388 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800389 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000390 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800391 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800392
393 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000394 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800395
396 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100397 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800398 if self._ciphers:
399 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000400 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
401 self.CIPHER_SUITE[self._ciphers[0]],
402 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
403 if self._sig_algs:
404 check_strings.append(
405 "received signature algorithm: 0x{:x}".format(
406 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
407
408 for named_group in self._named_groups:
409 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
410 named_group=named_group,
411 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
412
Ronald Croneac00ad2022-09-13 10:16:31 +0200413 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000414 return ['-s "{}"'.format(i) for i in check_strings]
415
416 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800417 ret = ['$P_SRV']
418 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
419 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
420 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000421
XiaokangQian9b938b72022-06-10 03:10:59 +0000422 def hrr_post_checks(self, named_group):
423 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
424
XiaokangQianb1847a22022-06-08 07:49:31 +0000425
XiaokangQianb1847a22022-06-08 07:49:31 +0000426class MbedTLSCli(MbedTLSBase):
427 """
428 Generate test commands for mbedTLS client.
429 """
430
XiaokangQianb1847a22022-06-08 07:49:31 +0000431 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800432 return ['$P_CLI',
433 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000434
435 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000436 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000437
XiaokangQian9b938b72022-06-10 03:10:59 +0000438 def hrr_post_checks(self, named_group):
439 ret = ['-c "received HelloRetryRequest message"']
440 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000441 return ret
442
443 def post_checks(self):
444 check_strings = ["Protocol is TLSv1.3"]
445 if self._ciphers:
446 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800447 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
448 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
449 self.CIPHER_SUITE[self._ciphers[0]]))
450 if self._sig_algs:
451 check_strings.append(
452 "Certificate Verify: Signature algorithm ( {:04x} )".format(
453 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
454
455 for named_group in self._named_groups:
456 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
457 named_group=named_group,
458 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
459
460 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800461 return ['-c "{}"'.format(i) for i in check_strings]
462
Jerry Yu305bfc32021-11-24 16:04:47 +0800463
XiaokangQianb1847a22022-06-08 07:49:31 +0000464SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
465CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800466
467
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200468def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800469 """
470 Generate test case with `ssl-opt.sh` format.
471 """
Jerry Yudda036d2021-11-30 11:19:41 +0800472 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200473 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800474
475 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
476 named_group=named_group,
477 signature_algorithm=sig_alg,
478 cert_sig_alg=sig_alg)
479 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
480 named_group=named_group,
481 signature_algorithm=sig_alg,
482 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800483
Jerry Yub7c12a42022-06-12 20:53:02 +0800484 cmd = ['run_test "{}"'.format(name),
485 '"{}"'.format(' '.join(server_object.cmd())),
486 '"{}"'.format(' '.join(client_object.cmd())),
487 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000488 cmd += server_object.post_checks()
489 cmd += client_object.post_checks()
490 cmd += ['-C "received HelloRetryRequest message"']
491 prefix = ' \\\n' + (' '*9)
492 cmd = prefix.join(cmd)
493 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
494
495
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200496def generate_hrr_compat_test(client=None, server=None,
497 client_named_group=None, server_named_group=None,
498 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000499 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000500 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000501 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000502 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000503 client=client, server=server, c_named_group=client_named_group,
504 s_named_group=server_named_group)
505 server_object = SERVER_CLASSES[server](named_group=server_named_group,
506 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000507
XiaokangQian2e17fb82022-03-28 03:30:05 +0000508 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
509 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000510 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000511
Jerry Yub7c12a42022-06-12 20:53:02 +0800512 cmd = ['run_test "{}"'.format(name),
513 '"{}"'.format(' '.join(server_object.cmd())),
514 '"{}"'.format(' '.join(client_object.cmd())),
515 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000516 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000517 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000518 cmd += server_object.hrr_post_checks(server_named_group)
519 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000520 prefix = ' \\\n' + (' '*9)
521 cmd = prefix.join(cmd)
522 return '\n'.join(server_object.pre_checks() +
523 client_object.pre_checks() +
524 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800525
Gilles Peskine1d6a9502024-09-13 13:53:50 +0200526SSL_OUTPUT_HEADER = '''\
527# TLS 1.3 interoperability test cases (equivalent of compat.sh for TLS 1.3).
Jerry Yucdcb6832021-11-29 16:50:13 +0800528#
Gilles Peskine5dd839a2024-09-13 18:28:24 +0200529# Automatically generated by {cmd}. Do not edit!
Gilles Peskine1d6a9502024-09-13 13:53:50 +0200530
531# Copyright The Mbed TLS Contributors
532# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yucdcb6832021-11-29 16:50:13 +0800533'''
David Horstmannb51ed612024-07-03 13:41:32 +0100534DATA_FILES_PATH_VAR = '''
535DATA_FILES_PATH=../framework/data_files
536'''
Jerry Yu29deed42021-11-25 11:09:54 +0800537
Jerry Yu305bfc32021-11-24 16:04:47 +0800538def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800539 """
540 Main function of this program
541 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800542 parser = argparse.ArgumentParser()
543
Gilles Peskinec07beda2024-09-13 15:33:57 +0200544 parser.add_argument('-o', '--output',
545 default='tests/opt-testcases/tls13-compat.sh',
546 help='Output file path (not used with -1)')
Jerry Yucdcb6832021-11-29 16:50:13 +0800547
Gilles Peskinec07beda2024-09-13 15:33:57 +0200548 parser.add_argument('-1', '--single', action='store_true',
549 help='Print a single test case')
550 # Single mode used to be the default.
551 parser.add_argument('-a', '--generate-all-tls13-compat-tests',
552 action='store_false', dest='single',
553 help='Generate all test cases (negates -1) (default)')
Jerry Yuc4aa1522021-11-26 11:13:58 +0800554
Jerry Yu305bfc32021-11-24 16:04:47 +0800555 parser.add_argument('--list-ciphers', action='store_true',
556 default=False, help='List supported ciphersuites')
557
558 parser.add_argument('--list-sig-algs', action='store_true',
559 default=False, help='List supported signature algorithms')
560
561 parser.add_argument('--list-named-groups', action='store_true',
562 default=False, help='List supported named groups')
563
564 parser.add_argument('--list-servers', action='store_true',
565 default=False, help='List supported TLS servers')
566
567 parser.add_argument('--list-clients', action='store_true',
568 default=False, help='List supported TLS Clients')
569
Jerry Yub4ac8f32021-12-01 10:41:37 +0800570 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
571 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800572 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800573 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
574 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800575 help='Choose TLS client program for test')
576 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
577 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
578 help='Choose cipher suite for test')
579 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
580 default=list(SIG_ALG_IANA_VALUE.keys())[0],
581 help='Choose cipher suite for test')
582 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
583 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
584 help='Choose cipher suite for test')
585
586 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800587
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800588 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800589 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200590 for client, server, cipher, named_group, sig_alg in \
591 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800592 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200593 CIPHER_SUITE_IANA_VALUE.keys(),
594 NAMED_GROUP_IANA_VALUE.keys(),
595 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000596 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000597 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000598 cipher=cipher, named_group=named_group,
599 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000600
XiaokangQiand5d5b602022-05-23 09:16:20 +0000601
XiaokangQiana1931442022-03-25 11:58:22 +0000602 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000603 for client, server, client_named_group, server_named_group in \
604 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000605 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000606 NAMED_GROUP_IANA_VALUE.keys(),
607 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800608
XiaokangQian9b938b72022-06-10 03:10:59 +0000609 if (client == 'mbedTLS' or server == 'mbedTLS') and \
610 client_named_group != server_named_group:
611 yield generate_hrr_compat_test(client=client, server=server,
612 client_named_group=client_named_group,
613 server_named_group=server_named_group,
614 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000615
Gilles Peskinec07beda2024-09-13 15:33:57 +0200616 if not args.single:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800617 if args.output:
618 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800619 f.write(SSL_OUTPUT_HEADER.format(
Gilles Peskine5dd839a2024-09-13 18:28:24 +0200620 filename=os.path.basename(args.output),
621 cmd=os.path.basename(sys.argv[0])))
David Horstmannb51ed612024-07-03 13:41:32 +0100622 f.write(DATA_FILES_PATH_VAR)
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800623 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800624 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800625 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800626 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800627 return 0
628
Jerry Yu305bfc32021-11-24 16:04:47 +0800629 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800630 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800631 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800632 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800633 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800634 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800635 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800636 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800637 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800638 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800639 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800640 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800641 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800642
XiaokangQiana1931442022-03-25 11:58:22 +0000643 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
644 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800645 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800646
Jerry Yu29deed42021-11-25 11:09:54 +0800647
Jerry Yu305bfc32021-11-24 16:04:47 +0800648if __name__ == "__main__":
649 sys.exit(main())