blob: 808fbed3c6a3779e881f98d71862a60c5d26d560 [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 abc
28import argparse
Jerry Yuc4aa1522021-11-26 11:13:58 +080029import itertools
Jerry Yu882c30d2021-12-01 10:59:59 +080030from collections import namedtuple
Jerry Yu305bfc32021-11-24 16:04:47 +080031
Jerry Yu882c30d2021-12-01 10:59:59 +080032# define certificates configuration entry
33Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile'])
34# define the certificate parameters for signature algorithms
Jerry Yu305bfc32021-11-24 16:04:47 +080035CERTIFICATES = {
Jerry Yu882c30d2021-12-01 10:59:59 +080036 'ecdsa_secp256r1_sha256': Certificate('data_files/test-ca2.crt',
37 'data_files/ecdsa_secp256r1.crt',
38 'data_files/ecdsa_secp256r1.key'),
39 'ecdsa_secp384r1_sha384': Certificate('data_files/test-ca2.crt',
40 'data_files/ecdsa_secp384r1.crt',
41 'data_files/ecdsa_secp384r1.key'),
42 'ecdsa_secp521r1_sha512': Certificate('data_files/test-ca2.crt',
43 'data_files/ecdsa_secp521r1.crt',
44 'data_files/ecdsa_secp521r1.key'),
45 'rsa_pss_rsae_sha256': Certificate('data_files/test-ca_cat12.crt',
46 'data_files/server2-sha256.crt', 'data_files/server2.key'
47 )
Jerry Yu29deed42021-11-25 11:09:54 +080048}
Jerry Yu305bfc32021-11-24 16:04:47 +080049
50CIPHER_SUITE_IANA_VALUE = {
51 "TLS_AES_128_GCM_SHA256": 0x1301,
52 "TLS_AES_256_GCM_SHA384": 0x1302,
53 "TLS_CHACHA20_POLY1305_SHA256": 0x1303,
54 "TLS_AES_128_CCM_SHA256": 0x1304,
55 "TLS_AES_128_CCM_8_SHA256": 0x1305
56}
57
58SIG_ALG_IANA_VALUE = {
59 "ecdsa_secp256r1_sha256": 0x0403,
60 "ecdsa_secp384r1_sha384": 0x0503,
61 "ecdsa_secp521r1_sha512": 0x0603,
Jerry Yu29deed42021-11-25 11:09:54 +080062 'rsa_pss_rsae_sha256': 0x0804,
Jerry Yu305bfc32021-11-24 16:04:47 +080063}
64
65NAMED_GROUP_IANA_VALUE = {
66 'secp256r1': 0x17,
67 'secp384r1': 0x18,
68 'secp521r1': 0x19,
69 'x25519': 0x1d,
70 'x448': 0x1e,
71}
72
XiaokangQian68a87e42022-03-17 06:06:07 +000073
Jerry Yu305bfc32021-11-24 16:04:47 +080074class TLSProgram(metaclass=abc.ABCMeta):
75 """
76 Base class for generate server/client command.
77 """
Jerry Yu7de79852022-03-23 16:50:47 +080078 # pylint: disable=too-many-arguments
XiaokangQiana1931442022-03-25 11:58:22 +000079 def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None,
80 cert_sig_alg=None, compat_mode=True):
Jerry Yu7918efe2021-12-01 15:29:10 +080081 self._ciphers = []
82 self._sig_algs = []
83 self._named_groups = []
Jerry Yu7de79852022-03-23 16:50:47 +080084 self._cert_sig_algs = []
85 if ciphersuite:
86 self.add_ciphersuites(ciphersuite)
87 if named_group:
88 self.add_named_groups(named_group)
89 if signature_algorithm:
90 self.add_signature_algorithms(signature_algorithm)
91 if cert_sig_alg:
92 self.add_cert_signature_algorithms(cert_sig_alg)
Ronald Cronae937252021-12-10 09:55:15 +010093 self._compat_mode = compat_mode
Jerry Yu305bfc32021-11-24 16:04:47 +080094
Jerry Yu7918efe2021-12-01 15:29:10 +080095 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +080096 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +080097 self._ciphers.extend(
98 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +080099
Jerry Yu7918efe2021-12-01 15:29:10 +0800100 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800101 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +0800102 self._sig_algs.extend(
103 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +0800104
Jerry Yu7de79852022-03-23 16:50:47 +0800105 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800106 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +0800107 self._named_groups.extend(
108 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +0800109
Jerry Yu7de79852022-03-23 16:50:47 +0800110 # add_cert_signature_algorithms should not override by sub class
111 def add_cert_signature_algorithms(self, *signature_algorithms):
112 self._cert_sig_algs.extend(
113 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
114
Jerry Yu305bfc32021-11-24 16:04:47 +0800115 @abc.abstractmethod
116 def pre_checks(self):
117 return []
118
119 @abc.abstractmethod
120 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800121 if not self._cert_sig_algs:
122 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800123
124 @abc.abstractmethod
125 def post_checks(self):
126 return []
127
XiaokangQianb1847a22022-06-08 07:49:31 +0000128 def pre_cmd(self):
129 return []
Jerry Yu305bfc32021-11-24 16:04:47 +0800130
XiaokangQianb1847a22022-06-08 07:49:31 +0000131
132class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800133 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000134 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800135 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800136
137 NAMED_GROUP = {
138 'secp256r1': 'P-256',
139 'secp384r1': 'P-384',
140 'secp521r1': 'P-521',
141 'x25519': 'X25519',
142 'x448': 'X448',
143 }
144
Jerry Yu305bfc32021-11-24 16:04:47 +0800145 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800146 super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000147 ret = []
Jerry Yu7de79852022-03-23 16:50:47 +0800148 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
Jerry Yu305bfc32021-11-24 16:04:47 +0800149 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000150
151 if self._ciphers:
152 ciphersuites = ':'.join(self._ciphers)
153 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
154
155 if self._sig_algs:
156 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
157 signature_algorithms = ':'.join(signature_algorithms)
158 ret += ["-sigalgs {signature_algorithms}".format(
159 signature_algorithms=signature_algorithms)]
160
161 if self._named_groups:
162 named_groups = ':'.join(
163 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
164 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
165
166 ret += ['-msg -tls1_3']
167 if not self._compat_mode:
168 ret += ['-no_middlebox']
169
XiaokangQianb1847a22022-06-08 07:49:31 +0000170#return ' '.join(ret)
171 return ret
172
173 def pre_checks(self):
174 return ["requires_openssl_tls1_3"]
175
176 def post_checks(self):
177 return []
178
179
180class OpenSSLServ(OpenSSLBase):
181 """
182 Generate test commands for OpenSSL server.
183 """
184
185 def cmd(self):
186 ret = super().cmd()
187 ret += ['-accept $SRV_PORT']
188
189 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
190
XiaokangQiand5d5b602022-05-23 09:16:20 +0000191 return ' '.join(ret)
192
193 def pre_checks(self):
194 return ["requires_openssl_tls1_3"]
195
196 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000197 return ['-c "HTTP/1.0 200 ok"']
198
199 def pre_cmd(self):
200 return '$O_NEXT_SRV_NO_CERT'
XiaokangQiand5d5b602022-05-23 09:16:20 +0000201
202
XiaokangQianb1847a22022-06-08 07:49:31 +0000203class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000204 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000205 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000206 """
207
208 CIPHER_SUITE = {
209 'TLS_AES_256_GCM_SHA384': [
210 'AES-256-GCM',
211 'SHA384',
212 'AEAD'],
213 'TLS_AES_128_GCM_SHA256': [
214 'AES-128-GCM',
215 'SHA256',
216 'AEAD'],
217 'TLS_CHACHA20_POLY1305_SHA256': [
218 'CHACHA20-POLY1305',
219 'SHA256',
220 'AEAD'],
221 'TLS_AES_128_CCM_SHA256': [
222 'AES-128-CCM',
223 'SHA256',
224 'AEAD'],
225 'TLS_AES_128_CCM_8_SHA256': [
226 'AES-128-CCM-8',
227 'SHA256',
228 'AEAD']}
229
230 SIGNATURE_ALGORITHM = {
231 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
232 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
233 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
234 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
235
236 NAMED_GROUP = {
237 'secp256r1': ['GROUP-SECP256R1'],
238 'secp384r1': ['GROUP-SECP384R1'],
239 'secp521r1': ['GROUP-SECP521R1'],
240 'x25519': ['GROUP-X25519'],
241 'x448': ['GROUP-X448'],
242 }
243
244 def pre_checks(self):
245 return ["requires_gnutls_tls1_3",
246 "requires_gnutls_next_no_ticket",
247 "requires_gnutls_next_disable_tls13_compat", ]
248
249 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000250 return []
XiaokangQiand5d5b602022-05-23 09:16:20 +0000251
252 def cmd(self):
253 super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000254 ret = []
XiaokangQiand5d5b602022-05-23 09:16:20 +0000255
256 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
257 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
258 cert=cert, key=key)]
259
260 priority_string_list = []
261
262 def update_priority_string_list(items, map_table):
263 for item in items:
264 for i in map_table[item]:
265 if i not in priority_string_list:
266 yield i
267
268 if self._ciphers:
269 priority_string_list.extend(update_priority_string_list(
270 self._ciphers, self.CIPHER_SUITE))
271 else:
272 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
273
274 if self._sig_algs:
275 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
276 priority_string_list.extend(update_priority_string_list(
277 signature_algorithms, self.SIGNATURE_ALGORITHM))
278 else:
279 priority_string_list.append('SIGN-ALL')
280
281
282 if self._named_groups:
283 priority_string_list.extend(update_priority_string_list(
284 self._named_groups, self.NAMED_GROUP))
285 else:
286 priority_string_list.append('GROUP-ALL')
287
288 priority_string_list = ['NONE'] + \
289 priority_string_list + ['VERS-TLS1.3']
290
291 priority_string = ':+'.join(priority_string_list)
292 priority_string += ':%NO_TICKETS'
293
294 if not self._compat_mode:
295 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
296
297 ret += ['--priority={priority_string}'.format(
298 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000299#ret = ' '.join(ret)
300 return ret
301
302class GnuTLSServ(GnuTLSBase):
303 """
304 Generate test commands for GnuTLS server.
305 """
306
307 def pre_checks(self):
308 return ["requires_gnutls_tls1_3",
309 "requires_gnutls_next_no_ticket",
310 "requires_gnutls_next_disable_tls13_compat", ]
311
312 def post_checks(self):
313 return ['-c "HTTP/1.0 200 OK"']
314
315 def cmd(self):
316 ret = super().cmd()
317 ret += ['--http',
318 '--disable-client-cert', '--debug=4']
319
XiaokangQiand5d5b602022-05-23 09:16:20 +0000320 ret = ' '.join(ret)
321 return ret
322
XiaokangQianb1847a22022-06-08 07:49:31 +0000323 def pre_cmd(self):
324 return '$G_NEXT_SRV_NO_CERT'
XiaokangQiand5d5b602022-05-23 09:16:20 +0000325
XiaokangQianb1847a22022-06-08 07:49:31 +0000326
327class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800328 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000329 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800330 """
Jerry Yu29deed42021-11-25 11:09:54 +0800331
Jerry Yu305bfc32021-11-24 16:04:47 +0800332 CIPHER_SUITE = {
333 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
334 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
335 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
336 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
337 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
338
Jerry Yu7918efe2021-12-01 15:29:10 +0800339 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800340 super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000341 ret = ['server_addr=127.0.0.1', 'server_port=$SRV_PORT',
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100342 'debug_level=4']
Jerry Yu7918efe2021-12-01 15:29:10 +0800343 ret += ['ca_file={cafile}'.format(
Jerry Yu7de79852022-03-23 16:50:47 +0800344 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800345
XiaokangQiana1931442022-03-25 11:58:22 +0000346 if self._ciphers:
347 ciphers = ','.join(
348 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
349 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800350
XiaokangQiana1931442022-03-25 11:58:22 +0000351 if self._sig_algs + self._cert_sig_algs:
352 ret += ['sig_algs={sig_algs}'.format(
353 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800354
Jerry Yu7918efe2021-12-01 15:29:10 +0800355 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000356 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800357 ret += ["curves={named_groups}".format(named_groups=named_groups)]
358
XiaokangQianb1847a22022-06-08 07:49:31 +0000359#ret = ' '.join(ret)
360 return ret
361
362 def pre_checks(self):
363 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
364 'requires_config_enabled MBEDTLS_SSL_CLI_C',
365 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
366
367 if self._compat_mode:
368 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
369
370 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
371 ret.append(
372 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
373 return ret
374
375 def post_checks(self):
376 return []
377
378
379class MbedTLSServ(MbedTLSBase):
380 """
381 Generate test commands for mbedTLS server.
382 """
383
384 def cmd(self):
385 ret = super().cmd()
386 ret += ['force_version=tls13']
387 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
388 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
389
390 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800391 ret = ' '.join(ret)
392 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800393
394 def pre_checks(self):
Jerry Yu29deed42021-11-25 11:09:54 +0800395 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
396 'requires_config_enabled MBEDTLS_SSL_CLI_C',
Ronald Cron135427c2022-01-07 22:14:24 +0100397 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
Ronald Cronae937252021-12-10 09:55:15 +0100398
399 if self._compat_mode:
400 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
401
Jerry Yu7de79852022-03-23 16:50:47 +0800402 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
Jerry Yu29deed42021-11-25 11:09:54 +0800403 ret.append(
404 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
405 return ret
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
424 check_strings.append("Verifying peer X.509 certificate... ok")
425 return ['-s "{}"'.format(i) for i in check_strings]
426
427 def pre_cmd(self):
428 return '$P_SRV_NO_CERT'
429
430
431class OpenSSLCli(OpenSSLBase):
432 """
433 Generate test commands for OpenSSL client.
434 """
435
436 def cmd(self):
437 ret = super().cmd()
438
439 ret += ['-CAfile {cafile}'.format(
440 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
441
442 return ' '.join(ret)
443
444 def pre_checks(self):
445 return ["requires_openssl_tls1_3"]
446
447 def post_checks(self):
448 return ['-s "HTTP/1.0 200 OK"']
449
450 def pre_cmd(self):
451 return '$O_NEXT_CLI_NO_CERT'
452
453
454class GnuTLSCli(GnuTLSBase):
455 """
456 Generate test commands for GnuTLS client.
457 """
458
459 def pre_checks(self):
460 return ["requires_gnutls_tls1_3",
461 "requires_gnutls_next_no_ticket",
462 "requires_gnutls_next_disable_tls13_compat", ]
463
464 def post_checks(self):
465 return ['-c "HTTP/1.0 200 OK"']
466
467 def cmd(self):
468 ret = super().cmd()
469 ret += ['--debug=4']
470 ret += ['localhost', '-p $SRV_PORT', '--single-key-share']
471 ret += ['--x509cafile {cafile}'.format(
472 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
473
474 ret = ' '.join(ret)
475 return ret
476
477 def pre_cmd(self):
478 return '$G_NEXT_CLI_NO_CERT'
479
480
481class MbedTLSCli(MbedTLSBase):
482 """
483 Generate test commands for mbedTLS client.
484 """
485
486 def cmd(self):
487 ret = super().cmd()
488
489 ret = ' '.join(ret)
490 return ret
491
492 def pre_cmd(self):
493 return '$P_CLI'
494
495 def pre_checks(self):
496 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
497 'requires_config_enabled MBEDTLS_SSL_CLI_C',
498 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
499
500 if self._compat_mode:
501 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
502
503 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
504 ret.append(
505 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
506 return ret
507
508 def post_checks(self):
509 check_strings = ["Protocol is TLSv1.3"]
510 if self._ciphers:
511 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800512 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
513 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
514 self.CIPHER_SUITE[self._ciphers[0]]))
515 if self._sig_algs:
516 check_strings.append(
517 "Certificate Verify: Signature algorithm ( {:04x} )".format(
518 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
519
520 for named_group in self._named_groups:
521 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
522 named_group=named_group,
523 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
524
525 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800526 return ['-c "{}"'.format(i) for i in check_strings]
527
Jerry Yu305bfc32021-11-24 16:04:47 +0800528
XiaokangQianb1847a22022-06-08 07:49:31 +0000529SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
530CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800531
532
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200533def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800534 """
535 Generate test case with `ssl-opt.sh` format.
536 """
Jerry Yudda036d2021-11-30 11:19:41 +0800537 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200538 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800539
540 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
541 named_group=named_group,
542 signature_algorithm=sig_alg,
543 cert_sig_alg=sig_alg)
544 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
545 named_group=named_group,
546 signature_algorithm=sig_alg,
547 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800548
XiaokangQianb1847a22022-06-08 07:49:31 +0000549 cmd = ['run_test "{}"'.format(name), '"{} {}"'.format(server_object.pre_cmd(),
550 server_object.cmd()), '"{} {}"'.format(client_object.pre_cmd(), client_object.cmd()), '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000551 cmd += server_object.post_checks()
552 cmd += client_object.post_checks()
553 cmd += ['-C "received HelloRetryRequest message"']
554 prefix = ' \\\n' + (' '*9)
555 cmd = prefix.join(cmd)
556 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
557
558
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200559def generate_hrr_compat_test(client=None, server=None,
560 client_named_group=None, server_named_group=None,
561 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000562 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000563 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000564 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000565 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000566 client=client, server=server, c_named_group=client_named_group,
567 s_named_group=server_named_group)
568 server_object = SERVER_CLASSES[server](named_group=server_named_group,
569 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000570
XiaokangQian2e17fb82022-03-28 03:30:05 +0000571 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
572 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000573 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000574
XiaokangQianb1847a22022-06-08 07:49:31 +0000575 cmd = ['run_test "{}"'.format(name), '"{} {}"'.format(server_object.pre_cmd(),
576 server_object.cmd()), '"{} {}"'.format(client_object.pre_cmd(), client_object.cmd()), '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000577 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000578 cmd += client_object.post_checks()
579 cmd += ['-c "received HelloRetryRequest message"']
580 cmd += ['-c "selected_group ( {:d} )"'.format(
581 NAMED_GROUP_IANA_VALUE[server_named_group])]
XiaokangQian7069cbc2022-02-24 08:30:39 +0000582 prefix = ' \\\n' + (' '*9)
583 cmd = prefix.join(cmd)
XiaokangQiana1931442022-03-25 11:58:22 +0000584 return '\n'.join(server_object.pre_checks() +
585 client_object.pre_checks() +
586 [cmd])
XiaokangQian7069cbc2022-02-24 08:30:39 +0000587
XiaokangQiand5d5b602022-05-23 09:16:20 +0000588def generate_server_hrr_compat_test(client=None, server=None,
589 client_named_group=None, server_named_group=None,
590 cert_sig_alg=None):
591 """
592 Generate server side Hello Retry Request test case with `ssl-opt.sh` format.
593 """
594 name = 'TLS 1.3 {client[0]}->{server[0]}: Server HRR {c_named_group} -> {s_named_group}'.format(
595 client=client, server=server, c_named_group=client_named_group,
596 s_named_group=server_named_group)
XiaokangQianb1847a22022-06-08 07:49:31 +0000597 server_object = SERVER_CLASSES[server](named_group=server_named_group,
XiaokangQiand5d5b602022-05-23 09:16:20 +0000598 cert_sig_alg=cert_sig_alg)
599
XiaokangQianb1847a22022-06-08 07:49:31 +0000600 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
XiaokangQiand5d5b602022-05-23 09:16:20 +0000601 cert_sig_alg=cert_sig_alg)
602 client_object.add_named_groups(server_named_group)
603
XiaokangQianb1847a22022-06-08 07:49:31 +0000604 cmd = ['run_test "{}"'.format(name), '"{} {}"'.format(server_object.pre_cmd(),
605 server_object.cmd()), '"{} {}"'.format(client_object.pre_cmd(), client_object.cmd()), '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000606 cmd += server_object.post_checks()
607 cmd += client_object.post_checks()
608 cmd += ['-s "HRR selected_group: {:s}"'.format(server_named_group)]
609 prefix = ' \\\n' + (' '*9)
610 cmd = prefix.join(cmd)
611 return '\n'.join(server_object.pre_checks() +
612 client_object.pre_checks() +
613 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800614
615SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800616
617# {filename}
618#
619# Copyright The Mbed TLS Contributors
620# SPDX-License-Identifier: Apache-2.0
621#
622# Licensed under the Apache License, Version 2.0 (the "License"); you may
623# not use this file except in compliance with the License.
624# You may obtain a copy of the License at
625#
626# http://www.apache.org/licenses/LICENSE-2.0
627#
628# Unless required by applicable law or agreed to in writing, software
629# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
630# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
631# See the License for the specific language governing permissions and
632# limitations under the License.
633#
634# Purpose
635#
636# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000637# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800638#
639# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
640# AND REGENERATE THIS FILE.
641#
642'''
Jerry Yu29deed42021-11-25 11:09:54 +0800643
Jerry Yu305bfc32021-11-24 16:04:47 +0800644def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800645 """
646 Main function of this program
647 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800648 parser = argparse.ArgumentParser()
649
Jerry Yucdcb6832021-11-29 16:50:13 +0800650 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800651 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800652
Jerry Yuc4aa1522021-11-26 11:13:58 +0800653 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
654 default=False, help='Generate all available tls13 compat tests')
655
Jerry Yu305bfc32021-11-24 16:04:47 +0800656 parser.add_argument('--list-ciphers', action='store_true',
657 default=False, help='List supported ciphersuites')
658
659 parser.add_argument('--list-sig-algs', action='store_true',
660 default=False, help='List supported signature algorithms')
661
662 parser.add_argument('--list-named-groups', action='store_true',
663 default=False, help='List supported named groups')
664
665 parser.add_argument('--list-servers', action='store_true',
666 default=False, help='List supported TLS servers')
667
668 parser.add_argument('--list-clients', action='store_true',
669 default=False, help='List supported TLS Clients')
670
Jerry Yub4ac8f32021-12-01 10:41:37 +0800671 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
672 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800673 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800674 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
675 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800676 help='Choose TLS client program for test')
677 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
678 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
679 help='Choose cipher suite for test')
680 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
681 default=list(SIG_ALG_IANA_VALUE.keys())[0],
682 help='Choose cipher suite for test')
683 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
684 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
685 help='Choose cipher suite for test')
686
687 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800688
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800689 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800690 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200691 for client, server, cipher, named_group, sig_alg in \
692 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800693 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200694 CIPHER_SUITE_IANA_VALUE.keys(),
695 NAMED_GROUP_IANA_VALUE.keys(),
696 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianb1847a22022-06-08 07:49:31 +0000697 if(server == 'mbedTLS' or client == 'mbedTLS'):
698 yield generate_compat_test(client=client, server=server,
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200699 cipher=cipher, named_group=named_group,
700 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000701
XiaokangQiand5d5b602022-05-23 09:16:20 +0000702
XiaokangQiana1931442022-03-25 11:58:22 +0000703 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000704 for client, server, client_named_group, server_named_group in \
705 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000706 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000707 NAMED_GROUP_IANA_VALUE.keys(),
708 NAMED_GROUP_IANA_VALUE.keys()):
XiaokangQianb1847a22022-06-08 07:49:31 +0000709 if(client == 'mbedTLS'):
710 if client_named_group != server_named_group:
711 yield generate_hrr_compat_test(client=client, server=server,
XiaokangQian2e17fb82022-03-28 03:30:05 +0000712 client_named_group=client_named_group,
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200713 server_named_group=server_named_group,
714 cert_sig_alg="ecdsa_secp256r1_sha256")
Jerry Yu7de79852022-03-23 16:50:47 +0800715
XiaokangQiand5d5b602022-05-23 09:16:20 +0000716 for client, server, client_named_group, server_named_group in \
XiaokangQianb1847a22022-06-08 07:49:31 +0000717 itertools.product(CLIENT_CLASSES.keys(),
718 SERVER_CLASSES.keys(),
XiaokangQiand5d5b602022-05-23 09:16:20 +0000719 NAMED_GROUP_IANA_VALUE.keys(),
720 NAMED_GROUP_IANA_VALUE.keys()):
XiaokangQianb1847a22022-06-08 07:49:31 +0000721 if(server == 'mbedTLS'):
722 if client_named_group != server_named_group:
723 yield generate_server_hrr_compat_test(client=client, server=server,
724 client_named_group=client_named_group,
725 server_named_group=server_named_group,
726 cert_sig_alg="ecdsa_secp256r1_sha256")
727
XiaokangQiand5d5b602022-05-23 09:16:20 +0000728
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800729 if args.generate_all_tls13_compat_tests:
730 if args.output:
731 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800732 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000733 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800734 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800735 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800736 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800737 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800738 return 0
739
Jerry Yu305bfc32021-11-24 16:04:47 +0800740 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800741 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800742 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800743 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800744 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800745 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800746 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800747 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800748 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800749 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800750 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800751 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800752 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800753
XiaokangQiana1931442022-03-25 11:58:22 +0000754 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
755 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800756 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800757
Jerry Yu29deed42021-11-25 11:09:54 +0800758
Jerry Yu305bfc32021-11-24 16:04:47 +0800759if __name__ == "__main__":
760 sys.exit(main())