blob: d570c470339094ebe03d7731237428680e3e500c [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):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000186 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000187 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):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000200 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):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000316 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000317
XiaokangQiand5d5b602022-05-23 09:16:20 +0000318 ret = ' '.join(ret)
319 return ret
320
XiaokangQianb1847a22022-06-08 07:49:31 +0000321 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000322 return ['$G_NEXT_SRV_NO_CERT'] + ['--http', '--disable-client-cert', '--debug=4']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000323
XiaokangQianb1847a22022-06-08 07:49:31 +0000324
325class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800326 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000327 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800328 """
Jerry Yu29deed42021-11-25 11:09:54 +0800329
Jerry Yu305bfc32021-11-24 16:04:47 +0800330 CIPHER_SUITE = {
331 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
332 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
333 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
334 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
335 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
336
Jerry Yu7918efe2021-12-01 15:29:10 +0800337 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800338 super().cmd()
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000339 ret = ['server_addr=127.0.0.1', 'server_port=$SRV_PORT', 'debug_level=4']
Jerry Yu7918efe2021-12-01 15:29:10 +0800340 ret += ['ca_file={cafile}'.format(
Jerry Yu7de79852022-03-23 16:50:47 +0800341 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800342
XiaokangQiana1931442022-03-25 11:58:22 +0000343 if self._ciphers:
344 ciphers = ','.join(
345 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
346 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800347
XiaokangQiana1931442022-03-25 11:58:22 +0000348 if self._sig_algs + self._cert_sig_algs:
349 ret += ['sig_algs={sig_algs}'.format(
350 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800351
Jerry Yu7918efe2021-12-01 15:29:10 +0800352 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000353 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800354 ret += ["curves={named_groups}".format(named_groups=named_groups)]
355
XiaokangQianb1847a22022-06-08 07:49:31 +0000356 return ret
357
358 def pre_checks(self):
359 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
360 'requires_config_enabled MBEDTLS_SSL_CLI_C',
361 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
362
363 if self._compat_mode:
364 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
365
366 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
367 ret.append(
368 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
369 return ret
370
371 def post_checks(self):
372 return []
373
374
375class MbedTLSServ(MbedTLSBase):
376 """
377 Generate test commands for mbedTLS server.
378 """
379
380 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000381 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000382 ret += ['force_version=tls13']
383 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
384 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
385
386 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800387 ret = ' '.join(ret)
388 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800389
390 def pre_checks(self):
Jerry Yu29deed42021-11-25 11:09:54 +0800391 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000392 'requires_config_enabled MBEDTLS_SSL_SRV_C',
Ronald Cron135427c2022-01-07 22:14:24 +0100393 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
Ronald Cronae937252021-12-10 09:55:15 +0100394
395 if self._compat_mode:
396 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
397
Jerry Yu7de79852022-03-23 16:50:47 +0800398 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
Jerry Yu29deed42021-11-25 11:09:54 +0800399 ret.append(
400 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
401 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800402
403 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100404 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800405 if self._ciphers:
406 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000407 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
408 self.CIPHER_SUITE[self._ciphers[0]],
409 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
410 if self._sig_algs:
411 check_strings.append(
412 "received signature algorithm: 0x{:x}".format(
413 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
414
415 for named_group in self._named_groups:
416 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
417 named_group=named_group,
418 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
419
420 check_strings.append("Verifying peer X.509 certificate... ok")
421 return ['-s "{}"'.format(i) for i in check_strings]
422
423 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000424 return ['$P_SRV_NO_CERT']
XiaokangQianb1847a22022-06-08 07:49:31 +0000425
426
427class OpenSSLCli(OpenSSLBase):
428 """
429 Generate test commands for OpenSSL client.
430 """
431
432 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000433 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000434
435 ret += ['-CAfile {cafile}'.format(
436 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
437
438 return ' '.join(ret)
439
440 def pre_checks(self):
441 return ["requires_openssl_tls1_3"]
442
443 def post_checks(self):
444 return ['-s "HTTP/1.0 200 OK"']
445
446 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000447 return ['$O_NEXT_CLI_NO_CERT']
XiaokangQianb1847a22022-06-08 07:49:31 +0000448
449
450class GnuTLSCli(GnuTLSBase):
451 """
452 Generate test commands for GnuTLS client.
453 """
454
455 def pre_checks(self):
456 return ["requires_gnutls_tls1_3",
457 "requires_gnutls_next_no_ticket",
458 "requires_gnutls_next_disable_tls13_compat", ]
459
460 def post_checks(self):
461 return ['-c "HTTP/1.0 200 OK"']
462
463 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000464 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000465 ret += ['--x509cafile {cafile}'.format(
466 cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
467
468 ret = ' '.join(ret)
469 return ret
470
471 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000472 return ['$G_NEXT_CLI_NO_CERT'] + ['--debug=4', 'localhost', '-p $SRV_PORT', '--single-key-share']
XiaokangQianb1847a22022-06-08 07:49:31 +0000473
474
475class MbedTLSCli(MbedTLSBase):
476 """
477 Generate test commands for mbedTLS client.
478 """
479
480 def cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000481 ret = self.pre_cmd() + super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000482
483 ret = ' '.join(ret)
484 return ret
485
486 def pre_cmd(self):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000487 return ['$P_CLI']
XiaokangQianb1847a22022-06-08 07:49:31 +0000488
489 def pre_checks(self):
490 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
491 'requires_config_enabled MBEDTLS_SSL_CLI_C',
492 'requires_config_enabled MBEDTLS_SSL_PROTO_TLS1_3']
493
494 if self._compat_mode:
495 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
496
497 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
498 ret.append(
499 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
500 return ret
501
502 def post_checks(self):
503 check_strings = ["Protocol is TLSv1.3"]
504 if self._ciphers:
505 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800506 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
507 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
508 self.CIPHER_SUITE[self._ciphers[0]]))
509 if self._sig_algs:
510 check_strings.append(
511 "Certificate Verify: Signature algorithm ( {:04x} )".format(
512 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
513
514 for named_group in self._named_groups:
515 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
516 named_group=named_group,
517 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
518
519 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800520 return ['-c "{}"'.format(i) for i in check_strings]
521
Jerry Yu305bfc32021-11-24 16:04:47 +0800522
XiaokangQianb1847a22022-06-08 07:49:31 +0000523SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
524CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800525
526
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200527def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800528 """
529 Generate test case with `ssl-opt.sh` format.
530 """
Jerry Yudda036d2021-11-30 11:19:41 +0800531 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200532 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800533
534 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
535 named_group=named_group,
536 signature_algorithm=sig_alg,
537 cert_sig_alg=sig_alg)
538 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
539 named_group=named_group,
540 signature_algorithm=sig_alg,
541 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800542
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000543 cmd = ['run_test "{}"'.format(name), '"{}"'.format(
544 server_object.cmd()), '"{}"'.format(client_object.cmd()), '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000545 cmd += server_object.post_checks()
546 cmd += client_object.post_checks()
547 cmd += ['-C "received HelloRetryRequest message"']
548 prefix = ' \\\n' + (' '*9)
549 cmd = prefix.join(cmd)
550 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
551
552
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200553def generate_hrr_compat_test(client=None, server=None,
554 client_named_group=None, server_named_group=None,
555 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000556 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000557 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000558 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000559 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000560 client=client, server=server, c_named_group=client_named_group,
561 s_named_group=server_named_group)
562 server_object = SERVER_CLASSES[server](named_group=server_named_group,
563 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000564
XiaokangQian2e17fb82022-03-28 03:30:05 +0000565 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
566 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000567 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000568
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000569 cmd = ['run_test "{}"'.format(name), '"{}"'.format(
570 server_object.cmd()), '"{}"'.format(client_object.cmd()), '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000571 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000572 cmd += client_object.post_checks()
573 cmd += ['-c "received HelloRetryRequest message"']
574 cmd += ['-c "selected_group ( {:d} )"'.format(
575 NAMED_GROUP_IANA_VALUE[server_named_group])]
XiaokangQian7069cbc2022-02-24 08:30:39 +0000576 prefix = ' \\\n' + (' '*9)
577 cmd = prefix.join(cmd)
XiaokangQiana1931442022-03-25 11:58:22 +0000578 return '\n'.join(server_object.pre_checks() +
579 client_object.pre_checks() +
580 [cmd])
XiaokangQian7069cbc2022-02-24 08:30:39 +0000581
XiaokangQiand5d5b602022-05-23 09:16:20 +0000582def generate_server_hrr_compat_test(client=None, server=None,
583 client_named_group=None, server_named_group=None,
584 cert_sig_alg=None):
585 """
586 Generate server side Hello Retry Request test case with `ssl-opt.sh` format.
587 """
588 name = 'TLS 1.3 {client[0]}->{server[0]}: Server HRR {c_named_group} -> {s_named_group}'.format(
589 client=client, server=server, c_named_group=client_named_group,
590 s_named_group=server_named_group)
XiaokangQianb1847a22022-06-08 07:49:31 +0000591 server_object = SERVER_CLASSES[server](named_group=server_named_group,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000592 cert_sig_alg=cert_sig_alg)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000593
XiaokangQianb1847a22022-06-08 07:49:31 +0000594 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000595 cert_sig_alg=cert_sig_alg)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000596 client_object.add_named_groups(server_named_group)
597
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000598 cmd = ['run_test "{}"'.format(name), '"{}"'.format(
599 server_object.cmd()), '"{}"'.format(client_object.cmd()), '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000600 cmd += server_object.post_checks()
601 cmd += client_object.post_checks()
602 cmd += ['-s "HRR selected_group: {:s}"'.format(server_named_group)]
603 prefix = ' \\\n' + (' '*9)
604 cmd = prefix.join(cmd)
605 return '\n'.join(server_object.pre_checks() +
606 client_object.pre_checks() +
607 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800608
609SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800610
611# {filename}
612#
613# Copyright The Mbed TLS Contributors
614# SPDX-License-Identifier: Apache-2.0
615#
616# Licensed under the Apache License, Version 2.0 (the "License"); you may
617# not use this file except in compliance with the License.
618# You may obtain a copy of the License at
619#
620# http://www.apache.org/licenses/LICENSE-2.0
621#
622# Unless required by applicable law or agreed to in writing, software
623# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
624# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
625# See the License for the specific language governing permissions and
626# limitations under the License.
627#
628# Purpose
629#
630# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000631# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800632#
633# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
634# AND REGENERATE THIS FILE.
635#
636'''
Jerry Yu29deed42021-11-25 11:09:54 +0800637
Jerry Yu305bfc32021-11-24 16:04:47 +0800638def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800639 """
640 Main function of this program
641 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800642 parser = argparse.ArgumentParser()
643
Jerry Yucdcb6832021-11-29 16:50:13 +0800644 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800645 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800646
Jerry Yuc4aa1522021-11-26 11:13:58 +0800647 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
648 default=False, help='Generate all available tls13 compat tests')
649
Jerry Yu305bfc32021-11-24 16:04:47 +0800650 parser.add_argument('--list-ciphers', action='store_true',
651 default=False, help='List supported ciphersuites')
652
653 parser.add_argument('--list-sig-algs', action='store_true',
654 default=False, help='List supported signature algorithms')
655
656 parser.add_argument('--list-named-groups', action='store_true',
657 default=False, help='List supported named groups')
658
659 parser.add_argument('--list-servers', action='store_true',
660 default=False, help='List supported TLS servers')
661
662 parser.add_argument('--list-clients', action='store_true',
663 default=False, help='List supported TLS Clients')
664
Jerry Yub4ac8f32021-12-01 10:41:37 +0800665 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
666 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800667 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800668 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
669 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800670 help='Choose TLS client program for test')
671 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
672 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
673 help='Choose cipher suite for test')
674 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
675 default=list(SIG_ALG_IANA_VALUE.keys())[0],
676 help='Choose cipher suite for test')
677 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
678 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
679 help='Choose cipher suite for test')
680
681 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800682
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800683 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800684 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200685 for client, server, cipher, named_group, sig_alg in \
686 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800687 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200688 CIPHER_SUITE_IANA_VALUE.keys(),
689 NAMED_GROUP_IANA_VALUE.keys(),
690 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000691 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000692 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000693 cipher=cipher, named_group=named_group,
694 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000695
XiaokangQiand5d5b602022-05-23 09:16:20 +0000696
XiaokangQiana1931442022-03-25 11:58:22 +0000697 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000698 for client, server, client_named_group, server_named_group in \
699 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000700 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000701 NAMED_GROUP_IANA_VALUE.keys(),
702 NAMED_GROUP_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000703 if client == 'mbedTLS' and client_named_group != server_named_group:
XiaokangQianb1847a22022-06-08 07:49:31 +0000704 yield generate_hrr_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000705 client_named_group=client_named_group,
706 server_named_group=server_named_group,
707 cert_sig_alg="ecdsa_secp256r1_sha256")
Jerry Yu7de79852022-03-23 16:50:47 +0800708
XiaokangQiand5d5b602022-05-23 09:16:20 +0000709 for client, server, client_named_group, server_named_group in \
XiaokangQianb1847a22022-06-08 07:49:31 +0000710 itertools.product(CLIENT_CLASSES.keys(),
711 SERVER_CLASSES.keys(),
XiaokangQiand5d5b602022-05-23 09:16:20 +0000712 NAMED_GROUP_IANA_VALUE.keys(),
713 NAMED_GROUP_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000714 if server == 'mbedTLS' and client_named_group != server_named_group:
715 yield generate_server_hrr_compat_test(client=client, server=server,
716 client_named_group=client_named_group,
717 server_named_group=server_named_group,
718 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQianb1847a22022-06-08 07:49:31 +0000719
XiaokangQiand5d5b602022-05-23 09:16:20 +0000720
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800721 if args.generate_all_tls13_compat_tests:
722 if args.output:
723 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800724 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000725 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800726 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800727 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800728 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800729 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800730 return 0
731
Jerry Yu305bfc32021-11-24 16:04:47 +0800732 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800733 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800734 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800735 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800736 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800737 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800738 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800739 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800740 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800741 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800742 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800743 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800744 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800745
XiaokangQiana1931442022-03-25 11:58:22 +0000746 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
747 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800748 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800749
Jerry Yu29deed42021-11-25 11:09:54 +0800750
Jerry Yu305bfc32021-11-24 16:04:47 +0800751if __name__ == "__main__":
752 sys.exit(main())