Recent commits to derivepassphrase.git (71f2f540c1f2e12948c0dd11b8eaef98233d396b)

Convert the helper function `_load_keys_optimistically` into a per-key function

2025-12-27T17:01:22+01:00

The function is now called `_load_key_optimistically`, and returns a
success indication whether the key was (potentially already) loaded or
not.  Also, the private key blob cannot be `None` anymore, so the
function no longer has degenerate cases.
</pre>

Auto-format the "test key uploading" fixture and helper functions

2025-12-27T15:15:35+01:00

</pre>

Split the "test key loading" fixture function

2025-12-27T15:09:33+01:00

Extract the `_prepare_payload` and the `_load_keys_optimistically`
helper functions from the `ssh_agent_client_with_test_keys_loaded`
fixture function.

The `_load_keys_optimistically` helper function needs further
refactoring into a per-key function, not a per-keyset function; to be
added in a following commit.
</pre>

Prepare the splitting of the "test key loading" fixture function

2025-12-27T14:57:17+01:00

The `ssh_agent_client_with_test_keys_loaded` fixture function is due to
be split, moving the upload bits and the `prepare_payload` function to
new top-level helper functions.  Rename the `prepare_payload` function,
and add parameter definitions so that the extracted functions will make
immediate sense.
</pre>

Add debugging attributes to `ssh_agent.TrailingDataError`

2025-12-27T14:43:35+01:00

The old implementation did not record *which* trailing data we were
seeing, on the grounds that well-behaved SSH agents would not send any
trailing data anyway (i.e., that this error condition was a failsafe).
However, while implementing Windows named pipe support, I observed
Pageant sporadically returning malformed responses that trigger this
error.  Without actually recording the trailing data, it is hard to
understand whether this is Pageant's fault (unlikely) or ours (more
likely), and specifically, whether we're implementing the protocol
incorrectly (unlikely), or rather the communication channel (much more
likely).  So the `TrailingDataError` class now optionally records the
actual raw response and the trailing data portion that caused the error,
to aid debugging.
</pre>

Reparametrize the `socketprovider.SocketProvider.register` decorator

2025-12-26T12:25:39+01:00

Use parametric types to allow better introspection into decorated
classes.
</pre>

Update the documentation on SSH agent support on Windows

2025-12-25T23:37:49+01:00

The how-to "How to set up derivepassphrase vault with an SSH key" and
the reference documentation "Prerequisites for using derivepassphrase
vault with an SSH key" include new sections on Pageant and OpenSSH on
Windows.  For the latter, the "prerequisites" document also includes
information on the deficiencies of the Windows port of OpenSSH, i.e.,
that the connection is aborted upon receiving unsupported requests (in
violation of the communication protocol) and that the port lacks the
features which normally distinguish OpenSSH from Pageant.

We also expand the section on GnuPG's OpenSSH emulation on Windows in
the "prerequisites" document: that the mode is untested because the
documentation is wrong, and that we're now waiting for feedback from the
GnuPG developers.
</pre>

Reformat some documentation to one-sentence-per-line

2025-12-25T16:51:03+01:00

</pre>

Use relative imports in conftest.py

2025-12-25T16:25:15+01:00

</pre>

Sanity-test the returned agent client with loaded test keys

2025-12-25T14:44:46+01:00

Add sanity checks for the constructed agent client with optimistically
loaded test keys.  The docstring asserts that the test fixture will skip
if no keys can be loaded, but that wasn't the case.  Furthermore, while
there is little point in sanity testing the client when it is first
received (from a different fixture, which does its own sanity checks),
it makes sense to sanity-test the client *after* attempting to load all
those test keys into the agent, because certain misbehaved agents
terminate upon encountering unsupported key formats (see inline
commentary), rendering the client non-functional.

However, do not check whether the stubbed test agent can load the test
keys.  The stubbed test agent accesses the test keys directly, and only
the test keys; whether the "load keys" operation succeeds or not is
completely irrelevant.  There is also little point in actually
implementing the load operation: it is just more code that needs
coverage, and dedicated tests.
</pre>