Skip to content

make it an error to mutate after using a context #1429

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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
10 changes: 3 additions & 7 deletions src/OpenSSL/SSL.py
Original file line number Diff line number Diff line change
Expand Up @@ -835,13 +835,9 @@ def _require_not_used(f: F) -> F:
@wraps(f)
def inner(self: Context, *args: Any, **kwargs: Any) -> Any:
if self._used:
warnings.warn(
(
"Attempting to mutate a Context after a Connection was "
"created. In the future, this will raise an exception"
),
DeprecationWarning,
stacklevel=2,
raise ValueError(
"Context has already been used to create a Connection, it "
"cannot be mutated again"
)
return f(self, *args, **kwargs)

Expand Down
56 changes: 39 additions & 17 deletions tests/test_ssl.py
Original file line number Diff line number Diff line change
Expand Up @@ -1077,6 +1077,7 @@ def test_set_proto_version(self) -> None:
with pytest.raises(Error, match="unsupported protocol"):
self._handshake_test(server_context, client_context)

client_context = Context(TLS_METHOD)
client_context.set_max_proto_version(0)
self._handshake_test(server_context, client_context)

Expand Down Expand Up @@ -1491,22 +1492,23 @@ def test_set_verify_callback_reference(self) -> None:
load_certificate(FILETYPE_PEM, root_cert_pem)
)

clientContext = Context(TLSv1_2_METHOD)

clients = []

for i in range(5):

def verify_callback(*args: object) -> bool:
return True

# Create a fresh client context for each iteration since contexts
# cannot be mutated after use
clientContext = Context(TLSv1_2_METHOD)
clientContext.set_verify(VERIFY_PEER, verify_callback)

serverSocket, clientSocket = socket_pair()
client = Connection(clientContext, clientSocket)

clients.append((serverSocket, client))

clientContext.set_verify(VERIFY_PEER, verify_callback)

gc.collect()

# Make them talk to each other.
Expand Down Expand Up @@ -2835,21 +2837,22 @@ def callback(
del callback

conn = Connection(context, None)
context.set_verify(VERIFY_NONE)

collect()
collect()
assert tracker()

# Setting a new callback on the connection should maintain the original
# context callback reference
conn.set_verify(
VERIFY_PEER, lambda conn, cert, errnum, depth, ok: bool(ok)
)
collect()
collect()

# The callback should still be referenced - check that it exists
callback_ref = tracker()
if callback_ref is not None: # pragma: nocover
referrers = get_referrers(callback_ref)
assert len(referrers) == 1
assert callback_ref is not None

def test_get_session_unconnected(self) -> None:
"""
Expand Down Expand Up @@ -3708,12 +3711,10 @@ class TestMemoryBIO:
Tests for `OpenSSL.SSL.Connection` using a memory BIO.
"""

def _server(self, sock: socket | None) -> Connection:
def _create_server_context(self) -> Context:
"""
Create a new server-side SSL `Connection` object wrapped around `sock`.
Create a configured server context with certificates and options.
"""
# Create the server side Connection. This is mostly setup boilerplate
# - use TLSv1, use a particular certificate, etc.
server_ctx = Context(SSLv23_METHOD)
server_ctx.set_options(OP_NO_SSLv2 | OP_NO_SSLv3 | OP_SINGLE_DH_USE)
server_ctx.set_verify(
Expand All @@ -3730,6 +3731,23 @@ def _server(self, sock: socket | None) -> Connection:
)
server_ctx.check_privatekey()
server_store.add_cert(load_certificate(FILETYPE_PEM, root_cert_pem))
return server_ctx

def _server(
self, sock: socket | None, ctx: Context | None = None
) -> Connection:
"""
Create a new server-side SSL `Connection` object wrapped around `sock`.

:param sock: The socket to wrap, or None for memory BIO.
:param ctx: Optional pre-configured context. If None, creates a
default server context.
"""
if ctx is None:
server_ctx = self._create_server_context()
else:
server_ctx = ctx

# Here the Connection is actually created. If None is passed as the
# 2nd parameter, it indicates a memory BIO should be created.
server_conn = Connection(server_ctx, sock)
Expand Down Expand Up @@ -3939,12 +3957,16 @@ def _check_client_ca_list(
that `get_client_ca_list` returns the proper value at
various times.
"""
server = self._server(None)
# Create a server context and configure it before creating connections
server_ctx = self._create_server_context()

# Configure the CA list before creating connections
expected = func(server_ctx)

# Now create connections with the configured context
server = self._server(None, server_ctx)
client = self._client(None)
assert client.get_client_ca_list() == []
assert server.get_client_ca_list() == []
ctx = server.get_context()
expected = func(ctx)

assert client.get_client_ca_list() == []
assert server.get_client_ca_list() == expected
interact_in_memory(client, server)
Expand Down
Loading