Recent commits to derivepassphrase.git (6ea7220d451cebadfcdfd2588c97f656a1de5f4a)

Implement Windows named pipes on The Annoying OS

2025-12-14T17:21:00+01:00

Using the `ctypes` module, call into The Annoying OS's system libraries
and bind the functions necessary to create, read from/write to, and
close handles to existing Windows named pipes.  We also bind the
functions necessary to compute the pipe name for PuTTY/Pageant, and
provide convenience functions to connect to PuTTY/Pageant and to
OpenSSH, the de facto main SSH implementations on The Annoying OS.

One major design question remains: how to discover the (named pipe
address for) the SSH agent to use?  Tempting options are using
`SSH_AUTH_SOCK` again (whether literally or with special notation), and
listing the preferred agent addresses in the user configuration file.

For certain "well-known" addresses such as PuTTY/Pageant or OpenSSH, we
provide specific SSH agent socket provider registry entries that attempt
to connect to the respective agent. Other applications could easily
register a custom provider that respects their configuration if the
final socket (address) depends on external configuration.  It is thus
not clear to me if the system needs to be more flexible than it
currently is, e.g., if the SSH agent socket provider needs to accept
arguments that further configure the address or the connection options
to the socket or named pipe.

The formal name for this facility is "Windows named pipe", and this is
the name other developers will expect.  Thus, any mention of The
Annoying OS in the context of Windows named pipes will strictly be
called "Windows named pipe", not "The Annoying OS named pipe" or
similar.  (Some pre-existing names were adapted accordingly.)
Similarly, the other facility is called "UNIX domain socket", not
"AF_UNIX" or "AfUnix" or somesuch.

This commit contains no specific test code for this functionality; we
leave this to follow-up commits.  For ease of integration with the
existing test suite, *in this commit* we attempt to use `SSH_AUTH_SOCK`
directly as the named pipe's name (which will fail unless specifically
prepared).

Since many of the symbols are undefined on other operating systems, and
because the `ctypes` library relies on dynamically generated attributes
and is thus mostly invisible to static analysis tools, much of the code
needs type checking exemptions and extraneous explicit (C) casts at the
Python level.  Additionally, because our stub functions use the same
CamelCase naming as The Annoying OS's official documentation does, much
of the code also needs linting exceptions for the naming policy.
</pre>

Merge topic branch 'fix-key_to_phrase-missing-callback' into master

2025-12-13T15:57:40+01:00

* fix-key_to_phrase-missing-callback:
  Add changelog entry for the `key_to_phrase` missing callback argument fix
  Add missing `warning_callback` argument to `key_to_phrase` call
</pre>

Add changelog entry for the `key_to_phrase` missing callback argument fix

2025-12-13T15:56:49+01:00

</pre>

Add missing `warning_callback` argument to `key_to_phrase` call

2025-12-13T15:47:45+01:00

The callback parameters in `cli_helpers.key_to_phrase` for handling
warning and error messages are now mandatory to specify.  All calls in
production code and in test code(!) now explicitly handle warnings and
errors.

Since changing `cli_helpers.key_to_phrase` in
2413d9dc10ede315c295ab7520a19b21d597a668 to support exception groups,
the function takes additional callback parameters to do its warning and
error handling/reporting.  For compatibility reasons, the signature
included default values which suppressed warning messages and exited the
process on error messages.

However, these default values made it too
easy to *forget* proper handling of warning and error messages in the
new implementation.  In particular, two call sites in production code,
just several lines apart, had differing warning handling, and the test
suite had two major areas where warning handling was completely absent,
relying on the "suppressed warning messages" default.  All these
behaviors were unwanted and wrong, but difficult to spot, because the
test code too was wrong.  By making the error and warning handling
callbacks mandatory to specify and removing the implicit suppression
behavior, inadvertent suppression of warning and error messages becomes
much more difficult.

To further ensure this doesn't happen again accidentally, the tests now
also assert that certain expected warning messages are emitted, i.e.,
that the callback is actually exercised.
</pre>

Merge topic branch 'modularize-and-refactor-test-machinery' into master

2025-11-30T15:06:57+01:00

* modularize-and-refactor-test-machinery: (40 commits)
  Move the tests for the stubbed SSH agent socket to the machinery tests
  Add module docstrings for the tests hierarchy.
  Add a changelog entry for the test suite refactoring
  Format and lint all files
  Fix type errors due to click 8.2.0
  Fix typing of the dummy vault configuration settings in the constructor
  Add CPython 3.14 to the list of test environments
  Fix more broken tests on The Annoying OS
  Fix broken links in the documentation caused by renaming or splitting modules
  Split the basic command-line tests, again
  Fix missing documentation in the test suite
  Fix some documentation issues with the heavy-duty command-line inteface tests
  Refactor the heavy-duty command-line interface tests
  Refactor the "all CLIs" command-line interface tests
  Refactor the basic command-line interface tests
  Fix miscellaneous imports, types and hyperlinks in the CLI machinery and tests
  Refactor the testing machinery tests
  Refactor the SSH agent tests
  Refactor the `exporter` tests
  Refactor the `vault` and `sequin` tests
  ...
</pre>

Move the tests for the stubbed SSH agent socket to the machinery tests

2025-11-30T14:23:54+01:00

Even though the stubbed SSH agent socket exists to test the
`derivepassphrase.ssh_agent` module, it is still a piece of testing
machinery at its core, and thus belongs in the same place as the other
testing machinery tests belong.  Additionally, although the "basic"
tests for the `derivepassphrase.ssh_agent` module are already a giant
mixed bag of non-heavy-duty tests that all involve functionality from
the `derivepassphrase.ssh_agent` module, the stubbed SSH agent socket
tests differ from the other tests insofar as the other tests focus on
establishing correctness of the `derivepassphrase.ssh_agent` machinery,
whereas the stubbed SSH agent socket tests focus on the stubbed SSH
agent socket.  This, too, suggests that the stubbed SSH agent socket
tests do not belong in the same test module as the
`derivepassphrase.ssh_agent` tests.
</pre>

Add module docstrings for the tests hierarchy.

2025-11-30T13:54:36+01:00

Consistently add docstrings to all modules in the tests hierarchy that
would appear in the (developer setup) documentation.
</pre>

Merge topic branch 'ssh-agent-socket-providers' into master

2025-11-30T10:44:57+01:00

* ssh-agent-socket-providers:
  Add a changelog entry for the NO_AF_UNIX error change
  Update the documentation for the reworked NO_AF_UNIX message
  Ignore unknown marked messages in the manpage diagnostics
</pre>

Add a changelog entry for the NO_AF_UNIX error change

2025-11-30T10:44:06+01:00

</pre>

Add a changelog entry for the test suite refactoring

2025-11-30T10:08:07+01:00

</pre>