blob: 322e811fbe80f3cc73fa094cda9eaab619633f01 [file] [log] [blame]
Jerry Yu305bfc32021-11-24 16:04:47 +08001#!/usr/bin/env python3
2
3# generate_tls13_compat_tests.py
4#
5# Copyright The Mbed TLS Contributors
6# SPDX-License-Identifier: Apache-2.0
7#
8# Licensed under the Apache License, Version 2.0 (the "License"); you may
9# not use this file except in compliance with the License.
10# You may obtain a copy of the License at
11#
12# http://www.apache.org/licenses/LICENSE-2.0
13#
14# Unless required by applicable law or agreed to in writing, software
15# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17# See the License for the specific language governing permissions and
18# limitations under the License.
19
20"""
21Generate TLSv1.3 Compat test cases
22
23"""
24
25import sys
Jerry Yudda036d2021-11-30 11:19:41 +080026import os
Jerry Yu305bfc32021-11-24 16:04:47 +080027import argparse
Jerry Yuc4aa1522021-11-26 11:13:58 +080028import itertools
Jerry Yu882c30d2021-12-01 10:59:59 +080029from collections import namedtuple
Jerry Yu305bfc32021-11-24 16:04:47 +080030
Jerry Yu882c30d2021-12-01 10:59:59 +080031# define certificates configuration entry
32Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile'])
33# define the certificate parameters for signature algorithms
Jerry Yu305bfc32021-11-24 16:04:47 +080034CERTIFICATES = {
Jerry Yu882c30d2021-12-01 10:59:59 +080035 'ecdsa_secp256r1_sha256': Certificate('data_files/test-ca2.crt',
36 'data_files/ecdsa_secp256r1.crt',
37 'data_files/ecdsa_secp256r1.key'),
38 'ecdsa_secp384r1_sha384': Certificate('data_files/test-ca2.crt',
39 'data_files/ecdsa_secp384r1.crt',
40 'data_files/ecdsa_secp384r1.key'),
41 'ecdsa_secp521r1_sha512': Certificate('data_files/test-ca2.crt',
42 'data_files/ecdsa_secp521r1.crt',
43 'data_files/ecdsa_secp521r1.key'),
44 'rsa_pss_rsae_sha256': Certificate('data_files/test-ca_cat12.crt',
45 'data_files/server2-sha256.crt', 'data_files/server2.key'
46 )
Jerry Yu29deed42021-11-25 11:09:54 +080047}
Jerry Yu305bfc32021-11-24 16:04:47 +080048
49CIPHER_SUITE_IANA_VALUE = {
50 "TLS_AES_128_GCM_SHA256": 0x1301,
51 "TLS_AES_256_GCM_SHA384": 0x1302,
52 "TLS_CHACHA20_POLY1305_SHA256": 0x1303,
53 "TLS_AES_128_CCM_SHA256": 0x1304,
54 "TLS_AES_128_CCM_8_SHA256": 0x1305
55}
56
57SIG_ALG_IANA_VALUE = {
58 "ecdsa_secp256r1_sha256": 0x0403,
59 "ecdsa_secp384r1_sha384": 0x0503,
60 "ecdsa_secp521r1_sha512": 0x0603,
Jerry Yu29deed42021-11-25 11:09:54 +080061 'rsa_pss_rsae_sha256': 0x0804,
Jerry Yu305bfc32021-11-24 16:04:47 +080062}
63
64NAMED_GROUP_IANA_VALUE = {
65 'secp256r1': 0x17,
66 'secp384r1': 0x18,
67 'secp521r1': 0x19,
68 'x25519': 0x1d,
69 'x448': 0x1e,
Przemek Stekielae3209c2023-06-13 15:09:03 +020070 'ffdhe2048': 0x100,
71 'ffdhe3072': 0x101,
72 'ffdhe4096': 0x102,
73 'ffdhe6144': 0x103,
74 'ffdhe8192': 0x104,
Jerry Yu305bfc32021-11-24 16:04:47 +080075}
76
XiaokangQian68a87e42022-03-17 06:06:07 +000077
Jerry Yub7c12a42022-06-12 20:53:02 +080078class TLSProgram:
Jerry Yu305bfc32021-11-24 16:04:47 +080079 """
80 Base class for generate server/client command.
81 """
Jerry Yub7c12a42022-06-12 20:53:02 +080082
Jerry Yu7de79852022-03-23 16:50:47 +080083 # pylint: disable=too-many-arguments
XiaokangQiana1931442022-03-25 11:58:22 +000084 def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None,
85 cert_sig_alg=None, compat_mode=True):
Jerry Yu7918efe2021-12-01 15:29:10 +080086 self._ciphers = []
87 self._sig_algs = []
88 self._named_groups = []
Jerry Yu7de79852022-03-23 16:50:47 +080089 self._cert_sig_algs = []
90 if ciphersuite:
91 self.add_ciphersuites(ciphersuite)
92 if named_group:
93 self.add_named_groups(named_group)
94 if signature_algorithm:
95 self.add_signature_algorithms(signature_algorithm)
96 if cert_sig_alg:
97 self.add_cert_signature_algorithms(cert_sig_alg)
Ronald Cronae937252021-12-10 09:55:15 +010098 self._compat_mode = compat_mode
Jerry Yu305bfc32021-11-24 16:04:47 +080099
Jerry Yu7918efe2021-12-01 15:29:10 +0800100 # add_ciphersuites should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800101 def add_ciphersuites(self, *ciphersuites):
Jerry Yu7918efe2021-12-01 15:29:10 +0800102 self._ciphers.extend(
103 [cipher for cipher in ciphersuites if cipher not in self._ciphers])
Jerry Yu305bfc32021-11-24 16:04:47 +0800104
Jerry Yu7918efe2021-12-01 15:29:10 +0800105 # add_signature_algorithms should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800106 def add_signature_algorithms(self, *signature_algorithms):
Jerry Yu7918efe2021-12-01 15:29:10 +0800107 self._sig_algs.extend(
108 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs])
Jerry Yu305bfc32021-11-24 16:04:47 +0800109
Jerry Yu7de79852022-03-23 16:50:47 +0800110 # add_named_groups should not override by sub class
Jerry Yu305bfc32021-11-24 16:04:47 +0800111 def add_named_groups(self, *named_groups):
Jerry Yu7918efe2021-12-01 15:29:10 +0800112 self._named_groups.extend(
113 [named_group for named_group in named_groups if named_group not in self._named_groups])
Jerry Yu305bfc32021-11-24 16:04:47 +0800114
Jerry Yu7de79852022-03-23 16:50:47 +0800115 # add_cert_signature_algorithms should not override by sub class
116 def add_cert_signature_algorithms(self, *signature_algorithms):
117 self._cert_sig_algs.extend(
118 [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs])
119
Jerry Yub7c12a42022-06-12 20:53:02 +0800120 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800121 def pre_checks(self):
122 return []
123
Jerry Yub7c12a42022-06-12 20:53:02 +0800124 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800125 def cmd(self):
Jerry Yu7de79852022-03-23 16:50:47 +0800126 if not self._cert_sig_algs:
127 self._cert_sig_algs = list(CERTIFICATES.keys())
Jerry Yub7c12a42022-06-12 20:53:02 +0800128 return self.pre_cmd()
Jerry Yu305bfc32021-11-24 16:04:47 +0800129
Jerry Yub7c12a42022-06-12 20:53:02 +0800130 # pylint: disable=no-self-use
Jerry Yu305bfc32021-11-24 16:04:47 +0800131 def post_checks(self):
132 return []
133
Jerry Yub7c12a42022-06-12 20:53:02 +0800134 # pylint: disable=no-self-use
XiaokangQianb1847a22022-06-08 07:49:31 +0000135 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800136 return ['false']
Jerry Yu305bfc32021-11-24 16:04:47 +0800137
Jerry Yub7c12a42022-06-12 20:53:02 +0800138 # pylint: disable=unused-argument,no-self-use
XiaokangQian9b938b72022-06-10 03:10:59 +0000139 def hrr_post_checks(self, named_group):
140 return []
141
XiaokangQianb1847a22022-06-08 07:49:31 +0000142
143class OpenSSLBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800144 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000145 Generate base test commands for OpenSSL.
Jerry Yu305bfc32021-11-24 16:04:47 +0800146 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800147
148 NAMED_GROUP = {
149 'secp256r1': 'P-256',
150 'secp384r1': 'P-384',
151 'secp521r1': 'P-521',
152 'x25519': 'X25519',
153 'x448': 'X448',
Przemek Stekielae3209c2023-06-13 15:09:03 +0200154 'ffdhe2048': 'ffdhe2048',
155 'ffdhe3072': 'ffdhe3072',
156 'ffdhe4096': 'ffdhe4096',
157 'ffdhe6144': 'ffdhe6144',
158 'ffdhe8192': 'ffdhe8192',
Jerry Yu305bfc32021-11-24 16:04:47 +0800159 }
160
Jerry Yu305bfc32021-11-24 16:04:47 +0800161 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800162 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000163
164 if self._ciphers:
165 ciphersuites = ':'.join(self._ciphers)
166 ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)]
167
168 if self._sig_algs:
169 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
170 signature_algorithms = ':'.join(signature_algorithms)
171 ret += ["-sigalgs {signature_algorithms}".format(
172 signature_algorithms=signature_algorithms)]
173
174 if self._named_groups:
175 named_groups = ':'.join(
176 map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups))
177 ret += ["-groups {named_groups}".format(named_groups=named_groups)]
178
179 ret += ['-msg -tls1_3']
180 if not self._compat_mode:
181 ret += ['-no_middlebox']
182
XiaokangQianb1847a22022-06-08 07:49:31 +0000183 return ret
184
185 def pre_checks(self):
186 return ["requires_openssl_tls1_3"]
187
XiaokangQianb1847a22022-06-08 07:49:31 +0000188
189class OpenSSLServ(OpenSSLBase):
190 """
191 Generate test commands for OpenSSL server.
192 """
193
194 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800195 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000196 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800197 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000198
XiaokangQiand5d5b602022-05-23 09:16:20 +0000199 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000200 return ['-c "HTTP/1.0 200 ok"']
201
202 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800203 ret = ['$O_NEXT_SRV_NO_CERT']
204 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
205 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
206 return ret
207
208
209class OpenSSLCli(OpenSSLBase):
210 """
211 Generate test commands for OpenSSL client.
212 """
213
214 def pre_cmd(self):
215 return ['$O_NEXT_CLI_NO_CERT',
216 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000217
218
XiaokangQianb1847a22022-06-08 07:49:31 +0000219class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000220 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000221 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000222 """
223
224 CIPHER_SUITE = {
225 'TLS_AES_256_GCM_SHA384': [
226 'AES-256-GCM',
227 'SHA384',
228 'AEAD'],
229 'TLS_AES_128_GCM_SHA256': [
230 'AES-128-GCM',
231 'SHA256',
232 'AEAD'],
233 'TLS_CHACHA20_POLY1305_SHA256': [
234 'CHACHA20-POLY1305',
235 'SHA256',
236 'AEAD'],
237 'TLS_AES_128_CCM_SHA256': [
238 'AES-128-CCM',
239 'SHA256',
240 'AEAD'],
241 'TLS_AES_128_CCM_8_SHA256': [
242 'AES-128-CCM-8',
243 'SHA256',
244 'AEAD']}
245
246 SIGNATURE_ALGORITHM = {
247 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
248 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
249 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
250 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
251
252 NAMED_GROUP = {
253 'secp256r1': ['GROUP-SECP256R1'],
254 'secp384r1': ['GROUP-SECP384R1'],
255 'secp521r1': ['GROUP-SECP521R1'],
256 'x25519': ['GROUP-X25519'],
257 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200258 'ffdhe2048': ['GROUP-FFDHE2048'],
259 'ffdhe3072': ['GROUP-FFDHE3072'],
260 'ffdhe4096': ['GROUP-FFDHE4096'],
261 'ffdhe6144': ['GROUP-FFDHE6144'],
262 'ffdhe8192': ['GROUP-FFDHE8192'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000263 }
264
265 def pre_checks(self):
266 return ["requires_gnutls_tls1_3",
267 "requires_gnutls_next_no_ticket",
268 "requires_gnutls_next_disable_tls13_compat", ]
269
XiaokangQiand5d5b602022-05-23 09:16:20 +0000270 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800271 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000272
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
Jerry Yub7c12a42022-06-12 20:53:02 +0800319 def pre_cmd(self):
320 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000321
Jerry Yub7c12a42022-06-12 20:53:02 +0800322 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
323 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
324 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000325 return ret
326
Jerry Yub7c12a42022-06-12 20:53:02 +0800327 def post_checks(self):
328 return ['-c "HTTP/1.0 200 OK"']
329
330
331class GnuTLSCli(GnuTLSBase):
332 """
333 Generate test commands for GnuTLS client.
334 """
335
XiaokangQianb1847a22022-06-08 07:49:31 +0000336 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800337 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
338 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000339
XiaokangQianb1847a22022-06-08 07:49:31 +0000340
341class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800342 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000343 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800344 """
Jerry Yu29deed42021-11-25 11:09:54 +0800345
Jerry Yu305bfc32021-11-24 16:04:47 +0800346 CIPHER_SUITE = {
347 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
348 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
349 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
350 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
351 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
352
Jerry Yu7918efe2021-12-01 15:29:10 +0800353 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800354 ret = super().cmd()
355 ret += ['debug_level=4']
356
Jerry Yu305bfc32021-11-24 16:04:47 +0800357
XiaokangQiana1931442022-03-25 11:58:22 +0000358 if self._ciphers:
359 ciphers = ','.join(
360 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
361 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800362
XiaokangQiana1931442022-03-25 11:58:22 +0000363 if self._sig_algs + self._cert_sig_algs:
364 ret += ['sig_algs={sig_algs}'.format(
365 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800366
Jerry Yu7918efe2021-12-01 15:29:10 +0800367 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000368 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800369 ret += ["curves={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000370 return ret
371
372 def pre_checks(self):
373 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200374 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000375
376 if self._compat_mode:
377 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
378
379 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
380 ret.append(
381 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
382 return ret
383
XiaokangQianb1847a22022-06-08 07:49:31 +0000384
385class MbedTLSServ(MbedTLSBase):
386 """
387 Generate test commands for mbedTLS server.
388 """
389
390 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800391 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000392 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800393 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800394
395 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000396 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800397
398 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100399 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800400 if self._ciphers:
401 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000402 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
403 self.CIPHER_SUITE[self._ciphers[0]],
404 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
405 if self._sig_algs:
406 check_strings.append(
407 "received signature algorithm: 0x{:x}".format(
408 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
409
410 for named_group in self._named_groups:
411 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
412 named_group=named_group,
413 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
414
Ronald Croneac00ad2022-09-13 10:16:31 +0200415 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000416 return ['-s "{}"'.format(i) for i in check_strings]
417
418 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800419 ret = ['$P_SRV']
420 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
421 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
422 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000423
XiaokangQian9b938b72022-06-10 03:10:59 +0000424 def hrr_post_checks(self, named_group):
425 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
426
XiaokangQianb1847a22022-06-08 07:49:31 +0000427
XiaokangQianb1847a22022-06-08 07:49:31 +0000428class MbedTLSCli(MbedTLSBase):
429 """
430 Generate test commands for mbedTLS client.
431 """
432
XiaokangQianb1847a22022-06-08 07:49:31 +0000433 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800434 return ['$P_CLI',
435 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000436
437 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000438 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000439
XiaokangQian9b938b72022-06-10 03:10:59 +0000440 def hrr_post_checks(self, named_group):
441 ret = ['-c "received HelloRetryRequest message"']
442 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000443 return ret
444
445 def post_checks(self):
446 check_strings = ["Protocol is TLSv1.3"]
447 if self._ciphers:
448 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800449 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
450 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
451 self.CIPHER_SUITE[self._ciphers[0]]))
452 if self._sig_algs:
453 check_strings.append(
454 "Certificate Verify: Signature algorithm ( {:04x} )".format(
455 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
456
457 for named_group in self._named_groups:
458 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
459 named_group=named_group,
460 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
461
462 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800463 return ['-c "{}"'.format(i) for i in check_strings]
464
Jerry Yu305bfc32021-11-24 16:04:47 +0800465
XiaokangQianb1847a22022-06-08 07:49:31 +0000466SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
467CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800468
469
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200470def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800471 """
472 Generate test case with `ssl-opt.sh` format.
473 """
Jerry Yudda036d2021-11-30 11:19:41 +0800474 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200475 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800476
477 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
478 named_group=named_group,
479 signature_algorithm=sig_alg,
480 cert_sig_alg=sig_alg)
481 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
482 named_group=named_group,
483 signature_algorithm=sig_alg,
484 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800485
Jerry Yub7c12a42022-06-12 20:53:02 +0800486 cmd = ['run_test "{}"'.format(name),
487 '"{}"'.format(' '.join(server_object.cmd())),
488 '"{}"'.format(' '.join(client_object.cmd())),
489 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000490 cmd += server_object.post_checks()
491 cmd += client_object.post_checks()
492 cmd += ['-C "received HelloRetryRequest message"']
493 prefix = ' \\\n' + (' '*9)
494 cmd = prefix.join(cmd)
495 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
496
497
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200498def generate_hrr_compat_test(client=None, server=None,
499 client_named_group=None, server_named_group=None,
500 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000501 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000502 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000503 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000504 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000505 client=client, server=server, c_named_group=client_named_group,
506 s_named_group=server_named_group)
507 server_object = SERVER_CLASSES[server](named_group=server_named_group,
508 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000509
XiaokangQian2e17fb82022-03-28 03:30:05 +0000510 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
511 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000512 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000513
Jerry Yub7c12a42022-06-12 20:53:02 +0800514 cmd = ['run_test "{}"'.format(name),
515 '"{}"'.format(' '.join(server_object.cmd())),
516 '"{}"'.format(' '.join(client_object.cmd())),
517 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000518 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000519 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000520 cmd += server_object.hrr_post_checks(server_named_group)
521 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000522 prefix = ' \\\n' + (' '*9)
523 cmd = prefix.join(cmd)
524 return '\n'.join(server_object.pre_checks() +
525 client_object.pre_checks() +
526 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800527
528SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800529
530# {filename}
531#
532# Copyright The Mbed TLS Contributors
533# SPDX-License-Identifier: Apache-2.0
534#
535# Licensed under the Apache License, Version 2.0 (the "License"); you may
536# not use this file except in compliance with the License.
537# You may obtain a copy of the License at
538#
539# http://www.apache.org/licenses/LICENSE-2.0
540#
541# Unless required by applicable law or agreed to in writing, software
542# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
543# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
544# See the License for the specific language governing permissions and
545# limitations under the License.
546#
547# Purpose
548#
549# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000550# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800551#
552# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
553# AND REGENERATE THIS FILE.
554#
555'''
Jerry Yu29deed42021-11-25 11:09:54 +0800556
Jerry Yu305bfc32021-11-24 16:04:47 +0800557def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800558 """
559 Main function of this program
560 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800561 parser = argparse.ArgumentParser()
562
Jerry Yucdcb6832021-11-29 16:50:13 +0800563 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800564 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800565
Jerry Yuc4aa1522021-11-26 11:13:58 +0800566 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
567 default=False, help='Generate all available tls13 compat tests')
568
Jerry Yu305bfc32021-11-24 16:04:47 +0800569 parser.add_argument('--list-ciphers', action='store_true',
570 default=False, help='List supported ciphersuites')
571
572 parser.add_argument('--list-sig-algs', action='store_true',
573 default=False, help='List supported signature algorithms')
574
575 parser.add_argument('--list-named-groups', action='store_true',
576 default=False, help='List supported named groups')
577
578 parser.add_argument('--list-servers', action='store_true',
579 default=False, help='List supported TLS servers')
580
581 parser.add_argument('--list-clients', action='store_true',
582 default=False, help='List supported TLS Clients')
583
Jerry Yub4ac8f32021-12-01 10:41:37 +0800584 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
585 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800586 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800587 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
588 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800589 help='Choose TLS client program for test')
590 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
591 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
592 help='Choose cipher suite for test')
593 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
594 default=list(SIG_ALG_IANA_VALUE.keys())[0],
595 help='Choose cipher suite for test')
596 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
597 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
598 help='Choose cipher suite for test')
599
600 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800601
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800602 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800603 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200604 for client, server, cipher, named_group, sig_alg in \
605 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800606 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200607 CIPHER_SUITE_IANA_VALUE.keys(),
608 NAMED_GROUP_IANA_VALUE.keys(),
609 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000610 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000611 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000612 cipher=cipher, named_group=named_group,
613 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000614
XiaokangQiand5d5b602022-05-23 09:16:20 +0000615
XiaokangQiana1931442022-03-25 11:58:22 +0000616 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000617 for client, server, client_named_group, server_named_group in \
618 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000619 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000620 NAMED_GROUP_IANA_VALUE.keys(),
621 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800622
XiaokangQian9b938b72022-06-10 03:10:59 +0000623 if (client == 'mbedTLS' or server == 'mbedTLS') and \
624 client_named_group != server_named_group:
625 yield generate_hrr_compat_test(client=client, server=server,
626 client_named_group=client_named_group,
627 server_named_group=server_named_group,
628 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000629
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800630 if args.generate_all_tls13_compat_tests:
631 if args.output:
632 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800633 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000634 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800635 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800636 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800637 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800638 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800639 return 0
640
Jerry Yu305bfc32021-11-24 16:04:47 +0800641 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800642 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800643 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800644 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800645 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800646 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800647 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800648 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800649 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800650 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800651 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800652 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800653 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800654
XiaokangQiana1931442022-03-25 11:58:22 +0000655 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
656 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800657 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800658
Jerry Yu29deed42021-11-25 11:09:54 +0800659
Jerry Yu305bfc32021-11-24 16:04:47 +0800660if __name__ == "__main__":
661 sys.exit(main())