blob: c3bfe1b4da9c7e9b25f6187a0a28699b0d36a90d [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
XiaokangQian9b938b72022-06-10 03:10:59 +0000128 @abc.abstractmethod
XiaokangQianb1847a22022-06-08 07:49:31 +0000129 def pre_cmd(self):
130 return []
Jerry Yu305bfc32021-11-24 16:04:47 +0800131
XiaokangQian9b938b72022-06-10 03:10:59 +0000132 @abc.abstractmethod
133 def hrr_post_checks(self, named_group):
134 return []
135
XiaokangQianb1847a22022-06-08 07:49:31 +0000136
137class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800138 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000139 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800140 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800141
142 NAMED_GROUP = {
143 'secp256r1': 'P-256',
144 'secp384r1': 'P-384',
145 'secp521r1': 'P-521',
146 'x25519': 'X25519',
147 'x448': 'X448',
148 }
149
Jerry Yu305bfc32021-11-24 16:04:47 +0800150 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800151 super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000152 ret = []
Jerry Yu7de79852022-03-23 16:50:47 +0800153 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
Jerry Yu305bfc32021-11-24 16:04:47 +0800154 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
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):
178 return ["requires_openssl_tls1_3"]
179
180 def post_checks(self):
181 return []
182
XiaokangQian9b938b72022-06-10 03:10:59 +0000183 def pre_cmd(self):
184 return []
185
186 def hrr_post_checks(self, named_group):
187 return []
188
XiaokangQianb1847a22022-06-08 07:49:31 +0000189
190class OpenSSLServ(OpenSSLBase):
191 """
192 Generate test commands for OpenSSL server.
193 """
194
195 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000196 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000197 ret += ['-accept $SRV_PORT']
198
199 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
200
XiaokangQiand5d5b602022-05-23 09:16:20 +0000201 return ' '.join(ret)
202
XiaokangQiand5d5b602022-05-23 09:16:20 +0000203 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000204 return ['-c "HTTP/1.0 200 ok"']
205
206 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000207 return ['$O_NEXT_SRV_NO_CERT']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000208
209
XiaokangQianb1847a22022-06-08 07:49:31 +0000210class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000211 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000212 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000213 """
214
215 CIPHER_SUITE = {
216 'TLS_AES_256_GCM_SHA384': [
217 'AES-256-GCM',
218 'SHA384',
219 'AEAD'],
220 'TLS_AES_128_GCM_SHA256': [
221 'AES-128-GCM',
222 'SHA256',
223 'AEAD'],
224 'TLS_CHACHA20_POLY1305_SHA256': [
225 'CHACHA20-POLY1305',
226 'SHA256',
227 'AEAD'],
228 'TLS_AES_128_CCM_SHA256': [
229 'AES-128-CCM',
230 'SHA256',
231 'AEAD'],
232 'TLS_AES_128_CCM_8_SHA256': [
233 'AES-128-CCM-8',
234 'SHA256',
235 'AEAD']}
236
237 SIGNATURE_ALGORITHM = {
238 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
239 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
240 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
241 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
242
243 NAMED_GROUP = {
244 'secp256r1': ['GROUP-SECP256R1'],
245 'secp384r1': ['GROUP-SECP384R1'],
246 'secp521r1': ['GROUP-SECP521R1'],
247 'x25519': ['GROUP-X25519'],
248 'x448': ['GROUP-X448'],
249 }
250
251 def pre_checks(self):
252 return ["requires_gnutls_tls1_3",
253 "requires_gnutls_next_no_ticket",
254 "requires_gnutls_next_disable_tls13_compat", ]
255
256 def post_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000257 return ['-c "HTTP/1.0 200 OK"']
258
259 def hrr_post_checks(self, named_group):
260 return []
261
262 def pre_cmd(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000263 return []
XiaokangQiand5d5b602022-05-23 09:16:20 +0000264
265 def cmd(self):
266 super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000267 ret = []
XiaokangQiand5d5b602022-05-23 09:16:20 +0000268
269 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
270 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
271 cert=cert, key=key)]
272
273 priority_string_list = []
274
275 def update_priority_string_list(items, map_table):
276 for item in items:
277 for i in map_table[item]:
278 if i not in priority_string_list:
279 yield i
280
281 if self._ciphers:
282 priority_string_list.extend(update_priority_string_list(
283 self._ciphers, self.CIPHER_SUITE))
284 else:
285 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
286
287 if self._sig_algs:
288 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
289 priority_string_list.extend(update_priority_string_list(
290 signature_algorithms, self.SIGNATURE_ALGORITHM))
291 else:
292 priority_string_list.append('SIGN-ALL')
293
294
295 if self._named_groups:
296 priority_string_list.extend(update_priority_string_list(
297 self._named_groups, self.NAMED_GROUP))
298 else:
299 priority_string_list.append('GROUP-ALL')
300
301 priority_string_list = ['NONE'] + \
302 priority_string_list + ['VERS-TLS1.3']
303
304 priority_string = ':+'.join(priority_string_list)
305 priority_string += ':%NO_TICKETS'
306
307 if not self._compat_mode:
308 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
309
310 ret += ['--priority={priority_string}'.format(
311 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000312 return ret
313
314class GnuTLSServ(GnuTLSBase):
315 """
316 Generate test commands for GnuTLS server.
317 """
318
XiaokangQianb1847a22022-06-08 07:49:31 +0000319 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000320 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000321
XiaokangQiand5d5b602022-05-23 09:16:20 +0000322 ret = ' '.join(ret)
323 return ret
324
XiaokangQianb1847a22022-06-08 07:49:31 +0000325 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000326 return ['$G_NEXT_SRV_NO_CERT'] + ['--http', '--disable-client-cert', '--debug=4']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000327
XiaokangQianb1847a22022-06-08 07:49:31 +0000328
329class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800330 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000331 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800332 """
Jerry Yu29deed42021-11-25 11:09:54 +0800333
Jerry Yu305bfc32021-11-24 16:04:47 +0800334 CIPHER_SUITE = {
335 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
336 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
337 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
338 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
339 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
340
Jerry Yu7918efe2021-12-01 15:29:10 +0800341 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800342 super().cmd()
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000343 ret = ['server_addr=127.0.0.1', 'server_port=$SRV_PORT', 'debug_level=4']
Jerry Yu7918efe2021-12-01 15:29:10 +0800344 ret += ['ca_file={cafile}'.format(
Jerry Yu7de79852022-03-23 16:50:47 +0800345 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800346
XiaokangQiana1931442022-03-25 11:58:22 +0000347 if self._ciphers:
348 ciphers = ','.join(
349 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
350 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800351
XiaokangQiana1931442022-03-25 11:58:22 +0000352 if self._sig_algs + self._cert_sig_algs:
353 ret += ['sig_algs={sig_algs}'.format(
354 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800355
Jerry Yu7918efe2021-12-01 15:29:10 +0800356 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000357 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800358 ret += ["curves={named_groups}".format(named_groups=named_groups)]
359
XiaokangQianb1847a22022-06-08 07:49:31 +0000360 return ret
361
362 def pre_checks(self):
363 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
XiaokangQianb1847a22022-06-08 07:49:31 +0000364 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
365
366 if self._compat_mode:
367 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
368
369 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
370 ret.append(
371 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
372 return ret
373
374 def post_checks(self):
375 return []
376
XiaokangQian9b938b72022-06-10 03:10:59 +0000377 def pre_cmd(self):
378 return []
379
380 def hrr_post_checks(self, named_group):
381 return []
382
XiaokangQianb1847a22022-06-08 07:49:31 +0000383
384class MbedTLSServ(MbedTLSBase):
385 """
386 Generate test commands for mbedTLS server.
387 """
388
389 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000390 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000391 ret += ['force_version=tls13']
392 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
393 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
394
395 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800396 ret = ' '.join(ret)
397 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800398
399 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000400 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800401
402 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100403 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800404 if self._ciphers:
405 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000406 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
407 self.CIPHER_SUITE[self._ciphers[0]],
408 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
409 if self._sig_algs:
410 check_strings.append(
411 "received signature algorithm: 0x{:x}".format(
412 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
413
414 for named_group in self._named_groups:
415 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
416 named_group=named_group,
417 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
418
419 check_strings.append("Verifying peer X.509 certificate... ok")
420 return ['-s "{}"'.format(i) for i in check_strings]
421
422 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000423 return ['$P_SRV_NO_CERT']
XiaokangQianb1847a22022-06-08 07:49:31 +0000424
XiaokangQian9b938b72022-06-10 03:10:59 +0000425 def hrr_post_checks(self, named_group):
426 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
427
XiaokangQianb1847a22022-06-08 07:49:31 +0000428
429class OpenSSLCli(OpenSSLBase):
430 """
431 Generate test commands for OpenSSL client.
432 """
433
434 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000435 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000436
437 ret += ['-CAfile {cafile}'.format(
438 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
439
440 return ' '.join(ret)
441
XiaokangQianb1847a22022-06-08 07:49:31 +0000442 def post_checks(self):
443 return ['-s "HTTP/1.0 200 OK"']
444
445 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000446 return ['$O_NEXT_CLI_NO_CERT']
XiaokangQianb1847a22022-06-08 07:49:31 +0000447
448
449class GnuTLSCli(GnuTLSBase):
450 """
451 Generate test commands for GnuTLS client.
452 """
453
XiaokangQianb1847a22022-06-08 07:49:31 +0000454 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000455 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000456 ret += ['--x509cafile {cafile}'.format(
457 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
458
459 ret = ' '.join(ret)
460 return ret
461
462 def pre_cmd(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000463 ret = ['$G_NEXT_CLI_NO_CERT']
464 ret += ['--debug=4', 'localhost', '-p $SRV_PORT', '--single-key-share']
465 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000466
467
468class MbedTLSCli(MbedTLSBase):
469 """
470 Generate test commands for mbedTLS client.
471 """
472
473 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000474 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000475
476 ret = ' '.join(ret)
477 return ret
478
479 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000480 return ['$P_CLI']
XiaokangQianb1847a22022-06-08 07:49:31 +0000481
482 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000483 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000484
XiaokangQian9b938b72022-06-10 03:10:59 +0000485 def hrr_post_checks(self, named_group):
486 ret = ['-c "received HelloRetryRequest message"']
487 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000488 return ret
489
490 def post_checks(self):
491 check_strings = ["Protocol is TLSv1.3"]
492 if self._ciphers:
493 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800494 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
495 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
496 self.CIPHER_SUITE[self._ciphers[0]]))
497 if self._sig_algs:
498 check_strings.append(
499 "Certificate Verify: Signature algorithm ( {:04x} )".format(
500 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
501
502 for named_group in self._named_groups:
503 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
504 named_group=named_group,
505 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
506
507 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800508 return ['-c "{}"'.format(i) for i in check_strings]
509
Jerry Yu305bfc32021-11-24 16:04:47 +0800510
XiaokangQianb1847a22022-06-08 07:49:31 +0000511SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
512CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800513
514
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200515def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800516 """
517 Generate test case with `ssl-opt.sh` format.
518 """
Jerry Yudda036d2021-11-30 11:19:41 +0800519 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200520 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800521
522 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
523 named_group=named_group,
524 signature_algorithm=sig_alg,
525 cert_sig_alg=sig_alg)
526 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
527 named_group=named_group,
528 signature_algorithm=sig_alg,
529 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800530
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000531 cmd = ['run_test "{}"'.format(name), '"{}"'.format(
532 server_object.cmd()), '"{}"'.format(client_object.cmd()), '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000533 cmd += server_object.post_checks()
534 cmd += client_object.post_checks()
535 cmd += ['-C "received HelloRetryRequest message"']
536 prefix = ' \\\n' + (' '*9)
537 cmd = prefix.join(cmd)
538 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
539
540
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200541def generate_hrr_compat_test(client=None, server=None,
542 client_named_group=None, server_named_group=None,
543 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000544 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000545 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000546 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000547 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000548 client=client, server=server, c_named_group=client_named_group,
549 s_named_group=server_named_group)
550 server_object = SERVER_CLASSES[server](named_group=server_named_group,
551 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000552
XiaokangQian2e17fb82022-03-28 03:30:05 +0000553 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
554 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000555 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000556
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000557 cmd = ['run_test "{}"'.format(name), '"{}"'.format(
558 server_object.cmd()), '"{}"'.format(client_object.cmd()), '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000559 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000560 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000561 cmd += server_object.hrr_post_checks(server_named_group)
562 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000563 prefix = ' \\\n' + (' '*9)
564 cmd = prefix.join(cmd)
565 return '\n'.join(server_object.pre_checks() +
566 client_object.pre_checks() +
567 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800568
569SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800570
571# {filename}
572#
573# Copyright The Mbed TLS Contributors
574# SPDX-License-Identifier: Apache-2.0
575#
576# Licensed under the Apache License, Version 2.0 (the "License"); you may
577# not use this file except in compliance with the License.
578# You may obtain a copy of the License at
579#
580# http://www.apache.org/licenses/LICENSE-2.0
581#
582# Unless required by applicable law or agreed to in writing, software
583# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
584# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
585# See the License for the specific language governing permissions and
586# limitations under the License.
587#
588# Purpose
589#
590# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000591# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800592#
593# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
594# AND REGENERATE THIS FILE.
595#
596'''
Jerry Yu29deed42021-11-25 11:09:54 +0800597
Jerry Yu305bfc32021-11-24 16:04:47 +0800598def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800599 """
600 Main function of this program
601 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800602 parser = argparse.ArgumentParser()
603
Jerry Yucdcb6832021-11-29 16:50:13 +0800604 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800605 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800606
Jerry Yuc4aa1522021-11-26 11:13:58 +0800607 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
608 default=False, help='Generate all available tls13 compat tests')
609
Jerry Yu305bfc32021-11-24 16:04:47 +0800610 parser.add_argument('--list-ciphers', action='store_true',
611 default=False, help='List supported ciphersuites')
612
613 parser.add_argument('--list-sig-algs', action='store_true',
614 default=False, help='List supported signature algorithms')
615
616 parser.add_argument('--list-named-groups', action='store_true',
617 default=False, help='List supported named groups')
618
619 parser.add_argument('--list-servers', action='store_true',
620 default=False, help='List supported TLS servers')
621
622 parser.add_argument('--list-clients', action='store_true',
623 default=False, help='List supported TLS Clients')
624
Jerry Yub4ac8f32021-12-01 10:41:37 +0800625 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
626 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800627 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800628 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
629 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800630 help='Choose TLS client program for test')
631 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
632 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
633 help='Choose cipher suite for test')
634 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
635 default=list(SIG_ALG_IANA_VALUE.keys())[0],
636 help='Choose cipher suite for test')
637 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
638 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
639 help='Choose cipher suite for test')
640
641 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800642
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800643 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800644 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200645 for client, server, cipher, named_group, sig_alg in \
646 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800647 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200648 CIPHER_SUITE_IANA_VALUE.keys(),
649 NAMED_GROUP_IANA_VALUE.keys(),
650 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000651 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000652 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000653 cipher=cipher, named_group=named_group,
654 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000655
XiaokangQiand5d5b602022-05-23 09:16:20 +0000656
XiaokangQiana1931442022-03-25 11:58:22 +0000657 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000658 for client, server, client_named_group, server_named_group in \
659 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000660 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000661 NAMED_GROUP_IANA_VALUE.keys(),
662 NAMED_GROUP_IANA_VALUE.keys()):
XiaokangQian9b938b72022-06-10 03:10:59 +0000663 if (client == 'mbedTLS' or server == 'mbedTLS') and \
664 client_named_group != server_named_group:
665 yield generate_hrr_compat_test(client=client, server=server,
666 client_named_group=client_named_group,
667 server_named_group=server_named_group,
668 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000669
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800670 if args.generate_all_tls13_compat_tests:
671 if args.output:
672 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800673 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000674 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800675 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800676 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800677 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800678 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800679 return 0
680
Jerry Yu305bfc32021-11-24 16:04:47 +0800681 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800682 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800683 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800684 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800685 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800686 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800687 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800688 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800689 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800690 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800691 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800692 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800693 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800694
XiaokangQiana1931442022-03-25 11:58:22 +0000695 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
696 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800697 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800698
Jerry Yu29deed42021-11-25 11:09:54 +0800699
Jerry Yu305bfc32021-11-24 16:04:47 +0800700if __name__ == "__main__":
701 sys.exit(main())