|
| 1 | +import asyncio |
| 2 | +import unittest |
| 3 | +import os |
| 4 | + |
| 5 | +import asynctnt |
| 6 | +from asynctnt.exceptions import SSLError |
| 7 | +from asynctnt.instance import TarantoolSyncInstance |
| 8 | +from tests import BaseTarantoolTestCase |
| 9 | + |
| 10 | +def is_test_ssl(): |
| 11 | + env = os.getenv("TEST_TT_SSL") |
| 12 | + if env: |
| 13 | + env = env.upper() |
| 14 | + return env == "1" or env == "TRUE" |
| 15 | + return False |
| 16 | + |
| 17 | + |
| 18 | +@unittest.skipIf(not is_test_ssl(), "TEST_TT_SSL is not set.") |
| 19 | +class SSLTestCase(BaseTarantoolTestCase): |
| 20 | + DO_CONNECT = False |
| 21 | + |
| 22 | + ssl_files_dir = os.path.join(os.getcwd(), 'tests', 'files', 'ssl') |
| 23 | + cert_file = os.path.join(ssl_files_dir, "localhost.crt") |
| 24 | + invalidhost_cert_file = os.path.join(ssl_files_dir, "invalidhost.crt") |
| 25 | + key_file = os.path.join(ssl_files_dir, "localhost.key") |
| 26 | + ca_file = os.path.join(ssl_files_dir, "ca.crt") |
| 27 | + empty_file = os.path.join(ssl_files_dir, "empty") |
| 28 | + invalid_file = "any_invalid_path" |
| 29 | + |
| 30 | + async def test__connect(self): |
| 31 | + class SslTestSubcase: |
| 32 | + def __init__(self, |
| 33 | + name="", |
| 34 | + expectSSLError=False, |
| 35 | + expectTimeoutError=False, |
| 36 | + server_transport=asynctnt.Transport.SSL, |
| 37 | + server_key_file=None, |
| 38 | + server_cert_file=None, |
| 39 | + server_ca_file=None, |
| 40 | + server_ciphers=None, |
| 41 | + client_transport=asynctnt.Transport.SSL, |
| 42 | + client_cert_file=None, |
| 43 | + client_key_file=None, |
| 44 | + client_ca_file=None, |
| 45 | + client_ciphers=None): |
| 46 | + self.name = name |
| 47 | + self.expectSSLError = expectSSLError |
| 48 | + self.expectTimeoutError = expectTimeoutError |
| 49 | + self.server_transport = server_transport |
| 50 | + self.server_key_file = server_key_file |
| 51 | + self.server_cert_file = server_cert_file |
| 52 | + self.server_ca_file = server_ca_file |
| 53 | + self.server_ciphers = server_ciphers |
| 54 | + self.client_transport = client_transport |
| 55 | + self.client_cert_file = client_cert_file |
| 56 | + self.client_key_file = client_key_file |
| 57 | + self.client_ca_file = client_ca_file |
| 58 | + self.client_ciphers = client_ciphers |
| 59 | + |
| 60 | + # Requirements from Tarantool Enterprise Edition manual: |
| 61 | + # https://www.tarantool.io/en/enterprise_doc/security/#configuration |
| 62 | + # |
| 63 | + # For a server: |
| 64 | + # ssl_key_file - mandatory |
| 65 | + # ssl_cert_file - mandatory |
| 66 | + # ssl_ca_file - optional |
| 67 | + # ssl_ciphers - optional |
| 68 | + # |
| 69 | + # For a client: |
| 70 | + # ssl_key_file - optional, mandatory if server.CaFile set |
| 71 | + # ssl_cert_file - optional, mandatory if server.CaFile set |
| 72 | + # ssl_ca_file - optional |
| 73 | + # ssl_ciphers - optional |
| 74 | + testcases = [ |
| 75 | + SslTestSubcase( |
| 76 | + name="no_ssl_server", |
| 77 | + expectSSLError=True, |
| 78 | + server_transport=asynctnt.Transport.DEFAULT), |
| 79 | + SslTestSubcase( |
| 80 | + name="key_crt_server", |
| 81 | + server_key_file=self.key_file, |
| 82 | + server_cert_file=self.cert_file), |
| 83 | + SslTestSubcase( |
| 84 | + name="no_ssl_client", |
| 85 | + expectTimeoutError=True, |
| 86 | + server_key_file=self.key_file, |
| 87 | + server_cert_file=self.cert_file, |
| 88 | + client_transport=asynctnt.Transport.DEFAULT), |
| 89 | + SslTestSubcase( |
| 90 | + name="key_crt_server_and_client", |
| 91 | + server_key_file=self.key_file, |
| 92 | + server_cert_file=self.cert_file, |
| 93 | + client_key_file=self.key_file, |
| 94 | + client_cert_file=self.cert_file), |
| 95 | + SslTestSubcase( |
| 96 | + name="key_crt_ca_server", |
| 97 | + expectSSLError=True, |
| 98 | + server_key_file=self.key_file, |
| 99 | + server_cert_file=self.cert_file, |
| 100 | + server_ca_file=self.ca_file), |
| 101 | + SslTestSubcase( |
| 102 | + name="key_crt_ca_server_and_crt_client", |
| 103 | + expectSSLError=True, |
| 104 | + server_key_file=self.key_file, |
| 105 | + server_cert_file=self.cert_file, |
| 106 | + server_ca_file=self.ca_file, |
| 107 | + client_cert_file=self.cert_file), |
| 108 | + SslTestSubcase( |
| 109 | + name="key_crt_ca_server_and_key_crt_client", |
| 110 | + server_key_file=self.key_file, |
| 111 | + server_cert_file=self.cert_file, |
| 112 | + server_ca_file=self.ca_file, |
| 113 | + client_key_file=self.key_file, |
| 114 | + client_cert_file=self.cert_file), |
| 115 | + SslTestSubcase( |
| 116 | + name="key_crt_ca_server_and_client", |
| 117 | + server_key_file=self.key_file, |
| 118 | + server_cert_file=self.cert_file, |
| 119 | + server_ca_file=self.ca_file, |
| 120 | + client_key_file=self.key_file, |
| 121 | + client_cert_file=self.cert_file, |
| 122 | + client_ca_file=self.ca_file), |
| 123 | + SslTestSubcase( |
| 124 | + name="key_invalidhost_crt_ca_server_and_key_crt_ca_client", |
| 125 | + # A Tarantool implementation does not check hostname. It's |
| 126 | + # the expected behavior. We don't do that too. |
| 127 | + server_key_file=self.key_file, |
| 128 | + server_cert_file=self.invalidhost_cert_file, |
| 129 | + server_ca_file=self.ca_file, |
| 130 | + client_key_file=self.key_file, |
| 131 | + client_cert_file=self.cert_file, |
| 132 | + client_ca_file=self.ca_file), |
| 133 | + SslTestSubcase( |
| 134 | + name="key_crt_ca_server_and_client_invalid_crt", |
| 135 | + expectSSLError=True, |
| 136 | + client_key_file=self.key_file, |
| 137 | + server_cert_file=self.cert_file, |
| 138 | + server_ca_file=self.ca_file, |
| 139 | + server_key_file=self.key_file, |
| 140 | + client_cert_file=self.invalid_file, |
| 141 | + client_ca_file=self.ca_file), |
| 142 | + SslTestSubcase( |
| 143 | + name="key_crt_ca_server_and_client_invalid_key", |
| 144 | + expectSSLError=True, |
| 145 | + server_key_file=self.key_file, |
| 146 | + server_cert_file=self.cert_file, |
| 147 | + server_ca_file=self.ca_file, |
| 148 | + client_key_file=self.invalid_file, |
| 149 | + client_cert_file=self.cert_file, |
| 150 | + client_ca_file=self.ca_file), |
| 151 | + SslTestSubcase( |
| 152 | + name="key_crt_ca_server_and_client_invalid_ca", |
| 153 | + expectSSLError=True, |
| 154 | + server_key_file=self.key_file, |
| 155 | + server_cert_file=self.cert_file, |
| 156 | + server_ca_file=self.ca_file, |
| 157 | + client_key_file=self.key_file, |
| 158 | + client_cert_file=self.cert_file, |
| 159 | + client_ca_file=self.invalid_file), |
| 160 | + SslTestSubcase( |
| 161 | + name="key_crt_ca_server_and_client_empty_crt", |
| 162 | + expectSSLError=True, |
| 163 | + server_key_file=self.key_file, |
| 164 | + server_cert_file=self.cert_file, |
| 165 | + server_ca_file=self.ca_file, |
| 166 | + client_key_file=self.key_file, |
| 167 | + client_cert_file=self.empty_file, |
| 168 | + client_ca_file=self.ca_file), |
| 169 | + SslTestSubcase( |
| 170 | + name="key_crt_ca_server_and_client_empty_key", |
| 171 | + expectSSLError=True, |
| 172 | + server_key_file=self.key_file, |
| 173 | + server_cert_file=self.cert_file, |
| 174 | + server_ca_file=self.ca_file, |
| 175 | + client_key_file=self.empty_file, |
| 176 | + client_cert_file=self.cert_file, |
| 177 | + client_ca_file=self.ca_file), |
| 178 | + SslTestSubcase( |
| 179 | + name="key_crt_ca_server_and_client_empty_ca", |
| 180 | + expectSSLError=True, |
| 181 | + server_key_file=self.key_file, |
| 182 | + server_cert_file=self.cert_file, |
| 183 | + server_ca_file=self.ca_file, |
| 184 | + client_key_file=self.key_file, |
| 185 | + client_cert_file=self.cert_file, |
| 186 | + client_ca_file=self.empty_file), |
| 187 | + SslTestSubcase( |
| 188 | + name="key_crt_ca_ciphers_server_and_key_crt_ca_client", |
| 189 | + server_key_file=self.key_file, |
| 190 | + server_cert_file=self.cert_file, |
| 191 | + server_ca_file=self.ca_file, |
| 192 | + server_ciphers="ECDHE-RSA-AES256-GCM-SHA384", |
| 193 | + client_key_file=self.key_file, |
| 194 | + client_cert_file=self.cert_file, |
| 195 | + client_ca_file=self.ca_file), |
| 196 | + SslTestSubcase( |
| 197 | + name="key_crt_ca_ciphers_server_and_client", |
| 198 | + server_key_file=self.key_file, |
| 199 | + server_cert_file=self.cert_file, |
| 200 | + server_ca_file=self.ca_file, |
| 201 | + server_ciphers="ECDHE-RSA-AES256-GCM-SHA384", |
| 202 | + client_key_file=self.key_file, |
| 203 | + client_cert_file=self.cert_file, |
| 204 | + client_ca_file=self.ca_file, |
| 205 | + client_ciphers="ECDHE-RSA-AES256-GCM-SHA384"), |
| 206 | + SslTestSubcase( |
| 207 | + name="non_equal_ciphers", |
| 208 | + expectSSLError=True, |
| 209 | + server_key_file=self.key_file, |
| 210 | + server_cert_file=self.cert_file, |
| 211 | + server_ca_file=self.ca_file, |
| 212 | + server_ciphers="ECDHE-RSA-AES256-GCM-SHA384", |
| 213 | + client_key_file=self.key_file, |
| 214 | + client_cert_file=self.cert_file, |
| 215 | + client_ca_file=self.ca_file, |
| 216 | + client_ciphers="TLS_AES_128_GCM_SHA256"), |
| 217 | + ] |
| 218 | + for t in testcases: |
| 219 | + with self.subTest(msg=t.name): |
| 220 | + if self.in_docker: |
| 221 | + self.skipTest('Skipping as running inside the docker') |
| 222 | + return |
| 223 | + |
| 224 | + tnt = TarantoolSyncInstance( |
| 225 | + port=TarantoolSyncInstance.get_random_port(), |
| 226 | + transport=t.server_transport, |
| 227 | + ssl_key_file=t.server_key_file, |
| 228 | + ssl_cert_file=t.server_cert_file, |
| 229 | + ssl_ca_file=t.server_ca_file, |
| 230 | + ssl_ciphers=t.server_ciphers, |
| 231 | + applua=self.read_applua(), |
| 232 | + cleanup=self.TNT_CLEANUP, |
| 233 | + ) |
| 234 | + |
| 235 | + tnt.start() |
| 236 | + try: |
| 237 | + conn = await asynctnt.connect(host=tnt.host, port=tnt.port, |
| 238 | + transport=t.client_transport, |
| 239 | + ssl_key_file=t.client_key_file, |
| 240 | + ssl_cert_file=t.client_cert_file, |
| 241 | + ssl_ca_file=t.client_ca_file, |
| 242 | + ssl_ciphers=t.client_ciphers, |
| 243 | + reconnect_timeout=0) |
| 244 | + |
| 245 | + tupl = [1, 'hello', 1, 4, 'what is up'] |
| 246 | + await conn.insert(self.TESTER_SPACE_ID, tupl) |
| 247 | + res = await conn.select(self.TESTER_SPACE_NAME, tupl[0:1]) |
| 248 | + self.assertResponseEqual(res[0], tupl, 'Tuple ok') |
| 249 | + except SSLError as e: |
| 250 | + if not t.expectSSLError: |
| 251 | + self.fail(e) |
| 252 | + except asyncio.exceptions.TimeoutError as e: |
| 253 | + if not t.expectTimeoutError: |
| 254 | + self.fail(e) |
| 255 | + except Exception as e: |
| 256 | + self.fail(e) |
| 257 | + finally: |
| 258 | + tnt.stop() |
0 commit comments