| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 1 | #!/usr/bin/env python3 | 
|  | 2 |  | 
|  | 3 | # generate_tls13_compat_tests.py | 
|  | 4 | # | 
|  | 5 | # Copyright The Mbed TLS Contributors | 
| Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 6 | # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 7 |  | 
|  | 8 | """ | 
|  | 9 | Generate TLSv1.3 Compat test cases | 
|  | 10 |  | 
|  | 11 | """ | 
|  | 12 |  | 
|  | 13 | import sys | 
| Jerry Yu | dda036d | 2021-11-30 11:19:41 +0800 | [diff] [blame] | 14 | import os | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 15 | import argparse | 
| Jerry Yu | c4aa152 | 2021-11-26 11:13:58 +0800 | [diff] [blame] | 16 | import itertools | 
| Jerry Yu | 882c30d | 2021-12-01 10:59:59 +0800 | [diff] [blame] | 17 | from collections import namedtuple | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 18 |  | 
| Jerry Yu | 882c30d | 2021-12-01 10:59:59 +0800 | [diff] [blame] | 19 | # define certificates configuration entry | 
|  | 20 | Certificate = namedtuple("Certificate", ['cafile', 'certfile', 'keyfile']) | 
|  | 21 | # define the certificate parameters for signature algorithms | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 22 | CERTIFICATES = { | 
| Jerry Yu | 882c30d | 2021-12-01 10:59:59 +0800 | [diff] [blame] | 23 | 'ecdsa_secp256r1_sha256': Certificate('data_files/test-ca2.crt', | 
|  | 24 | 'data_files/ecdsa_secp256r1.crt', | 
|  | 25 | 'data_files/ecdsa_secp256r1.key'), | 
|  | 26 | 'ecdsa_secp384r1_sha384': Certificate('data_files/test-ca2.crt', | 
|  | 27 | 'data_files/ecdsa_secp384r1.crt', | 
|  | 28 | 'data_files/ecdsa_secp384r1.key'), | 
|  | 29 | 'ecdsa_secp521r1_sha512': Certificate('data_files/test-ca2.crt', | 
|  | 30 | 'data_files/ecdsa_secp521r1.crt', | 
|  | 31 | 'data_files/ecdsa_secp521r1.key'), | 
|  | 32 | 'rsa_pss_rsae_sha256': Certificate('data_files/test-ca_cat12.crt', | 
|  | 33 | 'data_files/server2-sha256.crt', 'data_files/server2.key' | 
|  | 34 | ) | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 35 | } | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 36 |  | 
|  | 37 | CIPHER_SUITE_IANA_VALUE = { | 
|  | 38 | "TLS_AES_128_GCM_SHA256": 0x1301, | 
|  | 39 | "TLS_AES_256_GCM_SHA384": 0x1302, | 
|  | 40 | "TLS_CHACHA20_POLY1305_SHA256": 0x1303, | 
|  | 41 | "TLS_AES_128_CCM_SHA256": 0x1304, | 
|  | 42 | "TLS_AES_128_CCM_8_SHA256": 0x1305 | 
|  | 43 | } | 
|  | 44 |  | 
|  | 45 | SIG_ALG_IANA_VALUE = { | 
|  | 46 | "ecdsa_secp256r1_sha256": 0x0403, | 
|  | 47 | "ecdsa_secp384r1_sha384": 0x0503, | 
|  | 48 | "ecdsa_secp521r1_sha512": 0x0603, | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 49 | 'rsa_pss_rsae_sha256': 0x0804, | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 50 | } | 
|  | 51 |  | 
|  | 52 | NAMED_GROUP_IANA_VALUE = { | 
|  | 53 | 'secp256r1': 0x17, | 
|  | 54 | 'secp384r1': 0x18, | 
|  | 55 | 'secp521r1': 0x19, | 
|  | 56 | 'x25519': 0x1d, | 
|  | 57 | 'x448': 0x1e, | 
| Przemek Stekiel | 615cbcd | 2023-07-06 11:08:39 +0200 | [diff] [blame] | 58 | # Only one finite field group to keep testing time within reasonable bounds. | 
| Przemek Stekiel | ae3209c | 2023-06-13 15:09:03 +0200 | [diff] [blame] | 59 | 'ffdhe2048': 0x100, | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 60 | } | 
|  | 61 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 62 | class TLSProgram: | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 63 | """ | 
|  | 64 | Base class for generate server/client command. | 
|  | 65 | """ | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 66 |  | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 67 | # pylint: disable=too-many-arguments | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 68 | def __init__(self, ciphersuite=None, signature_algorithm=None, named_group=None, | 
|  | 69 | cert_sig_alg=None, compat_mode=True): | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 70 | self._ciphers = [] | 
|  | 71 | self._sig_algs = [] | 
|  | 72 | self._named_groups = [] | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 73 | self._cert_sig_algs = [] | 
|  | 74 | if ciphersuite: | 
|  | 75 | self.add_ciphersuites(ciphersuite) | 
|  | 76 | if named_group: | 
|  | 77 | self.add_named_groups(named_group) | 
|  | 78 | if signature_algorithm: | 
|  | 79 | self.add_signature_algorithms(signature_algorithm) | 
|  | 80 | if cert_sig_alg: | 
|  | 81 | self.add_cert_signature_algorithms(cert_sig_alg) | 
| Ronald Cron | ae93725 | 2021-12-10 09:55:15 +0100 | [diff] [blame] | 82 | self._compat_mode = compat_mode | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 83 |  | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 84 | # add_ciphersuites should not override by sub class | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 85 | def add_ciphersuites(self, *ciphersuites): | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 86 | self._ciphers.extend( | 
|  | 87 | [cipher for cipher in ciphersuites if cipher not in self._ciphers]) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 88 |  | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 89 | # add_signature_algorithms should not override by sub class | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 90 | def add_signature_algorithms(self, *signature_algorithms): | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 91 | self._sig_algs.extend( | 
|  | 92 | [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._sig_algs]) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 93 |  | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 94 | # add_named_groups should not override by sub class | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 95 | def add_named_groups(self, *named_groups): | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 96 | self._named_groups.extend( | 
|  | 97 | [named_group for named_group in named_groups if named_group not in self._named_groups]) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 98 |  | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 99 | # add_cert_signature_algorithms should not override by sub class | 
|  | 100 | def add_cert_signature_algorithms(self, *signature_algorithms): | 
|  | 101 | self._cert_sig_algs.extend( | 
|  | 102 | [sig_alg for sig_alg in signature_algorithms if sig_alg not in self._cert_sig_algs]) | 
|  | 103 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 104 | # pylint: disable=no-self-use | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 105 | def pre_checks(self): | 
|  | 106 | return [] | 
|  | 107 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 108 | # pylint: disable=no-self-use | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 109 | def cmd(self): | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 110 | if not self._cert_sig_algs: | 
|  | 111 | self._cert_sig_algs = list(CERTIFICATES.keys()) | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 112 | return self.pre_cmd() | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 113 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 114 | # pylint: disable=no-self-use | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 115 | def post_checks(self): | 
|  | 116 | return [] | 
|  | 117 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 118 | # pylint: disable=no-self-use | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 119 | def pre_cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 120 | return ['false'] | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 121 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 122 | # pylint: disable=unused-argument,no-self-use | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 123 | def hrr_post_checks(self, named_group): | 
|  | 124 | return [] | 
|  | 125 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 126 |  | 
|  | 127 | class OpenSSLBase(TLSProgram): | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 128 | """ | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 129 | Generate base test commands for OpenSSL. | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 130 | """ | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 131 |  | 
|  | 132 | NAMED_GROUP = { | 
|  | 133 | 'secp256r1': 'P-256', | 
|  | 134 | 'secp384r1': 'P-384', | 
|  | 135 | 'secp521r1': 'P-521', | 
|  | 136 | 'x25519': 'X25519', | 
|  | 137 | 'x448': 'X448', | 
| Przemek Stekiel | ae3209c | 2023-06-13 15:09:03 +0200 | [diff] [blame] | 138 | 'ffdhe2048': 'ffdhe2048', | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 139 | } | 
|  | 140 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 141 | def cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 142 | ret = super().cmd() | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 143 |  | 
|  | 144 | if self._ciphers: | 
|  | 145 | ciphersuites = ':'.join(self._ciphers) | 
|  | 146 | ret += ["-ciphersuites {ciphersuites}".format(ciphersuites=ciphersuites)] | 
|  | 147 |  | 
|  | 148 | if self._sig_algs: | 
|  | 149 | signature_algorithms = set(self._sig_algs + self._cert_sig_algs) | 
|  | 150 | signature_algorithms = ':'.join(signature_algorithms) | 
|  | 151 | ret += ["-sigalgs {signature_algorithms}".format( | 
|  | 152 | signature_algorithms=signature_algorithms)] | 
|  | 153 |  | 
|  | 154 | if self._named_groups: | 
|  | 155 | named_groups = ':'.join( | 
|  | 156 | map(lambda named_group: self.NAMED_GROUP[named_group], self._named_groups)) | 
|  | 157 | ret += ["-groups {named_groups}".format(named_groups=named_groups)] | 
|  | 158 |  | 
|  | 159 | ret += ['-msg -tls1_3'] | 
|  | 160 | if not self._compat_mode: | 
|  | 161 | ret += ['-no_middlebox'] | 
|  | 162 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 163 | return ret | 
|  | 164 |  | 
|  | 165 | def pre_checks(self): | 
| Przemek Stekiel | 422ab1f | 2023-06-14 11:04:28 +0200 | [diff] [blame] | 166 | ret = ["requires_openssl_tls1_3"] | 
|  | 167 |  | 
|  | 168 | # ffdh groups require at least openssl 3.0 | 
| Przemek Stekiel | 3484db4 | 2023-06-28 13:31:38 +0200 | [diff] [blame] | 169 | ffdh_groups = ['ffdhe2048'] | 
| Przemek Stekiel | 422ab1f | 2023-06-14 11:04:28 +0200 | [diff] [blame] | 170 |  | 
|  | 171 | if any(x in ffdh_groups for x in self._named_groups): | 
| Przemek Stekiel | 8bfe897 | 2023-06-26 12:59:45 +0200 | [diff] [blame] | 172 | ret = ["requires_openssl_tls1_3_with_ffdh"] | 
| Przemek Stekiel | 422ab1f | 2023-06-14 11:04:28 +0200 | [diff] [blame] | 173 |  | 
|  | 174 | return ret | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 175 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 176 |  | 
|  | 177 | class OpenSSLServ(OpenSSLBase): | 
|  | 178 | """ | 
|  | 179 | Generate test commands for OpenSSL server. | 
|  | 180 | """ | 
|  | 181 |  | 
|  | 182 | def cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 183 | ret = super().cmd() | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 184 | ret += ['-num_tickets 0 -no_resume_ephemeral -no_cache'] | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 185 | return ret | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 186 |  | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 187 | def post_checks(self): | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 188 | return ['-c "HTTP/1.0 200 ok"'] | 
|  | 189 |  | 
|  | 190 | def pre_cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 191 | ret = ['$O_NEXT_SRV_NO_CERT'] | 
|  | 192 | for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs): | 
|  | 193 | ret += ['-cert {cert} -key {key}'.format(cert=cert, key=key)] | 
|  | 194 | return ret | 
|  | 195 |  | 
|  | 196 |  | 
|  | 197 | class OpenSSLCli(OpenSSLBase): | 
|  | 198 | """ | 
|  | 199 | Generate test commands for OpenSSL client. | 
|  | 200 | """ | 
|  | 201 |  | 
|  | 202 | def pre_cmd(self): | 
|  | 203 | return ['$O_NEXT_CLI_NO_CERT', | 
|  | 204 | '-CAfile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)] | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 205 |  | 
|  | 206 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 207 | class GnuTLSBase(TLSProgram): | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 208 | """ | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 209 | Generate base test commands for GnuTLS. | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 210 | """ | 
|  | 211 |  | 
|  | 212 | CIPHER_SUITE = { | 
|  | 213 | 'TLS_AES_256_GCM_SHA384': [ | 
|  | 214 | 'AES-256-GCM', | 
|  | 215 | 'SHA384', | 
|  | 216 | 'AEAD'], | 
|  | 217 | 'TLS_AES_128_GCM_SHA256': [ | 
|  | 218 | 'AES-128-GCM', | 
|  | 219 | 'SHA256', | 
|  | 220 | 'AEAD'], | 
|  | 221 | 'TLS_CHACHA20_POLY1305_SHA256': [ | 
|  | 222 | 'CHACHA20-POLY1305', | 
|  | 223 | 'SHA256', | 
|  | 224 | 'AEAD'], | 
|  | 225 | 'TLS_AES_128_CCM_SHA256': [ | 
|  | 226 | 'AES-128-CCM', | 
|  | 227 | 'SHA256', | 
|  | 228 | 'AEAD'], | 
|  | 229 | 'TLS_AES_128_CCM_8_SHA256': [ | 
|  | 230 | 'AES-128-CCM-8', | 
|  | 231 | 'SHA256', | 
|  | 232 | 'AEAD']} | 
|  | 233 |  | 
|  | 234 | SIGNATURE_ALGORITHM = { | 
|  | 235 | 'ecdsa_secp256r1_sha256': ['SIGN-ECDSA-SECP256R1-SHA256'], | 
|  | 236 | 'ecdsa_secp521r1_sha512': ['SIGN-ECDSA-SECP521R1-SHA512'], | 
|  | 237 | 'ecdsa_secp384r1_sha384': ['SIGN-ECDSA-SECP384R1-SHA384'], | 
|  | 238 | 'rsa_pss_rsae_sha256': ['SIGN-RSA-PSS-RSAE-SHA256']} | 
|  | 239 |  | 
|  | 240 | NAMED_GROUP = { | 
|  | 241 | 'secp256r1': ['GROUP-SECP256R1'], | 
|  | 242 | 'secp384r1': ['GROUP-SECP384R1'], | 
|  | 243 | 'secp521r1': ['GROUP-SECP521R1'], | 
|  | 244 | 'x25519': ['GROUP-X25519'], | 
|  | 245 | 'x448': ['GROUP-X448'], | 
| Przemek Stekiel | ae3209c | 2023-06-13 15:09:03 +0200 | [diff] [blame] | 246 | 'ffdhe2048': ['GROUP-FFDHE2048'], | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 247 | } | 
|  | 248 |  | 
|  | 249 | def pre_checks(self): | 
|  | 250 | return ["requires_gnutls_tls1_3", | 
|  | 251 | "requires_gnutls_next_no_ticket", | 
|  | 252 | "requires_gnutls_next_disable_tls13_compat", ] | 
|  | 253 |  | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 254 | def cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 255 | ret = super().cmd() | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 256 |  | 
|  | 257 | priority_string_list = [] | 
|  | 258 |  | 
|  | 259 | def update_priority_string_list(items, map_table): | 
|  | 260 | for item in items: | 
|  | 261 | for i in map_table[item]: | 
|  | 262 | if i not in priority_string_list: | 
|  | 263 | yield i | 
|  | 264 |  | 
|  | 265 | if self._ciphers: | 
|  | 266 | priority_string_list.extend(update_priority_string_list( | 
|  | 267 | self._ciphers, self.CIPHER_SUITE)) | 
|  | 268 | else: | 
|  | 269 | priority_string_list.extend(['CIPHER-ALL', 'MAC-ALL']) | 
|  | 270 |  | 
|  | 271 | if self._sig_algs: | 
|  | 272 | signature_algorithms = set(self._sig_algs + self._cert_sig_algs) | 
|  | 273 | priority_string_list.extend(update_priority_string_list( | 
|  | 274 | signature_algorithms, self.SIGNATURE_ALGORITHM)) | 
|  | 275 | else: | 
|  | 276 | priority_string_list.append('SIGN-ALL') | 
|  | 277 |  | 
|  | 278 |  | 
|  | 279 | if self._named_groups: | 
|  | 280 | priority_string_list.extend(update_priority_string_list( | 
|  | 281 | self._named_groups, self.NAMED_GROUP)) | 
|  | 282 | else: | 
|  | 283 | priority_string_list.append('GROUP-ALL') | 
|  | 284 |  | 
|  | 285 | priority_string_list = ['NONE'] + \ | 
|  | 286 | priority_string_list + ['VERS-TLS1.3'] | 
|  | 287 |  | 
|  | 288 | priority_string = ':+'.join(priority_string_list) | 
|  | 289 | priority_string += ':%NO_TICKETS' | 
|  | 290 |  | 
|  | 291 | if not self._compat_mode: | 
|  | 292 | priority_string += [':%DISABLE_TLS13_COMPAT_MODE'] | 
|  | 293 |  | 
|  | 294 | ret += ['--priority={priority_string}'.format( | 
|  | 295 | priority_string=priority_string)] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 296 | return ret | 
|  | 297 |  | 
|  | 298 | class GnuTLSServ(GnuTLSBase): | 
|  | 299 | """ | 
|  | 300 | Generate test commands for GnuTLS server. | 
|  | 301 | """ | 
|  | 302 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 303 | def pre_cmd(self): | 
|  | 304 | ret = ['$G_NEXT_SRV_NO_CERT', '--http', '--disable-client-cert', '--debug=4'] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 305 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 306 | for _, cert, key in map(lambda sig_alg: CERTIFICATES[sig_alg], self._cert_sig_algs): | 
|  | 307 | ret += ['--x509certfile {cert} --x509keyfile {key}'.format( | 
|  | 308 | cert=cert, key=key)] | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 309 | return ret | 
|  | 310 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 311 | def post_checks(self): | 
|  | 312 | return ['-c "HTTP/1.0 200 OK"'] | 
|  | 313 |  | 
|  | 314 |  | 
|  | 315 | class GnuTLSCli(GnuTLSBase): | 
|  | 316 | """ | 
|  | 317 | Generate test commands for GnuTLS client. | 
|  | 318 | """ | 
|  | 319 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 320 | def pre_cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 321 | return ['$G_NEXT_CLI_NO_CERT', '--debug=4', '--single-key-share', | 
|  | 322 | '--x509cafile {cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)] | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 323 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 324 |  | 
|  | 325 | class MbedTLSBase(TLSProgram): | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 326 | """ | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 327 | Generate base test commands for mbedTLS. | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 328 | """ | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 329 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 330 | 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 Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 337 | def cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 338 | ret = super().cmd() | 
|  | 339 | ret += ['debug_level=4'] | 
|  | 340 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 341 |  | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 342 | if self._ciphers: | 
|  | 343 | ciphers = ','.join( | 
|  | 344 | map(lambda cipher: self.CIPHER_SUITE[cipher], self._ciphers)) | 
|  | 345 | ret += ["force_ciphersuite={ciphers}".format(ciphers=ciphers)] | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 346 |  | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 347 | if self._sig_algs + self._cert_sig_algs: | 
|  | 348 | ret += ['sig_algs={sig_algs}'.format( | 
|  | 349 | sig_algs=','.join(set(self._sig_algs + self._cert_sig_algs)))] | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 350 |  | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 351 | if self._named_groups: | 
| XiaokangQian | 8031ba7 | 2022-03-22 12:53:45 +0000 | [diff] [blame] | 352 | named_groups = ','.join(self._named_groups) | 
| Przemek Stekiel | 45255e4 | 2023-06-29 13:56:36 +0200 | [diff] [blame] | 353 | ret += ["groups={named_groups}".format(named_groups=named_groups)] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 354 | return ret | 
|  | 355 |  | 
| Valerio Setti | 18371ee | 2024-01-18 09:49:39 +0100 | [diff] [blame] | 356 | #pylint: disable=missing-function-docstring | 
|  | 357 | def add_ffdh_group_requirements(self, requirement_list): | 
|  | 358 | if 'ffdhe2048' in self._named_groups: | 
|  | 359 | requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048') | 
|  | 360 | if 'ffdhe3072' in self._named_groups: | 
|  | 361 | requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048') | 
|  | 362 | if 'ffdhe4096' in self._named_groups: | 
|  | 363 | requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048') | 
|  | 364 | if 'ffdhe6144' in self._named_groups: | 
|  | 365 | requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048') | 
|  | 366 | if 'ffdhe8192' in self._named_groups: | 
|  | 367 | requirement_list.append('requires_config_enabled PSA_WANT_DH_RFC7919_2048') | 
|  | 368 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 369 | def pre_checks(self): | 
|  | 370 | ret = ['requires_config_enabled MBEDTLS_DEBUG_C', | 
| Ronald Cron | 928cbd3 | 2022-10-04 16:14:26 +0200 | [diff] [blame] | 371 | 'requires_config_enabled MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED'] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 372 |  | 
|  | 373 | if self._compat_mode: | 
|  | 374 | ret += ['requires_config_enabled MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE'] | 
|  | 375 |  | 
|  | 376 | if 'rsa_pss_rsae_sha256' in self._sig_algs + self._cert_sig_algs: | 
|  | 377 | ret.append( | 
|  | 378 | 'requires_config_enabled MBEDTLS_X509_RSASSA_PSS_SUPPORT') | 
| Przemek Stekiel | 1f5c2ba | 2023-06-15 17:04:44 +0200 | [diff] [blame] | 379 |  | 
|  | 380 | ec_groups = ['secp256r1', 'secp384r1', 'secp521r1', 'x25519', 'x448'] | 
| Valerio Setti | 18371ee | 2024-01-18 09:49:39 +0100 | [diff] [blame] | 381 | ffdh_groups = ['ffdhe2048', 'ffdhe3072', 'ffdhe4096', 'ffdhe6144', 'ffdhe8192'] | 
| Przemek Stekiel | 1f5c2ba | 2023-06-15 17:04:44 +0200 | [diff] [blame] | 382 |  | 
|  | 383 | if any(x in ec_groups for x in self._named_groups): | 
| Przemek Stekiel | c31a798 | 2023-06-27 10:53:33 +0200 | [diff] [blame] | 384 | ret.append('requires_config_enabled PSA_WANT_ALG_ECDH') | 
|  | 385 |  | 
|  | 386 | if any(x in ffdh_groups for x in self._named_groups): | 
|  | 387 | ret.append('requires_config_enabled PSA_WANT_ALG_FFDH') | 
| Valerio Setti | 18371ee | 2024-01-18 09:49:39 +0100 | [diff] [blame] | 388 | self.add_ffdh_group_requirements(ret) | 
| Przemek Stekiel | 1f5c2ba | 2023-06-15 17:04:44 +0200 | [diff] [blame] | 389 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 390 | return ret | 
|  | 391 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 392 |  | 
|  | 393 | class MbedTLSServ(MbedTLSBase): | 
|  | 394 | """ | 
|  | 395 | Generate test commands for mbedTLS server. | 
|  | 396 | """ | 
|  | 397 |  | 
|  | 398 | def cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 399 | ret = super().cmd() | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 400 | ret += ['tls13_kex_modes=ephemeral cookies=0 tickets=0'] | 
| Jerry Yu | 7918efe | 2021-12-01 15:29:10 +0800 | [diff] [blame] | 401 | return ret | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 402 |  | 
|  | 403 | def pre_checks(self): | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 404 | return ['requires_config_enabled MBEDTLS_SSL_SRV_C'] + super().pre_checks() | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 405 |  | 
|  | 406 | def post_checks(self): | 
| Ronald Cron | a1b8f6e | 2022-03-18 14:04:12 +0100 | [diff] [blame] | 407 | check_strings = ["Protocol is TLSv1.3"] | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 408 | if self._ciphers: | 
|  | 409 | check_strings.append( | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 410 | "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 Cron | eac00ad | 2022-09-13 10:16:31 +0200 | [diff] [blame] | 423 | check_strings.append("Certificate verification was skipped") | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 424 | return ['-s "{}"'.format(i) for i in check_strings] | 
|  | 425 |  | 
|  | 426 | def pre_cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 427 | 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 | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 431 |  | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 432 | def hrr_post_checks(self, named_group): | 
|  | 433 | return ['-s "HRR selected_group: {:s}"'.format(named_group)] | 
|  | 434 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 435 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 436 | class MbedTLSCli(MbedTLSBase): | 
|  | 437 | """ | 
|  | 438 | Generate test commands for mbedTLS client. | 
|  | 439 | """ | 
|  | 440 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 441 | def pre_cmd(self): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 442 | return ['$P_CLI', | 
|  | 443 | 'ca_file={cafile}'.format(cafile=CERTIFICATES[self._cert_sig_algs[0]].cafile)] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 444 |  | 
|  | 445 | def pre_checks(self): | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 446 | return ['requires_config_enabled MBEDTLS_SSL_CLI_C'] + super().pre_checks() | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 447 |  | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 448 | 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])] | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 451 | return ret | 
|  | 452 |  | 
|  | 453 | def post_checks(self): | 
|  | 454 | check_strings = ["Protocol is TLSv1.3"] | 
|  | 455 | if self._ciphers: | 
|  | 456 | check_strings.append( | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 457 | "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 Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 471 | return ['-c "{}"'.format(i) for i in check_strings] | 
|  | 472 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 473 |  | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 474 | SERVER_CLASSES = {'OpenSSL': OpenSSLServ, 'GnuTLS': GnuTLSServ, 'mbedTLS': MbedTLSServ} | 
|  | 475 | CLIENT_CLASSES = {'OpenSSL': OpenSSLCli, 'GnuTLS': GnuTLSCli, 'mbedTLS': MbedTLSCli} | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 476 |  | 
|  | 477 |  | 
| Ronald Cron | 9d0a3e8 | 2022-04-05 16:13:38 +0200 | [diff] [blame] | 478 | def generate_compat_test(client=None, server=None, cipher=None, named_group=None, sig_alg=None): | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 479 | """ | 
|  | 480 | Generate test case with `ssl-opt.sh` format. | 
|  | 481 | """ | 
| Jerry Yu | dda036d | 2021-11-30 11:19:41 +0800 | [diff] [blame] | 482 | name = 'TLS 1.3 {client[0]}->{server[0]}: {cipher},{named_group},{sig_alg}'.format( | 
| Ronald Cron | df5f868 | 2022-04-05 16:01:03 +0200 | [diff] [blame] | 483 | client=client, server=server, cipher=cipher[4:], sig_alg=sig_alg, named_group=named_group) | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 484 |  | 
|  | 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 Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 493 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 494 | cmd = ['run_test "{}"'.format(name), | 
|  | 495 | '"{}"'.format(' '.join(server_object.cmd())), | 
|  | 496 | '"{}"'.format(' '.join(client_object.cmd())), | 
|  | 497 | '0'] | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 498 | 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 Cron | 9d0a3e8 | 2022-04-05 16:13:38 +0200 | [diff] [blame] | 506 | def generate_hrr_compat_test(client=None, server=None, | 
|  | 507 | client_named_group=None, server_named_group=None, | 
|  | 508 | cert_sig_alg=None): | 
| XiaokangQian | 7069cbc | 2022-02-24 08:30:39 +0000 | [diff] [blame] | 509 | """ | 
| XiaokangQian | eff93f9 | 2022-03-23 06:14:26 +0000 | [diff] [blame] | 510 | Generate Hello Retry Request test case with `ssl-opt.sh` format. | 
| XiaokangQian | 7069cbc | 2022-02-24 08:30:39 +0000 | [diff] [blame] | 511 | """ | 
| XiaokangQian | eff93f9 | 2022-03-23 06:14:26 +0000 | [diff] [blame] | 512 | name = 'TLS 1.3 {client[0]}->{server[0]}: HRR {c_named_group} -> {s_named_group}'.format( | 
| XiaokangQian | 2e17fb8 | 2022-03-28 03:30:05 +0000 | [diff] [blame] | 513 | 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) | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 517 |  | 
| XiaokangQian | 2e17fb8 | 2022-03-28 03:30:05 +0000 | [diff] [blame] | 518 | client_object = CLIENT_CLASSES[client](named_group=client_named_group, | 
|  | 519 | cert_sig_alg=cert_sig_alg) | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 520 | client_object.add_named_groups(server_named_group) | 
| XiaokangQian | 7069cbc | 2022-02-24 08:30:39 +0000 | [diff] [blame] | 521 |  | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 522 | cmd = ['run_test "{}"'.format(name), | 
|  | 523 | '"{}"'.format(' '.join(server_object.cmd())), | 
|  | 524 | '"{}"'.format(' '.join(client_object.cmd())), | 
|  | 525 | '0'] | 
| XiaokangQian | 7069cbc | 2022-02-24 08:30:39 +0000 | [diff] [blame] | 526 | cmd += server_object.post_checks() | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 527 | cmd += client_object.post_checks() | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 528 | cmd += server_object.hrr_post_checks(server_named_group) | 
|  | 529 | cmd += client_object.hrr_post_checks(server_named_group) | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 530 | prefix = ' \\\n' + (' '*9) | 
|  | 531 | cmd = prefix.join(cmd) | 
|  | 532 | return '\n'.join(server_object.pre_checks() + | 
|  | 533 | client_object.pre_checks() + | 
|  | 534 | [cmd]) | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 535 |  | 
|  | 536 | SSL_OUTPUT_HEADER = '''#!/bin/sh | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 537 |  | 
|  | 538 | # {filename} | 
|  | 539 | # | 
|  | 540 | # Copyright The Mbed TLS Contributors | 
| Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 541 | # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 542 | # | 
|  | 543 | # Purpose | 
|  | 544 | # | 
|  | 545 | # List TLS1.3 compat test cases. They are generated by | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 546 | # `{cmd}`. | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 547 | # | 
|  | 548 | # PLEASE DO NOT EDIT THIS FILE. IF NEEDED, PLEASE MODIFY `generate_tls13_compat_tests.py` | 
|  | 549 | # AND REGENERATE THIS FILE. | 
|  | 550 | # | 
|  | 551 | ''' | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 552 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 553 | def main(): | 
| Jerry Yu | dda036d | 2021-11-30 11:19:41 +0800 | [diff] [blame] | 554 | """ | 
|  | 555 | Main function of this program | 
|  | 556 | """ | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 557 | parser = argparse.ArgumentParser() | 
|  | 558 |  | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 559 | parser.add_argument('-o', '--output', nargs='?', | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 560 | default=None, help='Output file path if `-a` was set') | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 561 |  | 
| Jerry Yu | c4aa152 | 2021-11-26 11:13:58 +0800 | [diff] [blame] | 562 | parser.add_argument('-a', '--generate-all-tls13-compat-tests', action='store_true', | 
|  | 563 | default=False, help='Generate all available tls13 compat tests') | 
|  | 564 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 565 | parser.add_argument('--list-ciphers', action='store_true', | 
|  | 566 | default=False, help='List supported ciphersuites') | 
|  | 567 |  | 
|  | 568 | parser.add_argument('--list-sig-algs', action='store_true', | 
|  | 569 | default=False, help='List supported signature algorithms') | 
|  | 570 |  | 
|  | 571 | parser.add_argument('--list-named-groups', action='store_true', | 
|  | 572 | default=False, help='List supported named groups') | 
|  | 573 |  | 
|  | 574 | parser.add_argument('--list-servers', action='store_true', | 
|  | 575 | default=False, help='List supported TLS servers') | 
|  | 576 |  | 
|  | 577 | parser.add_argument('--list-clients', action='store_true', | 
|  | 578 | default=False, help='List supported TLS Clients') | 
|  | 579 |  | 
| Jerry Yu | b4ac8f3 | 2021-12-01 10:41:37 +0800 | [diff] [blame] | 580 | parser.add_argument('server', choices=SERVER_CLASSES.keys(), nargs='?', | 
|  | 581 | default=list(SERVER_CLASSES.keys())[0], | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 582 | help='Choose TLS server program for test') | 
| Jerry Yu | b4ac8f3 | 2021-12-01 10:41:37 +0800 | [diff] [blame] | 583 | parser.add_argument('client', choices=CLIENT_CLASSES.keys(), nargs='?', | 
|  | 584 | default=list(CLIENT_CLASSES.keys())[0], | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 585 | help='Choose TLS client program for test') | 
|  | 586 | parser.add_argument('cipher', choices=CIPHER_SUITE_IANA_VALUE.keys(), nargs='?', | 
|  | 587 | default=list(CIPHER_SUITE_IANA_VALUE.keys())[0], | 
|  | 588 | help='Choose cipher suite for test') | 
|  | 589 | parser.add_argument('sig_alg', choices=SIG_ALG_IANA_VALUE.keys(), nargs='?', | 
|  | 590 | default=list(SIG_ALG_IANA_VALUE.keys())[0], | 
|  | 591 | help='Choose cipher suite for test') | 
|  | 592 | parser.add_argument('named_group', choices=NAMED_GROUP_IANA_VALUE.keys(), nargs='?', | 
|  | 593 | default=list(NAMED_GROUP_IANA_VALUE.keys())[0], | 
|  | 594 | help='Choose cipher suite for test') | 
|  | 595 |  | 
|  | 596 | args = parser.parse_args() | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 597 |  | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 598 | def get_all_test_cases(): | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 599 | # Generate normal compat test cases | 
| Ronald Cron | 9d0a3e8 | 2022-04-05 16:13:38 +0200 | [diff] [blame] | 600 | for client, server, cipher, named_group, sig_alg in \ | 
|  | 601 | itertools.product(CLIENT_CLASSES.keys(), | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 602 | SERVER_CLASSES.keys(), | 
| Ronald Cron | 9d0a3e8 | 2022-04-05 16:13:38 +0200 | [diff] [blame] | 603 | CIPHER_SUITE_IANA_VALUE.keys(), | 
|  | 604 | NAMED_GROUP_IANA_VALUE.keys(), | 
|  | 605 | SIG_ALG_IANA_VALUE.keys()): | 
| XiaokangQian | fb1a3fe | 2022-06-09 06:37:33 +0000 | [diff] [blame] | 606 | if server == 'mbedTLS' or client == 'mbedTLS': | 
| XiaokangQian | b1847a2 | 2022-06-08 07:49:31 +0000 | [diff] [blame] | 607 | yield generate_compat_test(client=client, server=server, | 
| XiaokangQian | fb1a3fe | 2022-06-09 06:37:33 +0000 | [diff] [blame] | 608 | cipher=cipher, named_group=named_group, | 
|  | 609 | sig_alg=sig_alg) | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 610 |  | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 611 |  | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 612 | # Generate Hello Retry Request  compat test cases | 
| XiaokangQian | 2e17fb8 | 2022-03-28 03:30:05 +0000 | [diff] [blame] | 613 | for client, server, client_named_group, server_named_group in \ | 
|  | 614 | itertools.product(CLIENT_CLASSES.keys(), | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 615 | SERVER_CLASSES.keys(), | 
| XiaokangQian | 2e17fb8 | 2022-03-28 03:30:05 +0000 | [diff] [blame] | 616 | NAMED_GROUP_IANA_VALUE.keys(), | 
|  | 617 | NAMED_GROUP_IANA_VALUE.keys()): | 
| Jerry Yu | b7c12a4 | 2022-06-12 20:53:02 +0800 | [diff] [blame] | 618 |  | 
| XiaokangQian | 9b938b7 | 2022-06-10 03:10:59 +0000 | [diff] [blame] | 619 | if (client == 'mbedTLS' or server == 'mbedTLS') and \ | 
|  | 620 | client_named_group != server_named_group: | 
|  | 621 | yield generate_hrr_compat_test(client=client, server=server, | 
|  | 622 | client_named_group=client_named_group, | 
|  | 623 | server_named_group=server_named_group, | 
|  | 624 | cert_sig_alg="ecdsa_secp256r1_sha256") | 
| XiaokangQian | d5d5b60 | 2022-05-23 09:16:20 +0000 | [diff] [blame] | 625 |  | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 626 | if args.generate_all_tls13_compat_tests: | 
|  | 627 | if args.output: | 
|  | 628 | with open(args.output, 'w', encoding="utf-8") as f: | 
| Jerry Yu | b4ac8f3 | 2021-12-01 10:41:37 +0800 | [diff] [blame] | 629 | f.write(SSL_OUTPUT_HEADER.format( | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 630 | filename=os.path.basename(args.output), cmd=' '.join(sys.argv))) | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 631 | f.write('\n\n'.join(get_all_test_cases())) | 
| Jerry Yu | dda036d | 2021-11-30 11:19:41 +0800 | [diff] [blame] | 632 | f.write('\n') | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 633 | else: | 
| Jerry Yu | 7de7985 | 2022-03-23 16:50:47 +0800 | [diff] [blame] | 634 | print('\n\n'.join(get_all_test_cases())) | 
| Jerry Yu | c4aa152 | 2021-11-26 11:13:58 +0800 | [diff] [blame] | 635 | return 0 | 
|  | 636 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 637 | if args.list_ciphers or args.list_sig_algs or args.list_named_groups \ | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 638 | or args.list_servers or args.list_clients: | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 639 | if args.list_ciphers: | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 640 | print(*CIPHER_SUITE_IANA_VALUE.keys()) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 641 | if args.list_sig_algs: | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 642 | print(*SIG_ALG_IANA_VALUE.keys()) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 643 | if args.list_named_groups: | 
| Jerry Yu | 7f5e5ad | 2021-11-29 17:37:19 +0800 | [diff] [blame] | 644 | print(*NAMED_GROUP_IANA_VALUE.keys()) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 645 | if args.list_servers: | 
| Jerry Yu | b4ac8f3 | 2021-12-01 10:41:37 +0800 | [diff] [blame] | 646 | print(*SERVER_CLASSES.keys()) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 647 | if args.list_clients: | 
| Jerry Yu | b4ac8f3 | 2021-12-01 10:41:37 +0800 | [diff] [blame] | 648 | print(*CLIENT_CLASSES.keys()) | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 649 | return 0 | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 650 |  | 
| XiaokangQian | a193144 | 2022-03-25 11:58:22 +0000 | [diff] [blame] | 651 | print(generate_compat_test(server=args.server, client=args.client, sig_alg=args.sig_alg, | 
|  | 652 | cipher=args.cipher, named_group=args.named_group)) | 
| Jerry Yu | cdcb683 | 2021-11-29 16:50:13 +0800 | [diff] [blame] | 653 | return 0 | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 654 |  | 
| Jerry Yu | 29deed4 | 2021-11-25 11:09:54 +0800 | [diff] [blame] | 655 |  | 
| Jerry Yu | 305bfc3 | 2021-11-24 16:04:47 +0800 | [diff] [blame] | 656 | if __name__ == "__main__": | 
|  | 657 | sys.exit(main()) |