Recent commits to derivepassphrase.git (ff4e9ae1d2b3291b9606c270c8b03404307e045a)

Unload loaded test keys in the fixture more efficiently

2025-12-27T17:33:06+01:00

Instead of iterating over all test keys and testing whether the agent is
not isolated and the key is a successfully loaded key, first check
whether the agent is isolated or not, *then* iterate over the
successfully loaded key names and extract the relevant test key from the
test key table.  The efficiency per operation is similar, but the
previous setup always iterated the whole test key table unconditionally,
whereas the new setup only iterates the successfully loaded key name set
(fewer entries than the test key table), and only conditionally.
</pre>

Document the "test key uploading" helper functions

2025-12-27T17:19:38+01:00

Add docstrings to the `_prepare_payload` and `_load_key_optimistically`
helper functions.

Also change the signature of `_load_key_optimistically` to take the test
key structure directly, instead of taking a (dict) key to lookup the
structure.  (These types of things become apparent when writing
docstrings, even for otherwise internal functions.)
</pre>

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

2025-12-27T17:10:07+01:00

</pre>

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>