Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only create httpx ssl context once #231

Merged
merged 6 commits into from
Sep 13, 2023
Merged

Only create httpx ssl context once #231

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f1565cb
Only create httpx ssl context once
bdraco Aug 31, 2023
27deb4f
Only create httpx ssl context once
bdraco Aug 31, 2023
89006d1
Only create httpx ssl context once
bdraco Aug 31, 2023
b010462
Only create httpx ssl context once
bdraco Aug 31, 2023
ca084c0
black
bdraco Aug 31, 2023
7e5255a
black
bdraco Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 51 additions & 40 deletions src/amcrest/http.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@
#
# vim:sw=4:ts=4:et
import asyncio
import contextlib
from functools import lru_cache
import logging
import re
import socket
import ssl
import threading
from contextlib import asynccontextmanager
from typing import AsyncIterator, Optional, Tuple, Union
Expand Down Expand Up @@ -46,13 +49,42 @@
except AttributeError:
pass


TimeoutT = Union[Optional[float], Tuple[Optional[float], Optional[float]]]
HttpxTimeoutT = Union[
Optional[float],
Tuple[Optional[float], Optional[float], Optional[float], Optional[float]],
]


@lru_cache(maxsize=None)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
def create_default_ssl_context() -> ssl.SSLContext:
"""Return an SSL context that verifies the server certificate."""
return ssl.create_default_context()


@lru_cache(maxsize=None)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
def create_no_verify_ssl_context() -> ssl.SSLContext:
"""Return an SSL context that does not verify the server certificate.
This is a copy of aiohttp's create_default_context() function, with the
ssl verify turned off and old SSL versions enabled.

https://github.com/aio-libs/aiohttp/blob/33953f110e97eecc707e1402daa8d543f38a189b/aiohttp/connector.py#L911
"""
sslcontext = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
sslcontext.check_hostname = False
sslcontext.verify_mode = ssl.CERT_NONE
# Allow all ciphers rather than only Python 3.10 default
sslcontext.set_ciphers("DEFAULT")
with contextlib.suppress(AttributeError):
bdraco marked this conversation as resolved.
Show resolved Hide resolved
# This only works for OpenSSL >= 1.0.0
sslcontext.options |= ssl.OP_NO_COMPRESSION
sslcontext.set_default_verify_paths()
# ssl.OP_LEGACY_SERVER_CONNECT is only available in Python 3.12a4+
sslcontext.options |= getattr(ssl, "OP_LEGACY_SERVER_CONNECT", 0x4)
return sslcontext


class SOHTTPAdapter(HTTPAdapter):
"""HTTPAdapter with support for socket options."""

Expand Down Expand Up @@ -118,9 +150,7 @@ def _generate_token(self) -> None:
resp = self._command(cmd).content.decode()
except LoginError:
_LOGGER.debug("%s Trying Digest Authentication", self)
self._token = requests.auth.HTTPDigestAuth(
self._user, self._password
)
self._token = requests.auth.HTTPDigestAuth(self._user, self._password)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
resp = self._command(cmd).content.decode()
except CommError:
self._token = None
Expand All @@ -141,9 +171,7 @@ def _generate_token(self) -> None:

_LOGGER.debug("%s Retrieving serial number", self)
self._serial = pretty(
self._command("magicBox.cgi?action=getSerialNo")
.content.decode()
.strip()
self._command("magicBox.cgi?action=getSerialNo").content.decode().strip()
bdraco marked this conversation as resolved.
Show resolved Hide resolved
)

async def _async_generate_token(self) -> None:
Expand All @@ -156,9 +184,7 @@ async def _async_generate_token(self) -> None:
resp = (await self._async_command(cmd)).content.decode()
except LoginError:
_LOGGER.debug("%s Trying async Digest Authentication", self)
self._async_token = httpx.DigestAuth(
self._user, self._password
)
self._async_token = httpx.DigestAuth(self._user, self._password)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
resp = (await self._async_command(cmd)).content.decode()
except CommError:
self._async_token = None
Expand Down Expand Up @@ -266,9 +292,7 @@ def _command(
SOHTTPAdapter(socket_options=_KEEPALIVE_OPTS),
)
for loop in range(1, 2 + retries):
_LOGGER.debug(
"%s Running query %i attempt %s", self, cmd_id, loop
)
_LOGGER.debug("%s Running query %i attempt %s", self, cmd_id, loop)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
try:
resp = session.get(
url,
Expand All @@ -278,9 +302,7 @@ def _command(
verify=self._verify,
)
if resp.status_code == 401:
_LOGGER.debug(
"%s Query %i: Unauthorized (401)", self, cmd_id
)
_LOGGER.debug("%s Query %i: Unauthorized (401)", self, cmd_id)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
self._token = None
raise LoginError()
resp.raise_for_status()
Expand All @@ -293,12 +315,8 @@ def _command(
)
if loop > retries:
raise CommError(error) from error
msg = re.sub(
r"at 0x[0-9a-fA-F]+", "at ADDRESS", repr(error)
)
_LOGGER.warning(
"%s Trying again due to error: %s", self, msg
)
msg = re.sub(r"at 0x[0-9a-fA-F]+", "at ADDRESS", repr(error))
bdraco marked this conversation as resolved.
Show resolved Hide resolved
_LOGGER.warning("%s Trying again due to error: %s", self, msg)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
continue
else:
break
Expand Down Expand Up @@ -331,22 +349,23 @@ async def _async_command(
else:
httpx_timeout = timeout

if self._verify:
ssl_context = create_default_ssl_context()
else:
ssl_context = create_no_verify_ssl_context()

async with httpx.AsyncClient(
follow_redirects=True,
auth=self._async_token,
verify=self._verify,
verify=ssl_context,
timeout=httpx_timeout,
) as client:
for loop in range(1, 2 + retries):
_LOGGER.debug(
"%s Running query %i attempt %s", self, cmd_id, loop
)
_LOGGER.debug("%s Running query %i attempt %s", self, cmd_id, loop)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
try:
resp = await client.get(url)
if resp.status_code == 401:
_LOGGER.debug(
"%s Query %i: Unauthorized (401)", self, cmd_id
)
_LOGGER.debug("%s Query %i: Unauthorized (401)", self, cmd_id)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
self._async_token = None
raise LoginError()
resp.raise_for_status()
Expand All @@ -359,12 +378,8 @@ async def _async_command(
)
if loop > retries:
raise CommError(error) from error
msg = re.sub(
r"at 0x[0-9a-fA-F]+", "at ADDRESS", repr(error)
)
_LOGGER.warning(
"%s Trying again due to error: %s", self, msg
)
msg = re.sub(r"at 0x[0-9a-fA-F]+", "at ADDRESS", repr(error))
bdraco marked this conversation as resolved.
Show resolved Hide resolved
_LOGGER.warning("%s Trying again due to error: %s", self, msg)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
continue
else:
break
Expand Down Expand Up @@ -404,9 +419,7 @@ async def _async_stream_command(
try:
async with client.stream("GET", url) as resp:
if resp.status_code == 401:
_LOGGER.debug(
"%s Query %i: Unauthorized (401)", self, cmd_id
)
_LOGGER.debug("%s Query %i: Unauthorized (401)", self, cmd_id)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
self._async_token = None
raise LoginError()
resp.raise_for_status()
Expand Down Expand Up @@ -455,9 +468,7 @@ def command_audio(
# Helpers for common commands

def _get_config(self, config_name: str) -> str:
ret = self.command(
f"configManager.cgi?action=getConfig&name={config_name}"
)
ret = self.command(f"configManager.cgi?action=getConfig&name={config_name}")
bdraco marked this conversation as resolved.
Show resolved Hide resolved
return ret.content.decode()

async def _async_get_config(self, config_name: str) -> str:
Expand Down