Skip to content

feat: allow direct SSL connection over STARTTLS #923

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

Merged
merged 6 commits into from
Jun 13, 2022
Merged
Show file tree
Hide file tree
Changes from 4 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
21 changes: 15 additions & 6 deletions asyncpg/connect_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ def parse(cls, sslmode):
'database',
'ssl',
'sslmode',
'direct_tls',
'connect_timeout',
'server_settings',
])
Expand Down Expand Up @@ -258,7 +259,7 @@ def _dot_postgresql_path(filename) -> pathlib.Path:

def _parse_connect_dsn_and_args(*, dsn, host, port, user,
password, passfile, database, ssl,
connect_timeout, server_settings):
direct_tls, connect_timeout, server_settings):
# `auth_hosts` is the version of host information for the purposes
# of reading the pgpass file.
auth_hosts = None
Expand Down Expand Up @@ -601,8 +602,8 @@ def _parse_connect_dsn_and_args(*, dsn, host, port, user,

params = _ConnectionParameters(
user=user, password=password, database=database, ssl=ssl,
sslmode=sslmode, connect_timeout=connect_timeout,
server_settings=server_settings)
sslmode=sslmode, direct_tls=direct_tls,
connect_timeout=connect_timeout, server_settings=server_settings)

return addrs, params

Expand All @@ -612,7 +613,7 @@ def _parse_connect_arguments(*, dsn, host, port, user, password, passfile,
statement_cache_size,
max_cached_statement_lifetime,
max_cacheable_statement_size,
ssl, server_settings):
ssl, direct_tls, server_settings):

local_vars = locals()
for var_name in {'max_cacheable_statement_size',
Expand Down Expand Up @@ -640,8 +641,8 @@ def _parse_connect_arguments(*, dsn, host, port, user, password, passfile,
addrs, params = _parse_connect_dsn_and_args(
dsn=dsn, host=host, port=port, user=user,
password=password, passfile=passfile, ssl=ssl,
database=database, connect_timeout=timeout,
server_settings=server_settings)
direct_tls=direct_tls, database=database,
connect_timeout=timeout, server_settings=server_settings)

config = _ClientConfiguration(
command_timeout=command_timeout,
Expand Down Expand Up @@ -812,6 +813,14 @@ async def __connect_addr(
if isinstance(addr, str):
# UNIX socket
connector = loop.create_unix_connection(proto_factory, addr)

elif params.ssl and params.direct_tls:
# if ssl and direct_tls are given, skip STARTTLS and perform direct
# SSL connection
connector = loop.create_connection(
proto_factory, *addr, ssl=params.ssl
)

elif params.ssl:
connector = _create_ssl_connection(
proto_factory, *addr, loop=loop, ssl_context=params.ssl,
Expand Down
6 changes: 6 additions & 0 deletions asyncpg/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -1789,6 +1789,7 @@ async def connect(dsn=None, *,
max_cacheable_statement_size=1024 * 15,
command_timeout=None,
ssl=None,
direct_tls=False,
connection_class=Connection,
record_class=protocol.Record,
server_settings=None):
Expand Down Expand Up @@ -1984,6 +1985,10 @@ async def connect(dsn=None, *,
... await con.close()
>>> asyncio.run(run())

:param bool direct_tls:
Pass ``True`` to skip PostgreSQL STARTTLS mode and perform a direct
SSL connection. Must be used alongside ``ssl`` param.

:param dict server_settings:
An optional dict of server runtime parameters. Refer to
PostgreSQL documentation for
Expand Down Expand Up @@ -2094,6 +2099,7 @@ async def connect(dsn=None, *,
password=password,
passfile=passfile,
ssl=ssl,
direct_tls=direct_tls,
database=database,
server_settings=server_settings,
command_timeout=command_timeout,
Expand Down
3 changes: 2 additions & 1 deletion tests/test_connect.py
Original file line number Diff line number Diff line change
Expand Up @@ -811,7 +811,8 @@ def run_testcase(self, testcase):
addrs, params = connect_utils._parse_connect_dsn_and_args(
dsn=dsn, host=host, port=port, user=user, password=password,
passfile=passfile, database=database, ssl=sslmode,
connect_timeout=None, server_settings=server_settings)
direct_tls=False, connect_timeout=None,
server_settings=server_settings)

params = {
k: v for k, v in params._asdict().items()
Expand Down