blob: b0f718bc51744804ac06cf87b736819b01072b96 [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):
Przemek Stekiel422ab1f2023-06-14 11:04:28 +0200186 ret = ["requires_openssl_tls1_3"]
187
188 # ffdh groups require at least openssl 3.0
189 ffdh_groups = ['ffdhe2048', 'ffdhe3072', 'ffdhe4096', 'ffdhe6144', 'ffdhe8192']
190
191 if any(x in ffdh_groups for x in self._named_groups):
192 ret.append('requires_openssl_3_x')
193
194 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000195
XiaokangQianb1847a22022-06-08 07:49:31 +0000196
197class OpenSSLServ(OpenSSLBase):
198 """
199 Generate test commands for OpenSSL server.
200 """
201
202 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800203 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000204 ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache']
Jerry Yub7c12a42022-06-12 20:53:02 +0800205 return ret
XiaokangQiand5d5b602022-05-23 09:16:20 +0000206
XiaokangQiand5d5b602022-05-23 09:16:20 +0000207 def post_checks(self):
XiaokangQianb1847a22022-06-08 07:49:31 +0000208 return ['-c "HTTP/1.0 200 ok"']
209
210 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800211 ret = ['$O_NEXT_SRV_NO_CERT']
212 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
213 ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)]
214 return ret
215
216
217class OpenSSLCli(OpenSSLBase):
218 """
219 Generate test commands for OpenSSL client.
220 """
221
222 def pre_cmd(self):
223 return ['$O_NEXT_CLI_NO_CERT',
224 '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000225
226
XiaokangQianb1847a22022-06-08 07:49:31 +0000227class GnuTLSBase(TLSProgram):
XiaokangQiand5d5b602022-05-23 09:16:20 +0000228 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000229 Generate base test commands for GnuTLS.
XiaokangQiand5d5b602022-05-23 09:16:20 +0000230 """
231
232 CIPHER_SUITE = {
233 'TLS_AES_256_GCM_SHA384': [
234 'AES-256-GCM',
235 'SHA384',
236 'AEAD'],
237 'TLS_AES_128_GCM_SHA256': [
238 'AES-128-GCM',
239 'SHA256',
240 'AEAD'],
241 'TLS_CHACHA20_POLY1305_SHA256': [
242 'CHACHA20-POLY1305',
243 'SHA256',
244 'AEAD'],
245 'TLS_AES_128_CCM_SHA256': [
246 'AES-128-CCM',
247 'SHA256',
248 'AEAD'],
249 'TLS_AES_128_CCM_8_SHA256': [
250 'AES-128-CCM-8',
251 'SHA256',
252 'AEAD']}
253
254 SIGNATURE_ALGORITHM = {
255 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'],
256 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'],
257 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'],
258 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']}
259
260 NAMED_GROUP = {
261 'secp256r1': ['GROUP-SECP256R1'],
262 'secp384r1': ['GROUP-SECP384R1'],
263 'secp521r1': ['GROUP-SECP521R1'],
264 'x25519': ['GROUP-X25519'],
265 'x448': ['GROUP-X448'],
Przemek Stekielae3209c2023-06-13 15:09:03 +0200266 'ffdhe2048': ['GROUP-FFDHE2048'],
267 'ffdhe3072': ['GROUP-FFDHE3072'],
268 'ffdhe4096': ['GROUP-FFDHE4096'],
269 'ffdhe6144': ['GROUP-FFDHE6144'],
270 'ffdhe8192': ['GROUP-FFDHE8192'],
XiaokangQiand5d5b602022-05-23 09:16:20 +0000271 }
272
273 def pre_checks(self):
274 return ["requires_gnutls_tls1_3",
275 "requires_gnutls_next_no_ticket",
276 "requires_gnutls_next_disable_tls13_compat", ]
277
XiaokangQiand5d5b602022-05-23 09:16:20 +0000278 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800279 ret = super().cmd()
XiaokangQiand5d5b602022-05-23 09:16:20 +0000280
281 priority_string_list = []
282
283 def update_priority_string_list(items, map_table):
284 for item in items:
285 for i in map_table[item]:
286 if i not in priority_string_list:
287 yield i
288
289 if self._ciphers:
290 priority_string_list.extend(update_priority_string_list(
291 self._ciphers, self.CIPHER_SUITE))
292 else:
293 priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL'])
294
295 if self._sig_algs:
296 signature_algorithms = set(self._sig_algs + self._cert_sig_algs)
297 priority_string_list.extend(update_priority_string_list(
298 signature_algorithms, self.SIGNATURE_ALGORITHM))
299 else:
300 priority_string_list.append('SIGN-ALL')
301
302
303 if self._named_groups:
304 priority_string_list.extend(update_priority_string_list(
305 self._named_groups, self.NAMED_GROUP))
306 else:
307 priority_string_list.append('GROUP-ALL')
308
309 priority_string_list = ['NONE'] + \
310 priority_string_list + ['VERS-TLS1.3']
311
312 priority_string = ':+'.join(priority_string_list)
313 priority_string += ':%NO_TICKETS'
314
315 if not self._compat_mode:
316 priority_string += [':%DISABLE_TLS13_COMPAT_MODE']
317
318 ret += ['--priority={priority_string}'.format(
319 priority_string=priority_string)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000320 return ret
321
322class GnuTLSServ(GnuTLSBase):
323 """
324 Generate test commands for GnuTLS server.
325 """
326
Jerry Yub7c12a42022-06-12 20:53:02 +0800327 def pre_cmd(self):
328 ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4']
XiaokangQianb1847a22022-06-08 07:49:31 +0000329
Jerry Yub7c12a42022-06-12 20:53:02 +0800330 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
331 ret += ['--x509certfile {cert} --x509keyfile {key}'.format(
332 cert=cert, key=key)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000333 return ret
334
Jerry Yub7c12a42022-06-12 20:53:02 +0800335 def post_checks(self):
336 return ['-c "HTTP/1.0 200 OK"']
337
338
339class GnuTLSCli(GnuTLSBase):
340 """
341 Generate test commands for GnuTLS client.
342 """
343
XiaokangQianb1847a22022-06-08 07:49:31 +0000344 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800345 return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share',
346 '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQiand5d5b602022-05-23 09:16:20 +0000347
XiaokangQianb1847a22022-06-08 07:49:31 +0000348
349class MbedTLSBase(TLSProgram):
Jerry Yu305bfc32021-11-24 16:04:47 +0800350 """
XiaokangQianb1847a22022-06-08 07:49:31 +0000351 Generate base test commands for mbedTLS.
Jerry Yu305bfc32021-11-24 16:04:47 +0800352 """
Jerry Yu29deed42021-11-25 11:09:54 +0800353
Jerry Yu305bfc32021-11-24 16:04:47 +0800354 CIPHER_SUITE = {
355 'TLS_AES_256_GCM_SHA384': 'TLS1-3-AES-256-GCM-SHA384',
356 'TLS_AES_128_GCM_SHA256': 'TLS1-3-AES-128-GCM-SHA256',
357 'TLS_CHACHA20_POLY1305_SHA256': 'TLS1-3-CHACHA20-POLY1305-SHA256',
358 'TLS_AES_128_CCM_SHA256': 'TLS1-3-AES-128-CCM-SHA256',
359 'TLS_AES_128_CCM_8_SHA256': 'TLS1-3-AES-128-CCM-8-SHA256'}
360
Jerry Yu7918efe2021-12-01 15:29:10 +0800361 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800362 ret = super().cmd()
363 ret += ['debug_level=4']
364
Jerry Yu305bfc32021-11-24 16:04:47 +0800365
XiaokangQiana1931442022-03-25 11:58:22 +0000366 if self._ciphers:
367 ciphers = ','.join(
368 map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers))
369 ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)]
Jerry Yu305bfc32021-11-24 16:04:47 +0800370
XiaokangQiana1931442022-03-25 11:58:22 +0000371 if self._sig_algs + self._cert_sig_algs:
372 ret += ['sig_algs={sig_algs}'.format(
373 sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))]
Jerry Yu305bfc32021-11-24 16:04:47 +0800374
Jerry Yu7918efe2021-12-01 15:29:10 +0800375 if self._named_groups:
XiaokangQian8031ba72022-03-22 12:53:45 +0000376 named_groups = ','.join(self._named_groups)
Jerry Yu7918efe2021-12-01 15:29:10 +0800377 ret += ["curves={named_groups}".format(named_groups=named_groups)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000378 return ret
379
380 def pre_checks(self):
381 ret = ['requires_config_enabled MBEDTLS_DEBUG_C',
Ronald Cron928cbd32022-10-04 16:14:26 +0200382 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED']
XiaokangQianb1847a22022-06-08 07:49:31 +0000383
384 if self._compat_mode:
385 ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE']
386
387 if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs:
388 ret.append(
389 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT')
390 return ret
391
XiaokangQianb1847a22022-06-08 07:49:31 +0000392
393class MbedTLSServ(MbedTLSBase):
394 """
395 Generate test commands for mbedTLS server.
396 """
397
398 def cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800399 ret = super().cmd()
XiaokangQianb1847a22022-06-08 07:49:31 +0000400 ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0']
Jerry Yu7918efe2021-12-01 15:29:10 +0800401 return ret
Jerry Yu305bfc32021-11-24 16:04:47 +0800402
403 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000404 return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks()
Jerry Yu305bfc32021-11-24 16:04:47 +0800405
406 def post_checks(self):
Ronald Crona1b8f6e2022-03-18 14:04:12 +0100407 check_strings = ["Protocol is TLSv1.3"]
Jerry Yu7de79852022-03-23 16:50:47 +0800408 if self._ciphers:
409 check_strings.append(
XiaokangQianb1847a22022-06-08 07:49:31 +0000410 "server hello, chosen ciphersuite: {} ( id={:04d} )".format(
411 self.CIPHER_SUITE[self._ciphers[0]],
412 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]]))
413 if self._sig_algs:
414 check_strings.append(
415 "received signature algorithm: 0x{:x}".format(
416 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
417
418 for named_group in self._named_groups:
419 check_strings += ['got named group: {named_group}({iana_value:04x})'.format(
420 named_group=named_group,
421 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
422
Ronald Croneac00ad2022-09-13 10:16:31 +0200423 check_strings.append("Certificate verification was skipped")
XiaokangQianb1847a22022-06-08 07:49:31 +0000424 return ['-s "{}"'.format(i) for i in check_strings]
425
426 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800427 ret = ['$P_SRV']
428 for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs):
429 ret += ['crt_file={cert} key_file={key}'.format(cert=cert, key=key)]
430 return ret
XiaokangQianb1847a22022-06-08 07:49:31 +0000431
XiaokangQian9b938b72022-06-10 03:10:59 +0000432 def hrr_post_checks(self, named_group):
433 return ['-s "HRR selected_group: {:s}"'.format(named_group)]
434
XiaokangQianb1847a22022-06-08 07:49:31 +0000435
XiaokangQianb1847a22022-06-08 07:49:31 +0000436class MbedTLSCli(MbedTLSBase):
437 """
438 Generate test commands for mbedTLS client.
439 """
440
XiaokangQianb1847a22022-06-08 07:49:31 +0000441 def pre_cmd(self):
Jerry Yub7c12a42022-06-12 20:53:02 +0800442 return ['$P_CLI',
443 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)]
XiaokangQianb1847a22022-06-08 07:49:31 +0000444
445 def pre_checks(self):
XiaokangQian9b938b72022-06-10 03:10:59 +0000446 return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks()
XiaokangQianb1847a22022-06-08 07:49:31 +0000447
XiaokangQian9b938b72022-06-10 03:10:59 +0000448 def hrr_post_checks(self, named_group):
449 ret = ['-c "received HelloRetryRequest message"']
450 ret += ['-c "selected_group ( {:d} )"'.format(NAMED_GROUP_IANA_VALUE[named_group])]
XiaokangQianb1847a22022-06-08 07:49:31 +0000451 return ret
452
453 def post_checks(self):
454 check_strings = ["Protocol is TLSv1.3"]
455 if self._ciphers:
456 check_strings.append(
Jerry Yu7de79852022-03-23 16:50:47 +0800457 "server hello, chosen ciphersuite: ( {:04x} ) - {}".format(
458 CIPHER_SUITE_IANA_VALUE[self._ciphers[0]],
459 self.CIPHER_SUITE[self._ciphers[0]]))
460 if self._sig_algs:
461 check_strings.append(
462 "Certificate Verify: Signature algorithm ( {:04x} )".format(
463 SIG_ALG_IANA_VALUE[self._sig_algs[0]]))
464
465 for named_group in self._named_groups:
466 check_strings += ['NamedGroup: {named_group} ( {iana_value:x} )'.format(
467 named_group=named_group,
468 iana_value=NAMED_GROUP_IANA_VALUE[named_group])]
469
470 check_strings.append("Verifying peer X.509 certificate... ok")
Jerry Yu305bfc32021-11-24 16:04:47 +0800471 return ['-c "{}"'.format(i) for i in check_strings]
472
Jerry Yu305bfc32021-11-24 16:04:47 +0800473
XiaokangQianb1847a22022-06-08 07:49:31 +0000474SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ}
475CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli}
Jerry Yu305bfc32021-11-24 16:04:47 +0800476
477
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200478def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None):
Jerry Yu305bfc32021-11-24 16:04:47 +0800479 """
480 Generate test case with `ssl-opt.sh` format.
481 """
Jerry Yudda036d2021-11-30 11:19:41 +0800482 name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format(
Ronald Crondf5f8682022-04-05 16:01:03 +0200483 client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group)
Jerry Yu7de79852022-03-23 16:50:47 +0800484
485 server_object = SERVER_CLASSES[server](ciphersuite=cipher,
486 named_group=named_group,
487 signature_algorithm=sig_alg,
488 cert_sig_alg=sig_alg)
489 client_object = CLIENT_CLASSES[client](ciphersuite=cipher,
490 named_group=named_group,
491 signature_algorithm=sig_alg,
492 cert_sig_alg=sig_alg)
Jerry Yu305bfc32021-11-24 16:04:47 +0800493
Jerry Yub7c12a42022-06-12 20:53:02 +0800494 cmd = ['run_test "{}"'.format(name),
495 '"{}"'.format(' '.join(server_object.cmd())),
496 '"{}"'.format(' '.join(client_object.cmd())),
497 '0']
XiaokangQiand5d5b602022-05-23 09:16:20 +0000498 cmd += server_object.post_checks()
499 cmd += client_object.post_checks()
500 cmd += ['-C "received HelloRetryRequest message"']
501 prefix = ' \\\n' + (' '*9)
502 cmd = prefix.join(cmd)
503 return '\n'.join(server_object.pre_checks() + client_object.pre_checks() + [cmd])
504
505
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200506def generate_hrr_compat_test(client=None, server=None,
507 client_named_group=None, server_named_group=None,
508 cert_sig_alg=None):
XiaokangQian7069cbc2022-02-24 08:30:39 +0000509 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000510 Generate Hello Retry Request test case with `ssl-opt.sh` format.
XiaokangQian7069cbc2022-02-24 08:30:39 +0000511 """
XiaokangQianeff93f92022-03-23 06:14:26 +0000512 name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format(
XiaokangQian2e17fb82022-03-28 03:30:05 +0000513 client=client, server=server, c_named_group=client_named_group,
514 s_named_group=server_named_group)
515 server_object = SERVER_CLASSES[server](named_group=server_named_group,
516 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000517
XiaokangQian2e17fb82022-03-28 03:30:05 +0000518 client_object = CLIENT_CLASSES[client](named_group=client_named_group,
519 cert_sig_alg=cert_sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000520 client_object.add_named_groups(server_named_group)
XiaokangQian7069cbc2022-02-24 08:30:39 +0000521
Jerry Yub7c12a42022-06-12 20:53:02 +0800522 cmd = ['run_test "{}"'.format(name),
523 '"{}"'.format(' '.join(server_object.cmd())),
524 '"{}"'.format(' '.join(client_object.cmd())),
525 '0']
XiaokangQian7069cbc2022-02-24 08:30:39 +0000526 cmd += server_object.post_checks()
XiaokangQiana1931442022-03-25 11:58:22 +0000527 cmd += client_object.post_checks()
XiaokangQian9b938b72022-06-10 03:10:59 +0000528 cmd += server_object.hrr_post_checks(server_named_group)
529 cmd += client_object.hrr_post_checks(server_named_group)
XiaokangQiand5d5b602022-05-23 09:16:20 +0000530 prefix = ' \\\n' + (' '*9)
531 cmd = prefix.join(cmd)
532 return '\n'.join(server_object.pre_checks() +
533 client_object.pre_checks() +
534 [cmd])
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800535
536SSL_OUTPUT_HEADER = '''#!/bin/sh
Jerry Yucdcb6832021-11-29 16:50:13 +0800537
538# {filename}
539#
540# Copyright The Mbed TLS Contributors
541# SPDX-License-Identifier: Apache-2.0
542#
543# Licensed under the Apache License, Version 2.0 (the "License"); you may
544# not use this file except in compliance with the License.
545# You may obtain a copy of the License at
546#
547# http://www.apache.org/licenses/LICENSE-2.0
548#
549# Unless required by applicable law or agreed to in writing, software
550# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
551# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
552# See the License for the specific language governing permissions and
553# limitations under the License.
554#
555# Purpose
556#
557# List TLS1.3 compat test cases. They are generated by
XiaokangQiana1931442022-03-25 11:58:22 +0000558# `{cmd}`.
Jerry Yucdcb6832021-11-29 16:50:13 +0800559#
560# PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py`
561# AND REGENERATE THIS FILE.
562#
563'''
Jerry Yu29deed42021-11-25 11:09:54 +0800564
Jerry Yu305bfc32021-11-24 16:04:47 +0800565def main():
Jerry Yudda036d2021-11-30 11:19:41 +0800566 """
567 Main function of this program
568 """
Jerry Yu305bfc32021-11-24 16:04:47 +0800569 parser = argparse.ArgumentParser()
570
Jerry Yucdcb6832021-11-29 16:50:13 +0800571 parser.add_argument('-o', '--output', nargs='?',
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800572 default=None, help='Output file path if `-a` was set')
Jerry Yucdcb6832021-11-29 16:50:13 +0800573
Jerry Yuc4aa1522021-11-26 11:13:58 +0800574 parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true',
575 default=False, help='Generate all available tls13 compat tests')
576
Jerry Yu305bfc32021-11-24 16:04:47 +0800577 parser.add_argument('--list-ciphers', action='store_true',
578 default=False, help='List supported ciphersuites')
579
580 parser.add_argument('--list-sig-algs', action='store_true',
581 default=False, help='List supported signature algorithms')
582
583 parser.add_argument('--list-named-groups', action='store_true',
584 default=False, help='List supported named groups')
585
586 parser.add_argument('--list-servers', action='store_true',
587 default=False, help='List supported TLS servers')
588
589 parser.add_argument('--list-clients', action='store_true',
590 default=False, help='List supported TLS Clients')
591
Jerry Yub4ac8f32021-12-01 10:41:37 +0800592 parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?',
593 default=list(SERVER_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800594 help='Choose TLS server program for test')
Jerry Yub4ac8f32021-12-01 10:41:37 +0800595 parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?',
596 default=list(CLIENT_CLASSES.keys())[0],
Jerry Yu305bfc32021-11-24 16:04:47 +0800597 help='Choose TLS client program for test')
598 parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?',
599 default=list(CIPHER_SUITE_IANA_VALUE.keys())[0],
600 help='Choose cipher suite for test')
601 parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?',
602 default=list(SIG_ALG_IANA_VALUE.keys())[0],
603 help='Choose cipher suite for test')
604 parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?',
605 default=list(NAMED_GROUP_IANA_VALUE.keys())[0],
606 help='Choose cipher suite for test')
607
608 args = parser.parse_args()
Jerry Yucdcb6832021-11-29 16:50:13 +0800609
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800610 def get_all_test_cases():
Jerry Yu7de79852022-03-23 16:50:47 +0800611 # Generate normal compat test cases
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200612 for client, server, cipher, named_group, sig_alg in \
613 itertools.product(CLIENT_CLASSES.keys(),
Jerry Yu7de79852022-03-23 16:50:47 +0800614 SERVER_CLASSES.keys(),
Ronald Cron9d0a3e82022-04-05 16:13:38 +0200615 CIPHER_SUITE_IANA_VALUE.keys(),
616 NAMED_GROUP_IANA_VALUE.keys(),
617 SIG_ALG_IANA_VALUE.keys()):
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000618 if server == 'mbedTLS' or client == 'mbedTLS':
XiaokangQianb1847a22022-06-08 07:49:31 +0000619 yield generate_compat_test(client=client, server=server,
XiaokangQianfb1a3fe2022-06-09 06:37:33 +0000620 cipher=cipher, named_group=named_group,
621 sig_alg=sig_alg)
XiaokangQiana1931442022-03-25 11:58:22 +0000622
XiaokangQiand5d5b602022-05-23 09:16:20 +0000623
XiaokangQiana1931442022-03-25 11:58:22 +0000624 # Generate Hello Retry Request compat test cases
XiaokangQian2e17fb82022-03-28 03:30:05 +0000625 for client, server, client_named_group, server_named_group in \
626 itertools.product(CLIENT_CLASSES.keys(),
XiaokangQiana1931442022-03-25 11:58:22 +0000627 SERVER_CLASSES.keys(),
XiaokangQian2e17fb82022-03-28 03:30:05 +0000628 NAMED_GROUP_IANA_VALUE.keys(),
629 NAMED_GROUP_IANA_VALUE.keys()):
Jerry Yub7c12a42022-06-12 20:53:02 +0800630
XiaokangQian9b938b72022-06-10 03:10:59 +0000631 if (client == 'mbedTLS' or server == 'mbedTLS') and \
632 client_named_group != server_named_group:
633 yield generate_hrr_compat_test(client=client, server=server,
634 client_named_group=client_named_group,
635 server_named_group=server_named_group,
636 cert_sig_alg="ecdsa_secp256r1_sha256")
XiaokangQiand5d5b602022-05-23 09:16:20 +0000637
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800638 if args.generate_all_tls13_compat_tests:
639 if args.output:
640 with open(args.output, 'w', encoding="utf-8") as f:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800641 f.write(SSL_OUTPUT_HEADER.format(
XiaokangQiana1931442022-03-25 11:58:22 +0000642 filename=os.path.basename(args.output), cmd=' '.join(sys.argv)))
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800643 f.write('\n\n'.join(get_all_test_cases()))
Jerry Yudda036d2021-11-30 11:19:41 +0800644 f.write('\n')
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800645 else:
Jerry Yu7de79852022-03-23 16:50:47 +0800646 print('\n\n'.join(get_all_test_cases()))
Jerry Yuc4aa1522021-11-26 11:13:58 +0800647 return 0
648
Jerry Yu305bfc32021-11-24 16:04:47 +0800649 if args.list_ciphers or args.list_sig_algs or args.list_named_groups \
Jerry Yu29deed42021-11-25 11:09:54 +0800650 or args.list_servers or args.list_clients:
Jerry Yu305bfc32021-11-24 16:04:47 +0800651 if args.list_ciphers:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800652 print(*CIPHER_SUITE_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800653 if args.list_sig_algs:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800654 print(*SIG_ALG_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800655 if args.list_named_groups:
Jerry Yu7f5e5ad2021-11-29 17:37:19 +0800656 print(*NAMED_GROUP_IANA_VALUE.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800657 if args.list_servers:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800658 print(*SERVER_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800659 if args.list_clients:
Jerry Yub4ac8f32021-12-01 10:41:37 +0800660 print(*CLIENT_CLASSES.keys())
Jerry Yu305bfc32021-11-24 16:04:47 +0800661 return 0
Jerry Yucdcb6832021-11-29 16:50:13 +0800662
XiaokangQiana1931442022-03-25 11:58:22 +0000663 print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg,
664 cipher=args.cipher, named_group=args.named_group))
Jerry Yucdcb6832021-11-29 16:50:13 +0800665 return 0
Jerry Yu305bfc32021-11-24 16:04:47 +0800666
Jerry Yu29deed42021-11-25 11:09:54 +0800667
Jerry Yu305bfc32021-11-24 16:04:47 +0800668if __name__ == "__main__":
669 sys.exit(main())