blob: e66aefabe2a41045bdddbf8122067954fd3e12cb [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
6# SPDX-License-Identifier: Apache-2.0
7#
8# Licensed under the Apache License, Version 2.0 (the "License"); you may
9# not use this file except in compliance with the License.
10# You may obtain a copy of the License at
11#
12# http://www.apache.org/licenses/LICENSE-2.0
13#
14# Unless required by applicable law or agreed to in writing, software
15# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17# See the License for the specific language governing permissions and
18# limitations under the License.
19
20"""
21Generate TLSv1.3 Compat test cases
22
23"""
24
25import sys
Jerry Yudda036d2021-11-30 11:19:41 +080026import os
Jerry Yu305bfc32021-11-24 16:04:47 +080027import argparse
Jerry Yuc4aa1522021-11-26 11:13:58 +080028import itertools
Jerry Yu882c30d2021-12-01 10:59:59 +080029from collections import namedtuple
Jerry Yu305bfc32021-11-24 16:04:47 +080030
Jerry Yu882c30d2021-12-01 10:59:59 +080031# define certificates configuration entry
32Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile'])
33# define the certificate parameters for signature algorithms
Jerry Yu305bfc32021-11-24 16:04:47 +080034CERTIFICATES = {
Jerry Yu882c30d2021-12-01 10:59:59 +080035 'ecdsa_secp256r1_sha256': Certificate('data_files/test-ca2.crt',
36 'data_files/ecdsa_secp256r1.crt',
37 'data_files/ecdsa_secp256r1.key'),
38 'ecdsa_secp384r1_sha384': Certificate('data_files/test-ca2.crt',
39 'data_files/ecdsa_secp384r1.crt',
40 'data_files/ecdsa_secp384r1.key'),
41 'ecdsa_secp521r1_sha512': Certificate('data_files/test-ca2.crt',
42 'data_files/ecdsa_secp521r1.crt',
43 'data_files/ecdsa_secp521r1.key'),
44 'rsa_pss_rsae_sha256': Certificate('data_files/test-ca_cat12.crt',
45 'data_files/server2-sha256.crt', 'data_files/server2.key'
46 )
Jerry Yu29deed42021-11-25 11:09:54 +080047}
Jerry Yu305bfc32021-11-24 16:04:47 +080048
49CIPHER_SUITE_IANA_VALUE = {
50 "TLS_AES_128_GCM_SHA256": 0x1301,
51 "TLS_AES_256_GCM_SHA384": 0x1302,
52 "TLS_CHACHA20_POLY1305_SHA256": 0x1303,
53 "TLS_AES_128_CCM_SHA256": 0x1304,
54 "TLS_AES_128_CCM_8_SHA256": 0x1305
55}
56
57SIG_ALG_IANA_VALUE = {
58 "ecdsa_secp256r1_sha256": 0x0403,
59 "ecdsa_secp384r1_sha384": 0x0503,
60 "ecdsa_secp521r1_sha512": 0x0603,
Jerry Yu29deed42021-11-25 11:09:54 +080061 'rsa_pss_rsae_sha256': 0x0804,
Jerry Yu305bfc32021-11-24 16:04:47 +080062}
63
64NAMED_GROUP_IANA_VALUE = {
65 'secp256r1': 0x17,
66 'secp384r1': 0x18,
67 'secp521r1': 0x19,
68 'x25519': 0x1d,
69 'x448': 0x1e,
Przemek Stekielae3209c2023-06-13 15:09:03 +020070 'ffdhe2048': 0x100,
Jerry Yu305bfc32021-11-24 16:04:47 +080071}
72
XiaokangQian68a87e42022-03-17 06:06:07 +000073
Jerry Yub7c12a42022-06-12 20:53:02 +080074class TLSProgram:
Jerry Yu305bfc32021-11-24 16:04:47 +080075 """
76 Base class for generate server/client command.
77 """
Jerry Yub7c12a42022-06-12 20:53:02 +080078
Jerry Yu7de79852022-03-23 16:50:47 +080079 # pylint: disable=too-many-arguments
XiaokangQiana1931442022-03-25 11:58:22 +000080 def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None,
81 cert_sig_alg=None, compat_mode=True):
Jerry Yu7918efe2021-12-01 15:29:10 +080082 self._ciphers = []
83 self._sig_algs = []
84 self._named_groups = []
Jerry Yu7de79852022-03-23 16:50:47 +080085 self._cert_sig_algs = []
86 if ciphersuite:
87 self.add_ciphersuites(ciphersuite)
88 if named_group:
89 self.add_named_groups(named_group)
90 if signature_algorithm:
91 self.add_signature_algorithms(signature_algorithm)
92 if cert_sig_alg:
93 self.add_cert_signature_algorithms(cert_sig_alg)
Ronald Cronae937252021-12-10 09:55:15 +010094 self._compat_mode = compat_mode
Jerry Yu305bfc32021-11-24 16:04:47 +080095
Jerry Yu7918efe2021-12-01 15:29:10 +080096 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080097 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +080098 self._ciphers.extend(
99 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +0800100
Jerry Yu7918efe2021-12-01 15:29:10 +0800101 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800102 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +0800103 self._sig_algs.extend(
104 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +0800105
Jerry Yu7de79852022-03-23 16:50:47 +0800106 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800107 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +0800108 self._named_groups.extend(
109 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +0800110
Jerry Yu7de79852022-03-23 16:50:47 +0800111 # add_cert_signature_algorithms should not override by sub class
112 def add_cert_signature_algorithms(self, *signature_algorithms):
113 self._cert_sig_algs.extend(
114 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
115
Jerry Yub7c12a42022-06-12 20:53:02 +0800116 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800117 def pre_checks(self):
118 return []
119
Jerry Yub7c12a42022-06-12 20:53:02 +0800120 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800121 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800122 if not self._cert_sig_algs:
123 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yub7c12a42022-06-12 20:53:02 +0800124 return self.pre_cmd()
Jerry Yu305bfc32021-11-24 16:04:47 +0800125
Jerry Yub7c12a42022-06-12 20:53:02 +0800126 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800127 def post_checks(self):
128 return []
129
Jerry Yub7c12a42022-06-12 20:53:02 +0800130 # pylint: disable=no-self-use
XiaokangQianb1847a22022-06-08 07:49:31 +0000131 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800132 return ['false']
Jerry Yu305bfc32021-11-24 16:04:47 +0800133
Jerry Yub7c12a42022-06-12 20:53:02 +0800134 # pylint: disable=unused-argument,no-self-use
XiaokangQian9b938b72022-06-10 03:10:59 +0000135 def hrr_post_checks(self, named_group):
136 return []
137
XiaokangQianb1847a22022-06-08 07:49:31 +0000138
139class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800140 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000141 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800142 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800143
144 NAMED_GROUP = {
145 'secp256r1': 'P-256',
146 'secp384r1': 'P-384',
147 'secp521r1': 'P-521',
148 'x25519': 'X25519',
149 'x448': 'X448',
Przemek Stekielae3209c2023-06-13 15:09:03 +0200150 'ffdhe2048': 'ffdhe2048',
Jerry Yu305bfc32021-11-24 16:04:47 +0800151 }
152
Jerry Yu305bfc32021-11-24 16:04:47 +0800153 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800154 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000155
156 if self._ciphers:
157 ciphersuites = ':'.join(self._ciphers)
158 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
159
160 if self._sig_algs:
161 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
162 signature_algorithms = ':'.join(signature_algorithms)
163 ret += ["-sigalgs {signature_algorithms}".format(
164 signature_algorithms=signature_algorithms)]
165
166 if self._named_groups:
167 named_groups = ':'.join(
168 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
169 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
170
171 ret += ['-msg -tls1_3']
172 if not self._compat_mode:
173 ret += ['-no_middlebox']
174
XiaokangQianb1847a22022-06-08 07:49:31 +0000175 return ret
176
177 def pre_checks(self):
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200178 ret = ["requires_openssl_tls1_3"]
179
180 # ffdh groups require at least openssl 3.0
Przemek Stekiel3484db42023-06-28 13:31:38 +0200181 ffdh_groups = ['ffdhe2048']
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200182
183 if any(x in ffdh_groups for x in self._named_groups):
Przemek Stekiel8bfe8972023-06-26 12:59:45 +0200184 ret = ["requires_openssl_tls1_3_with_ffdh"]
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200185
186 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000187
XiaokangQianb1847a22022-06-08 07:49:31 +0000188
189class OpenSSLServ(OpenSSLBase):
190 """
191 Generate test commands for OpenSSL server.
192 """
193
194 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800195 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000196 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800197 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000198
XiaokangQiand5d5b602022-05-23 09:16:20 +0000199 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000200 return ['-c "HTTP/1.0 200 ok"']
201
202 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800203 ret = ['$O_NEXT_SRV_NO_CERT']
204 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
205 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
206 return ret
207
208
209class OpenSSLCli(OpenSSLBase):
210 """
211 Generate test commands for OpenSSL client.
212 """
213
214 def pre_cmd(self):
215 return ['$O_NEXT_CLI_NO_CERT',
216 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000217
218
XiaokangQianb1847a22022-06-08 07:49:31 +0000219class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000220 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000221 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000222 """
223
224 CIPHER_SUITE = {
225 'TLS_AES_256_GCM_SHA384': [
226 'AES-256-GCM',
227 'SHA384',
228 'AEAD'],
229 'TLS_AES_128_GCM_SHA256': [
230 'AES-128-GCM',
231 'SHA256',
232 'AEAD'],
233 'TLS_CHACHA20_POLY1305_SHA256': [
234 'CHACHA20-POLY1305',
235 'SHA256',
236 'AEAD'],
237 'TLS_AES_128_CCM_SHA256': [
238 'AES-128-CCM',
239 'SHA256',
240 'AEAD'],
241 'TLS_AES_128_CCM_8_SHA256': [
242 'AES-128-CCM-8',
243 'SHA256',
244 'AEAD']}
245
246 SIGNATURE_ALGORITHM = {
247 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
248 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
249 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
250 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
251
252 NAMED_GROUP = {
253 'secp256r1': ['GROUP-SECP256R1'],
254 'secp384r1': ['GROUP-SECP384R1'],
255 'secp521r1': ['GROUP-SECP521R1'],
256 'x25519': ['GROUP-X25519'],
257 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200258 'ffdhe2048': ['GROUP-FFDHE2048'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000259 }
260
261 def pre_checks(self):
262 return ["requires_gnutls_tls1_3",
263 "requires_gnutls_next_no_ticket",
264 "requires_gnutls_next_disable_tls13_compat", ]
265
XiaokangQiand5d5b602022-05-23 09:16:20 +0000266 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800267 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000268
269 priority_string_list = []
270
271 def update_priority_string_list(items, map_table):
272 for item in items:
273 for i in map_table[item]:
274 if i not in priority_string_list:
275 yield i
276
277 if self._ciphers:
278 priority_string_list.extend(update_priority_string_list(
279 self._ciphers, self.CIPHER_SUITE))
280 else:
281 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
282
283 if self._sig_algs:
284 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
285 priority_string_list.extend(update_priority_string_list(
286 signature_algorithms, self.SIGNATURE_ALGORITHM))
287 else:
288 priority_string_list.append('SIGN-ALL')
289
290
291 if self._named_groups:
292 priority_string_list.extend(update_priority_string_list(
293 self._named_groups, self.NAMED_GROUP))
294 else:
295 priority_string_list.append('GROUP-ALL')
296
297 priority_string_list = ['NONE'] + \
298 priority_string_list + ['VERS-TLS1.3']
299
300 priority_string = ':+'.join(priority_string_list)
301 priority_string += ':%NO_TICKETS'
302
303 if not self._compat_mode:
304 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
305
306 ret += ['--priority={priority_string}'.format(
307 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000308 return ret
309
310class GnuTLSServ(GnuTLSBase):
311 """
312 Generate test commands for GnuTLS server.
313 """
314
Jerry Yub7c12a42022-06-12 20:53:02 +0800315 def pre_cmd(self):
316 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000317
Jerry Yub7c12a42022-06-12 20:53:02 +0800318 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
319 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
320 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000321 return ret
322
Jerry Yub7c12a42022-06-12 20:53:02 +0800323 def post_checks(self):
324 return ['-c "HTTP/1.0 200 OK"']
325
326
327class GnuTLSCli(GnuTLSBase):
328 """
329 Generate test commands for GnuTLS client.
330 """
331
XiaokangQianb1847a22022-06-08 07:49:31 +0000332 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800333 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
334 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000335
XiaokangQianb1847a22022-06-08 07:49:31 +0000336
337class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800338 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000339 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800340 """
Jerry Yu29deed42021-11-25 11:09:54 +0800341
Jerry Yu305bfc32021-11-24 16:04:47 +0800342 CIPHER_SUITE = {
343 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
344 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
345 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
346 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
347 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
348
Jerry Yu7918efe2021-12-01 15:29:10 +0800349 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800350 ret = super().cmd()
351 ret += ['debug_level=4']
352
Jerry Yu305bfc32021-11-24 16:04:47 +0800353
XiaokangQiana1931442022-03-25 11:58:22 +0000354 if self._ciphers:
355 ciphers = ','.join(
356 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
357 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800358
XiaokangQiana1931442022-03-25 11:58:22 +0000359 if self._sig_algs + self._cert_sig_algs:
360 ret += ['sig_algs={sig_algs}'.format(
361 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800362
Jerry Yu7918efe2021-12-01 15:29:10 +0800363 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000364 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800365 ret += ["curves={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000366 return ret
367
368 def pre_checks(self):
369 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200370 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000371
372 if self._compat_mode:
373 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
374
375 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
376 ret.append(
377 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200378
379 ec_groups = ['secp256r1', 'secp384r1', 'secp521r1', 'x25519', 'x448']
Przemek Stekiel3484db42023-06-28 13:31:38 +0200380 ffdh_groups = ['ffdhe2048']
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200381
382 if any(x in ec_groups for x in self._named_groups):
Przemek Stekielc31a7982023-06-27 10:53:33 +0200383 ret.append('requires_config_enabled PSA_WANT_ALG_ECDH')
384
385 if any(x in ffdh_groups for x in self._named_groups):
386 ret.append('requires_config_enabled PSA_WANT_ALG_FFDH')
Przemek Stekiel1f5c2ba2023-06-15 17:04:44 +0200387
XiaokangQianb1847a22022-06-08 07:49:31 +0000388 return ret
389
XiaokangQianb1847a22022-06-08 07:49:31 +0000390
391class MbedTLSServ(MbedTLSBase):
392 """
393 Generate test commands for mbedTLS server.
394 """
395
396 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800397 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000398 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800399 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800400
401 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000402 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800403
404 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100405 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800406 if self._ciphers:
407 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000408 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
409 self.CIPHER_SUITE[self._ciphers[0]],
410 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
411 if self._sig_algs:
412 check_strings.append(
413 "received signature algorithm: 0x{:x}".format(
414 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
415
416 for named_group in self._named_groups:
417 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
418 named_group=named_group,
419 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
420
Ronald Croneac00ad2022-09-13 10:16:31 +0200421 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000422 return ['-s "{}"'.format(i) for i in check_strings]
423
424 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800425 ret = ['$P_SRV']
426 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
427 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
428 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000429
XiaokangQian9b938b72022-06-10 03:10:59 +0000430 def hrr_post_checks(self, named_group):
431 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
432
XiaokangQianb1847a22022-06-08 07:49:31 +0000433
XiaokangQianb1847a22022-06-08 07:49:31 +0000434class MbedTLSCli(MbedTLSBase):
435 """
436 Generate test commands for mbedTLS client.
437 """
438
XiaokangQianb1847a22022-06-08 07:49:31 +0000439 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800440 return ['$P_CLI',
441 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000442
443 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000444 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000445
XiaokangQian9b938b72022-06-10 03:10:59 +0000446 def hrr_post_checks(self, named_group):
447 ret = ['-c "received HelloRetryRequest message"']
448 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000449 return ret
450
451 def post_checks(self):
452 check_strings = ["Protocol is TLSv1.3"]
453 if self._ciphers:
454 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800455 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
456 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
457 self.CIPHER_SUITE[self._ciphers[0]]))
458 if self._sig_algs:
459 check_strings.append(
460 "Certificate Verify: Signature algorithm ( {:04x} )".format(
461 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
462
463 for named_group in self._named_groups:
464 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
465 named_group=named_group,
466 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
467
468 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800469 return ['-c "{}"'.format(i) for i in check_strings]
470
Jerry Yu305bfc32021-11-24 16:04:47 +0800471
XiaokangQianb1847a22022-06-08 07:49:31 +0000472SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
473CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800474
475
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200476def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800477 """
478 Generate test case with `ssl-opt.sh` format.
479 """
Jerry Yudda036d2021-11-30 11:19:41 +0800480 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200481 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800482
483 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
484 named_group=named_group,
485 signature_algorithm=sig_alg,
486 cert_sig_alg=sig_alg)
487 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
488 named_group=named_group,
489 signature_algorithm=sig_alg,
490 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800491
Jerry Yub7c12a42022-06-12 20:53:02 +0800492 cmd = ['run_test "{}"'.format(name),
493 '"{}"'.format(' '.join(server_object.cmd())),
494 '"{}"'.format(' '.join(client_object.cmd())),
495 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000496 cmd += server_object.post_checks()
497 cmd += client_object.post_checks()
498 cmd += ['-C "received HelloRetryRequest message"']
499 prefix = ' \\\n' + (' '*9)
500 cmd = prefix.join(cmd)
501 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
502
503
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200504def generate_hrr_compat_test(client=None, server=None,
505 client_named_group=None, server_named_group=None,
506 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000507 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000508 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000509 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000510 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000511 client=client, server=server, c_named_group=client_named_group,
512 s_named_group=server_named_group)
513 server_object = SERVER_CLASSES[server](named_group=server_named_group,
514 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000515
XiaokangQian2e17fb82022-03-28 03:30:05 +0000516 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
517 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000518 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000519
Jerry Yub7c12a42022-06-12 20:53:02 +0800520 cmd = ['run_test "{}"'.format(name),
521 '"{}"'.format(' '.join(server_object.cmd())),
522 '"{}"'.format(' '.join(client_object.cmd())),
523 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000524 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000525 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000526 cmd += server_object.hrr_post_checks(server_named_group)
527 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000528 prefix = ' \\\n' + (' '*9)
529 cmd = prefix.join(cmd)
530 return '\n'.join(server_object.pre_checks() +
531 client_object.pre_checks() +
532 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800533
534SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800535
536# {filename}
537#
538# Copyright The Mbed TLS Contributors
539# SPDX-License-Identifier: Apache-2.0
540#
541# Licensed under the Apache License, Version 2.0 (the "License"); you may
542# not use this file except in compliance with the License.
543# You may obtain a copy of the License at
544#
545# http://www.apache.org/licenses/LICENSE-2.0
546#
547# Unless required by applicable law or agreed to in writing, software
548# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
549# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
550# See the License for the specific language governing permissions and
551# limitations under the License.
552#
553# Purpose
554#
555# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000556# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800557#
558# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
559# AND REGENERATE THIS FILE.
560#
561'''
Jerry Yu29deed42021-11-25 11:09:54 +0800562
Jerry Yu305bfc32021-11-24 16:04:47 +0800563def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800564 """
565 Main function of this program
566 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800567 parser = argparse.ArgumentParser()
568
Jerry Yucdcb6832021-11-29 16:50:13 +0800569 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800570 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800571
Jerry Yuc4aa1522021-11-26 11:13:58 +0800572 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
573 default=False, help='Generate all available tls13 compat tests')
574
Jerry Yu305bfc32021-11-24 16:04:47 +0800575 parser.add_argument('--list-ciphers', action='store_true',
576 default=False, help='List supported ciphersuites')
577
578 parser.add_argument('--list-sig-algs', action='store_true',
579 default=False, help='List supported signature algorithms')
580
581 parser.add_argument('--list-named-groups', action='store_true',
582 default=False, help='List supported named groups')
583
584 parser.add_argument('--list-servers', action='store_true',
585 default=False, help='List supported TLS servers')
586
587 parser.add_argument('--list-clients', action='store_true',
588 default=False, help='List supported TLS Clients')
589
Jerry Yub4ac8f32021-12-01 10:41:37 +0800590 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
591 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800592 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800593 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
594 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800595 help='Choose TLS client program for test')
596 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
597 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
598 help='Choose cipher suite for test')
599 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
600 default=list(SIG_ALG_IANA_VALUE.keys())[0],
601 help='Choose cipher suite for test')
602 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
603 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
604 help='Choose cipher suite for test')
605
606 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800607
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800608 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800609 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200610 for client, server, cipher, named_group, sig_alg in \
611 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800612 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200613 CIPHER_SUITE_IANA_VALUE.keys(),
614 NAMED_GROUP_IANA_VALUE.keys(),
615 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000616 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000617 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000618 cipher=cipher, named_group=named_group,
619 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000620
XiaokangQiand5d5b602022-05-23 09:16:20 +0000621
XiaokangQiana1931442022-03-25 11:58:22 +0000622 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000623 for client, server, client_named_group, server_named_group in \
624 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000625 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000626 NAMED_GROUP_IANA_VALUE.keys(),
627 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800628
XiaokangQian9b938b72022-06-10 03:10:59 +0000629 if (client == 'mbedTLS' or server == 'mbedTLS') and \
630 client_named_group != server_named_group:
631 yield generate_hrr_compat_test(client=client, server=server,
632 client_named_group=client_named_group,
633 server_named_group=server_named_group,
634 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000635
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800636 if args.generate_all_tls13_compat_tests:
637 if args.output:
638 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800639 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000640 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800641 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800642 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800643 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800644 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800645 return 0
646
Jerry Yu305bfc32021-11-24 16:04:47 +0800647 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800648 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800649 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800650 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800651 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800652 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800653 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800654 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800655 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800656 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800657 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800658 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800659 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800660
XiaokangQiana1931442022-03-25 11:58:22 +0000661 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
662 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800663 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800664
Jerry Yu29deed42021-11-25 11:09:54 +0800665
Jerry Yu305bfc32021-11-24 16:04:47 +0800666if __name__ == "__main__":
667 sys.exit(main())