def test_cleanup_removes_storage(self): storage = RequestStorage(base_dir=self.base_dir) storage.cleanup() # The 'seleniumwire' parent folder should have been cleaned up # when there is nothing left inside of it. self.assertFalse(os.listdir(self.base_dir))
def test_cleanup_does_not_remove_parent_folder(self): # There is an existing storage folder os.makedirs(os.path.join(self.base_dir, '.seleniumwire', 'teststorage')) storage = RequestStorage(base_dir=self.base_dir) storage.cleanup() # The existing storage folder is not cleaned up self.assertEqual(1, len(os.listdir(self.base_dir))) self.assertTrue(os.path.exists(os.path.join(self.base_dir, '.seleniumwire', 'teststorage')))
class MitmProxy: """Run and manage a mitmproxy server instance.""" def __init__(self, host, port, options): self.options = options # Used to stored captured requests self.storage = RequestStorage( base_dir=options.pop('request_storage_base_dir', None)) extract_cert_and_key(self.storage.home_dir) # Used to modify requests/responses passing through the server # DEPRECATED. Will be superceded by request/response interceptors. self.modifier = RequestModifier() # The scope of requests we're interested in capturing. self.scopes = [] self.request_interceptor = None self.response_interceptor = None self._event_loop = asyncio.new_event_loop() # mitmproxy specific options mitmproxy_opts = Options( confdir=self.storage.home_dir, listen_host=host, listen_port=port, ) # Create an instance of the mitmproxy server self._master = Master(self._event_loop, mitmproxy_opts) self._master.server = ProxyServer(ProxyConfig(mitmproxy_opts)) self._master.addons.add(*addons.default_addons()) self._master.addons.add(SendToLogger()) self._master.addons.add(MitmProxyRequestHandler(self)) # Update the options now all addons have been added mitmproxy_opts.update( ssl_insecure=options.get('verify_ssl', True), upstream_cert=DEFAULT_UPSTREAM_CERT, stream_websockets=DEFAULT_STREAM_WEBSOCKETS, suppress_connection_errors=options.get( 'suppress_connection_errors', True), **self._get_upstream_proxy_args(), ) # Options that are prefixed mitm_ are passed through to mitmproxy mitmproxy_opts.update( **{k[5:]: v for k, v in options.items() if k.startswith('mitm_')}) def serve_forever(self): """Run the server.""" asyncio.set_event_loop(self._event_loop) self._master.run() def address(self): """Get a tuple of the address and port the proxy server is listening on. """ return self._master.server.address def shutdown(self): """Shutdown the server and perform any cleanup.""" self._master.shutdown() self.storage.cleanup() def _get_upstream_proxy_args(self): proxy_config = get_upstream_proxy(self.options) http_proxy = proxy_config.get('http') https_proxy = proxy_config.get('https') conf = None if http_proxy and https_proxy: if http_proxy.hostport != https_proxy.hostport: # We only support a single upstream proxy server raise ValueError( 'Different settings for http and https proxy servers not supported' ) conf = https_proxy elif http_proxy: conf = http_proxy elif https_proxy: conf = https_proxy args = {} if conf: scheme, username, password, hostport = conf args['mode'] = 'upstream:{}://{}'.format(scheme, hostport) if username: args['upstream_auth'] = '{}:{}'.format(username, password) custom_auth = proxy_config.get('custom_authorization') if custom_auth: args['upstream_custom_auth'] = custom_auth return args
class MitmProxy: """Run and manage a mitmproxy server instance. DEPRECATED. """ def __init__(self, host, port, options): self.options = options # Used to stored captured requests self.storage = RequestStorage( base_dir=options.pop('request_storage_base_dir', None)) # Used to modify requests/responses passing through the server # DEPRECATED. Will be superceded by request/response interceptors. self.modifier = RequestModifier() # The scope of requests we're interested in capturing. self.scopes = [] self.request_interceptor = None self.response_interceptor = None self._event_loop = self._get_event_loop() # mitmproxy specific options mitmproxy_opts = Options( confdir=options.pop('mitm_confdir', DEFAULT_CONFDIR), listen_host=host, listen_port=port, ) # Create an instance of the mitmproxy server self._master = Master(mitmproxy_opts) self._master.server = ProxyServer(ProxyConfig(mitmproxy_opts)) self._master.addons.add(*addons.default_addons()) self._master.addons.add(SendToLogger()) self._master.addons.add(MitmProxyRequestHandler(self)) # Update the options now all addons have been added mitmproxy_opts.update( ssl_insecure=options.get('verify_ssl', True), upstream_cert=DEFAULT_UPSTREAM_CERT, stream_websockets=DEFAULT_STREAM_WEBSOCKETS, **self._get_upstream_proxy_args(), ) # Options that are prefixed mitm_ are passed through to mitmproxy mitmproxy_opts.update( **{k[5:]: v for k, v in options.items() if k.startswith('mitm_')}) def _get_event_loop(self): try: event_loop = asyncio.get_event_loop() if event_loop.is_closed(): # The event loop may be closed if the server had previously # been shutdown and then spun up again event_loop = asyncio.new_event_loop() asyncio.set_event_loop(event_loop) except Exception: event_loop = asyncio.new_event_loop() asyncio.set_event_loop(event_loop) return event_loop def serve_forever(self): """Run the server.""" asyncio.set_event_loop(self._event_loop) self._master.run_loop(self._event_loop.run_forever) def address(self): """Get a tuple of the address and port the mitmproxy server is listening on. """ return self._master.server.address def shutdown(self): """Shutdown the server and perform any cleanup.""" try: # Wait for any active requests to finish. This reduces the # probability of seeing shutdown errors in the console. self._master.server.wait_for_silence() except Timeout: pass self._master.shutdown() self.storage.cleanup() def _get_upstream_proxy_args(self): proxy_config = get_upstream_proxy(self.options) http_proxy = proxy_config.get('http') https_proxy = proxy_config.get('https') conf = None if http_proxy and https_proxy: if http_proxy.hostport != https_proxy.hostport: # We only support a single upstream mitmproxy server raise ValueError('Cannot specify both http AND https ' 'mitmproxy settings with mitmproxy backend') conf = https_proxy elif http_proxy: conf = http_proxy elif https_proxy: conf = https_proxy args = {} if conf: scheme, username, password, hostport = conf args['mode'] = 'upstream:{}://{}'.format(scheme, hostport) if username and password: args['upstream_auth'] = '{}:{}'.format(username, password) return args