1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0.
from test import NativeResourceTest, TIMEOUT
from awscrt.http import HttpProxyOptions, HttpProxyAuthenticationType, HttpProxyConnectionType, HttpClientConnection, HttpRequest
from awscrt.io import ClientTlsContext, TlsContextOptions, ClientBootstrap, ClientTlsContext, DefaultHostResolver, EventLoopGroup
from awscrt.mqtt import Client, Connection
from awscrt.auth import AwsCredentialsProvider
import os
import unittest
from test.test_http_client import Response
from test.test_mqtt import create_client_id
"""
# AWS_TEST_HTTP_PROXY_HOST - host address of the proxy to use for tests that make open connections to the proxy
# AWS_TEST_HTTP_PROXY_PORT - port to use for tests that make open connections to the proxy
# AWS_TEST_HTTPS_PROXY_HOST - host address of the proxy to use for tests that make tls-protected connections to the
proxy
# AWS_TEST_HTTPS_PROXY_PORT - port to use for tests that make tls-protected connections to the proxy
# AWS_TEST_HTTP_PROXY_BASIC_HOST - host address of the proxy to use for tests that make open connections to the proxy
with basic authentication
# AWS_TEST_HTTP_PROXY_BASIC_PORT - port to use for tests that make open connections to the proxy with basic
authentication
# AWS_TEST_BASIC_AUTH_USERNAME - username to use when using basic authentication to the proxy
# AWS_TEST_BASIC_AUTH_PASSWORD - password to use when using basic authentication to the proxy
# AWS_TEST_TLS_CERT_PATH - file path to certificate used to initialize the tls context of the mqtt connection
# AWS_TEST_TLS_KEY_PATH - file path to the key used to initialize the tls context of the mqtt connection
# AWS_TEST_TLS_ROOT_CERT_PATH - file path to the root CA used to initialize the tls context of the mqtt connection
# AWS_TEST_X509_ENDPOINT - AWS account-specific endpoint to source x509 credentials from
# AWS_TEST_X509_THING_NAME - associated name of the x509 thing
# AWS_TEST_X509_ROLE_ALIAS - associated role alias ...
# AWS_TEST_IOT_MQTT_ENDPOINT - AWS account-specific endpoint to connect to IoT core by
"""
class ProxyTestType:
FORWARDING = 0
TUNNELING_HTTP = 1
TUNNELING_HTTPS = 2
TUNNELING_DOUBLE_TLS = 3
LEGACY_HTTP = 4
LEGACY_HTTPS = 5
class ProxyTestConfiguration():
HTTP_PROXY_HOST = os.environ.get('AWS_TEST_HTTP_PROXY_HOST')
HTTP_PROXY_PORT = int(os.environ.get('AWS_TEST_HTTP_PROXY_PORT', '0'))
HTTPS_PROXY_HOST = os.environ.get('AWS_TEST_HTTPS_PROXY_HOST')
HTTPS_PROXY_PORT = int(os.environ.get('AWS_TEST_HTTPS_PROXY_PORT', '0'))
HTTP_PROXY_BASIC_HOST = os.environ.get('AWS_TEST_HTTP_PROXY_BASIC_HOST')
HTTP_PROXY_BASIC_PORT = int(os.environ.get('AWS_TEST_HTTP_PROXY_BASIC_PORT', '0'))
HTTP_PROXY_BASIC_AUTH_USERNAME = os.environ.get('AWS_TEST_BASIC_AUTH_USERNAME')
HTTP_PROXY_BASIC_AUTH_PASSWORD = os.environ.get('AWS_TEST_BASIC_AUTH_PASSWORD')
HTTP_PROXY_TLS_CERT_PATH = os.environ.get('AWS_TEST_MQTT311_IOT_CORE_RSA_CERT')
HTTP_PROXY_TLS_KEY_PATH = os.environ.get('AWS_TEST_MQTT311_IOT_CORE_RSA_KEY')
HTTP_PROXY_TLS_ROOT_CA_PATH = os.environ.get('AWS_TEST_MQTT311_ROOT_CA')
X509_CREDENTIALS_ENDPOINT = os.environ.get("AWS_TEST_X509_ENDPOINT")
X509_CREDENTIALS_THING_NAME = os.environ.get("AWS_TEST_X509_THING_NAME")
X509_CREDENTIALS_ROLE_ALIAS = os.environ.get("AWS_TEST_X509_ROLE_ALIAS")
HTTP_PROXY_MQTT_ENDPOINT = os.environ.get('AWS_TEST_MQTT311_IOT_CORE_HOST')
@staticmethod
def is_proxy_environment_initialized():
return ProxyTestConfiguration.HTTP_PROXY_HOST is not None and \
ProxyTestConfiguration.HTTP_PROXY_PORT > 0 and \
ProxyTestConfiguration.HTTPS_PROXY_HOST is not None and \
ProxyTestConfiguration.HTTPS_PROXY_PORT > 0 and \
ProxyTestConfiguration.HTTP_PROXY_BASIC_HOST is not None and \
ProxyTestConfiguration.HTTP_PROXY_BASIC_PORT > 0 and \
ProxyTestConfiguration.HTTP_PROXY_BASIC_AUTH_USERNAME is not None and \
ProxyTestConfiguration.HTTP_PROXY_BASIC_AUTH_PASSWORD is not None
@staticmethod
def is_mqtt_env_initialized():
return ProxyTestConfiguration.is_proxy_environment_initialized() and \
ProxyTestConfiguration.HTTP_PROXY_MQTT_ENDPOINT is not None and \
ProxyTestConfiguration.HTTP_PROXY_TLS_CERT_PATH is not None and \
ProxyTestConfiguration.HTTP_PROXY_TLS_KEY_PATH is not None and \
ProxyTestConfiguration.HTTP_PROXY_TLS_ROOT_CA_PATH is not None
@staticmethod
def is_x509_env_initialized():
return ProxyTestConfiguration.is_proxy_environment_initialized() and \
ProxyTestConfiguration.is_mqtt_env_initialized() and \
ProxyTestConfiguration.X509_CREDENTIALS_ENDPOINT is not None and \
ProxyTestConfiguration.X509_CREDENTIALS_THING_NAME is not None and \
ProxyTestConfiguration.X509_CREDENTIALS_ROLE_ALIAS is not None
@staticmethod
def get_proxy_host_for_test(test_type, auth_type):
if auth_type == HttpProxyAuthenticationType.Basic:
return ProxyTestConfiguration.HTTP_PROXY_BASIC_HOST
if test_type == ProxyTestType.TUNNELING_DOUBLE_TLS:
return ProxyTestConfiguration.HTTPS_PROXY_HOST
return ProxyTestConfiguration.HTTP_PROXY_HOST
@staticmethod
def get_proxy_port_for_test(test_type, auth_type):
if auth_type == HttpProxyAuthenticationType.Basic:
return ProxyTestConfiguration.HTTP_PROXY_BASIC_PORT
if test_type == ProxyTestType.TUNNELING_DOUBLE_TLS:
return ProxyTestConfiguration.HTTPS_PROXY_PORT
return ProxyTestConfiguration.HTTP_PROXY_PORT
@staticmethod
def get_proxy_connection_type_for_test(test_type):
if test_type == ProxyTestType.FORWARDING:
return HttpProxyConnectionType.Forwarding
elif test_type == ProxyTestType.TUNNELING_DOUBLE_TLS or \
test_type == ProxyTestType.TUNNELING_HTTP or \
test_type == ProxyTestType.TUNNELING_HTTPS:
return HttpProxyConnectionType.Tunneling
else:
return HttpProxyConnectionType.Legacy
@staticmethod
def get_proxy_tls_connection_options_for_test(test_type):
if test_type == ProxyTestType.TUNNELING_DOUBLE_TLS:
tls_ctx_opt = TlsContextOptions()
tls_ctx_opt.verify_peer = False
tls_ctx = ClientTlsContext(tls_ctx_opt)
tls_conn_opt = tls_ctx.new_connection_options()
tls_conn_opt.set_server_name("localhost")
return tls_conn_opt
else:
return None
@staticmethod
def create_http_proxy_options_from_environment(test_type, auth_type):
return HttpProxyOptions(
ProxyTestConfiguration.get_proxy_host_for_test(
test_type,
auth_type),
ProxyTestConfiguration.get_proxy_port_for_test(
test_type,
auth_type),
tls_connection_options=ProxyTestConfiguration.get_proxy_tls_connection_options_for_test(test_type),
auth_type=auth_type,
auth_username=ProxyTestConfiguration.HTTP_PROXY_BASIC_AUTH_USERNAME,
auth_password=ProxyTestConfiguration.HTTP_PROXY_BASIC_AUTH_PASSWORD,
connection_type=ProxyTestConfiguration.get_proxy_connection_type_for_test(test_type))
@staticmethod
def get_tls_connection_options_for_test(test_type, host_name):
if test_type == ProxyTestType.FORWARDING or test_type == ProxyTestType.LEGACY_HTTP or test_type == ProxyTestType.TUNNELING_HTTP:
return None
else:
tls_ctx_opt = TlsContextOptions()
tls_ctx = ClientTlsContext(tls_ctx_opt)
tls_conn_opt = tls_ctx.new_connection_options()
tls_conn_opt.set_server_name(host_name)
return tls_conn_opt
@staticmethod
def get_uri_from_test_type(test_type):
if test_type == ProxyTestType.FORWARDING or test_type == ProxyTestType.LEGACY_HTTP or test_type == ProxyTestType.TUNNELING_HTTP:
return "www.example.com"
else:
return "www.amazon.com"
@staticmethod
def get_port_from_test_type(test_type):
if test_type == ProxyTestType.FORWARDING or test_type == ProxyTestType.LEGACY_HTTP or test_type == ProxyTestType.TUNNELING_HTTP:
return 80
else:
return 443
class ProxyHttpTest(NativeResourceTest):
def _establish_http_connection(self, test_type, uri, proxy_options):
event_loop_group = EventLoopGroup()
host_resolver = DefaultHostResolver(event_loop_group)
bootstrap = ClientBootstrap(event_loop_group, host_resolver)
connection_future = HttpClientConnection.new(
host_name=uri,
port=ProxyTestConfiguration.get_port_from_test_type(test_type),
bootstrap=bootstrap,
tls_connection_options=ProxyTestConfiguration.get_tls_connection_options_for_test(
test_type,
uri),
proxy_options=proxy_options)
return connection_future.result(TIMEOUT)
def _do_proxy_http_test(self, test_type, auth_type):
uri = ProxyTestConfiguration.get_uri_from_test_type(test_type)
proxy_options = ProxyTestConfiguration.create_http_proxy_options_from_environment(test_type, auth_type)
connection = self._establish_http_connection(test_type, uri, proxy_options)
request = HttpRequest('GET', '/')
request.headers.add('host', uri)
response = Response()
stream = connection.request(request, response.on_response, response.on_body)
stream.activate()
# wait for stream to complete
stream_completion_result = stream.completion_future.result(TIMEOUT)
self.assertEqual(200, response.status_code)
self.assertEqual(200, stream_completion_result)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_forwarding_proxy_no_auth(self):
self._do_proxy_http_test(ProxyTestType.FORWARDING, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_forwarding_proxy_legacy_http_no_auth(self):
self._do_proxy_http_test(ProxyTestType.LEGACY_HTTP, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_proxy_legacy_https_no_auth(self):
self._do_proxy_http_test(ProxyTestType.LEGACY_HTTPS, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_tunneling_proxy_http_no_auth(self):
self._do_proxy_http_test(ProxyTestType.TUNNELING_HTTP, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_tunneling_proxy_https_no_auth(self):
self._do_proxy_http_test(ProxyTestType.TUNNELING_HTTPS, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_tunneling_proxy_double_tls_no_auth(self):
self._do_proxy_http_test(ProxyTestType.TUNNELING_DOUBLE_TLS, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_forwarding_proxy_basic_auth(self):
self._do_proxy_http_test(ProxyTestType.FORWARDING, HttpProxyAuthenticationType.Basic)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_forwarding_proxy_legacy_http_basic_auth(self):
self._do_proxy_http_test(ProxyTestType.LEGACY_HTTP, HttpProxyAuthenticationType.Basic)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_proxy_legacy_https_basic_auth(self):
self._do_proxy_http_test(ProxyTestType.LEGACY_HTTPS, HttpProxyAuthenticationType.Basic)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_tunneling_proxy_http_basic_auth(self):
self._do_proxy_http_test(ProxyTestType.TUNNELING_HTTP, HttpProxyAuthenticationType.Basic)
@unittest.skipIf(not ProxyTestConfiguration.is_proxy_environment_initialized(), 'requires proxy test env vars')
def test_tunneling_proxy_https_basic_auth(self):
self._do_proxy_http_test(ProxyTestType.TUNNELING_HTTPS, HttpProxyAuthenticationType.Basic)
def _establish_mqtt_connection(self, proxy_options):
event_loop_group = EventLoopGroup()
host_resolver = DefaultHostResolver(event_loop_group)
bootstrap = ClientBootstrap(event_loop_group, host_resolver)
tls_opts = TlsContextOptions.create_client_with_mtls_from_path(
ProxyTestConfiguration.HTTP_PROXY_TLS_CERT_PATH,
ProxyTestConfiguration.HTTP_PROXY_TLS_KEY_PATH)
tls_opts.override_default_trust_store_from_path(ca_filepath=ProxyTestConfiguration.HTTP_PROXY_TLS_ROOT_CA_PATH)
tls = ClientTlsContext(tls_opts)
client = Client(bootstrap, tls)
connection = Connection(
client=client,
client_id=create_client_id(),
host_name=ProxyTestConfiguration.HTTP_PROXY_MQTT_ENDPOINT,
port=8883,
proxy_options=proxy_options)
connection.connect().result(TIMEOUT)
return connection
def _do_proxy_mqtt_test(self, test_type, auth_type):
proxy_options = ProxyTestConfiguration.create_http_proxy_options_from_environment(test_type, auth_type)
connection = self._establish_mqtt_connection(proxy_options)
@unittest.skipIf(not ProxyTestConfiguration.is_mqtt_env_initialized(), 'requires proxy and MQTT test env vars')
def test_tunneling_http_proxy_mqtt_no_auth(self):
self._do_proxy_mqtt_test(ProxyTestType.TUNNELING_HTTP, HttpProxyAuthenticationType.Nothing)
@unittest.skipIf(not ProxyTestConfiguration.is_mqtt_env_initialized(), 'requires proxy and MQTT test env vars')
def test_tunneling_http_proxy_mqtt_basic_auth(self):
self._do_proxy_mqtt_test(ProxyTestType.TUNNELING_HTTP, HttpProxyAuthenticationType.Basic)
@unittest.skipIf(not ProxyTestConfiguration.is_mqtt_env_initialized(), 'requires proxy and MQTT test env vars')
def test_tunneling_http_proxy_mqtt_double_tls(self):
self._do_proxy_mqtt_test(ProxyTestType.TUNNELING_DOUBLE_TLS, HttpProxyAuthenticationType.Nothing)
def _create_x509_client_tls_context(self):
tls_ctx_opt = TlsContextOptions.create_client_with_mtls_from_path(
ProxyTestConfiguration.HTTP_PROXY_TLS_CERT_PATH,
ProxyTestConfiguration.HTTP_PROXY_TLS_KEY_PATH)
return ClientTlsContext(tls_ctx_opt)
def _build_proxied_x509_credentials(self, test_type, auth_type):
event_loop_group = EventLoopGroup(num_threads=1)
resolver = DefaultHostResolver(event_loop_group=event_loop_group)
bootstrap = ClientBootstrap(event_loop_group=event_loop_group, host_resolver=resolver)
proxy_options = ProxyTestConfiguration.create_http_proxy_options_from_environment(test_type, auth_type)
client_tls_ctx = self._create_x509_client_tls_context()
credentials = AwsCredentialsProvider.new_x509(
endpoint=ProxyTestConfiguration.X509_CREDENTIALS_ENDPOINT,
thing_name=ProxyTestConfiguration.X509_CREDENTIALS_THING_NAME,
role_alias=ProxyTestConfiguration.X509_CREDENTIALS_ROLE_ALIAS,
tls_ctx=client_tls_ctx,
client_bootstrap=bootstrap,
http_proxy_options=proxy_options
)
return credentials
def _do_credentials_provider_test(self, provider: AwsCredentialsProvider):
try:
credentials = provider.get_credentials().result(300) # wait 5 minutes
self.assertNotEqual(credentials, None, "Credentials returned was none")
except Exception as e:
raise RuntimeError(e)
@unittest.skipIf(not ProxyTestConfiguration.is_x509_env_initialized(),
"Requires Proxy, MQTT, and X509 test env vars")
def test_x509_credentials_tunneling_proxy_no_auth(self):
provider = self._build_proxied_x509_credentials(
ProxyTestType.TUNNELING_HTTPS, HttpProxyAuthenticationType.Nothing)
self._do_credentials_provider_test(provider)
@unittest.skipIf(not ProxyTestConfiguration.is_x509_env_initialized(),
"Requires Proxy, MQTT, and X509 test env vars")
def test_x509_credentials_tunneling_proxy_double_tls_no_auth(self):
provider = self._build_proxied_x509_credentials(
ProxyTestType.TUNNELING_DOUBLE_TLS,
HttpProxyAuthenticationType.Nothing)
self._do_credentials_provider_test(provider)
@unittest.skipIf(not ProxyTestConfiguration.is_x509_env_initialized(),
"Requires Proxy, MQTT, and X509 test env vars")
def test_x509_credentials_tunneling_proxy_basic_auth(self):
provider = self._build_proxied_x509_credentials(
ProxyTestType.TUNNELING_HTTPS, HttpProxyAuthenticationType.Basic)
self._do_credentials_provider_test(provider)
if __name__ == '__main__':
unittest.main()
|
