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.

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

Implement AsyncOpenSearch() parameter ssl_assert_hostname #843

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
## [Unreleased]
### Added
- Added `AsyncSearch#collapse` ([827](https://github.com/opensearch-project/opensearch-py/pull/827))
- Support `pool_maxsize` in `AsyncOpenSearch` ([845](https://github.com/opensearch-project/opensearch-py/pull/845))
- Added `pool_maxsize` to `AsyncOpenSearch` ([845](https://github.com/opensearch-project/opensearch-py/pull/845))
- Added `ssl_assert_hostname` to `AsyncOpenSearch` ([843](https://github.com/opensearch-project/opensearch-py/pull/843))
### Changed
### Deprecated
### Removed
Expand Down
4 changes: 4 additions & 0 deletions docs/source/api-ref/clients/opensearch_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@
```{eval-rst}
.. autoclass:: opensearchpy.OpenSearch
```

```{eval-rst}
.. autoclass:: opensearchpy.AsyncOpenSearch
```
6 changes: 5 additions & 1 deletion docs/source/api-ref/connection.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# connection
# Connection Types

```{eval-rst}
.. autoclass:: opensearchpy.Connection
Expand All @@ -12,6 +12,10 @@
.. autoclass:: opensearchpy.Urllib3HttpConnection
```

```{eval-rst}
.. autoclass:: opensearchpy.AIOHttpConnection
```

```{eval-rst}
.. autoclass:: opensearchpy.connections
```
8 changes: 5 additions & 3 deletions opensearchpy/_async/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ class AsyncOpenSearch(Client):
])

If using SSL, there are several parameters that control how we deal with
certificates (see :class:`~opensearchpy.Urllib3HttpConnection` for
certificates (see :class:`~opensearchpy.AIOHttpConnection` for
detailed description of the options)::

client = OpenSearch(
Expand All @@ -123,7 +123,7 @@ class AsyncOpenSearch(Client):
)

If using SSL, but don't verify the certs, a warning message is showed
optionally (see :class:`~opensearchpy.Urllib3HttpConnection` for
optionally (see :class:`~opensearchpy.AIOHttpConnection` for
detailed description of the options)::

client = OpenSearch(
Expand All @@ -132,12 +132,14 @@ class AsyncOpenSearch(Client):
use_ssl=True,
# no verify SSL certificates
verify_certs=False,
# don't verify the hostname in the certificate
ssl_assert_hostname=False,
# don't show warnings about ssl certs verification
ssl_show_warn=False
)

SSL client authentication is supported
(see :class:`~opensearchpy.Urllib3HttpConnection` for
(see :class:`~opensearchpy.AIOHttpConnection` for
detailed description of the options)::

client = OpenSearch(
Expand Down
3 changes: 2 additions & 1 deletion opensearchpy/_async/http_aiohttp.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ def __init__(
client_cert: Any = None,
client_key: Any = None,
ssl_version: Any = None,
ssl_assert_hostname: bool = True,
ssl_assert_fingerprint: Any = None,
maxsize: Optional[int] = 10,
headers: Any = None,
Expand Down Expand Up @@ -178,7 +179,7 @@ def __init__(

if verify_certs:
ssl_context.verify_mode = ssl.CERT_REQUIRED
ssl_context.check_hostname = True
ssl_context.check_hostname = ssl_assert_hostname
else:
ssl_context.check_hostname = False
ssl_context.verify_mode = ssl.CERT_NONE
Expand Down
22 changes: 21 additions & 1 deletion test_opensearchpy/test_async/test_connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import io
import json
import ssl
import sys
import warnings
from platform import python_version
from typing import Any
Expand Down Expand Up @@ -97,6 +98,17 @@ async def test_ssl_context(self) -> None:
assert con.use_ssl
assert con.session.connector._ssl == context

async def test_ssl_assert_hostname(self) -> None:
merlinz01 marked this conversation as resolved.
Show resolved Hide resolved
con = AIOHttpConnection(use_ssl=True, ssl_assert_hostname=True)
await con._create_aiohttp_session()
assert con.use_ssl
assert con.session.connector._ssl.check_hostname is True

con = AIOHttpConnection(use_ssl=True, ssl_assert_hostname=False)
await con._create_aiohttp_session()
assert con.use_ssl
assert con.session.connector._ssl.check_hostname is False

async def test_opaque_id(self) -> None:
con = AIOHttpConnection(opaque_id="app-1")
assert con.headers["x-opaque-id"] == "app-1"
Expand Down Expand Up @@ -217,7 +229,15 @@ async def test_nowarn_when_test_uses_https_if_verify_certs_is_off(self) -> None:
use_ssl=True, verify_certs=False, ssl_show_warn=False
)
await con._create_aiohttp_session()
assert w == []
if sys.hexversion < 0x30C0700:
assert w == []
else:
assert len(w) == 1
assert (
str(w[0].message) == "enable_cleanup_closed ignored because "
"https://github.com/python/cpython/pull/118960 is fixed in "
"Python version sys.version_info(major=3, minor=12, micro=7, releaselevel='final', serial=0)"
)

assert isinstance(con.session, aiohttp.ClientSession)

Expand Down
Loading