Recent commits to derivepassphrase.git (33a52956612f2f13ffb8c16281077ee40fde3121) https://git.schokokeks.org/derivepassphrase.git/tree/33a52956612f2f13ffb8c16281077ee40fde3121 Recent commits feed provided by GitList. Update the documentation on SSH agent support on Windows 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. https://git.schokokeks.org/derivepassphrase.git/commit/33a52956612f2f13ffb8c16281077ee40fde3121 software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 23:37:49 +0100 33a52956612f2f13ffb8c16281077ee40fde3121 Reformat some documentation to one-sentence-per-line https://git.schokokeks.org/derivepassphrase.git/commit/34f1f94cbef736f973bf46318387785e6de66314 software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 16:51:03 +0100 34f1f94cbef736f973bf46318387785e6de66314 Use relative imports in conftest.py https://git.schokokeks.org/derivepassphrase.git/commit/e30389fac403cf487af2d1e20e8df2e408edc5dd software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 16:25:15 +0100 e30389fac403cf487af2d1e20e8df2e408edc5dd Sanity-test the returned agent client with loaded test keys 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. https://git.schokokeks.org/derivepassphrase.git/commit/537b00606fa01977cff1a7fb86e08c4db1c6f65a software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 14:44:46 +0100 537b00606fa01977cff1a7fb86e08c4db1c6f65a Introduce SSH agent interfacing on The Annoying OS in the test suite Introduce SSH agent spawning functions that interface with running SSH agents on The Annoying OS. Also officially activate interfacing with the system SSH agent on The Annoying OS, now that there are working SSH agent socket providers on The Annoying OS that do not require UNIX domain socket support. Because the socket provider registry drastically changed shape since 0123456789abcdef, also update the tests referencing registry entries to use the correct non-alias base entry, if needed. The two most common agents on The Annoying OS, PuTTY/Pageant and OpenSSH on Windows, do not support session- or subshell-scoped spawning as they do on UNIX. So technically, these new "spawning" functions are actually "interfacing" functions. Introduce a matching type `SSHAgentInterfaceFunc` for these functions, as aluded to in a previous commit. Because the type does not return a process object, consumers of `SSHAgentSpawnFunc | SSHAgentInterfaceFunc` need to be adapted accordingly, leading to a couple of code changes. https://git.schokokeks.org/derivepassphrase.git/commit/41029a5e6ef04a9870dcaf044b54a26af94260ab software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 14:33:08 +0100 41029a5e6ef04a9870dcaf044b54a26af94260ab Move the dependent SSH agent spawn handler table closer to the original one In the testing machinery, move the "SSH agent spawn handler params" table, closer to the "SSH agent spawn handlers" table. The former is used as a parametrization set for some pytest fixtures, and is further filtered by both environment variables as well as pytest marks. Keeping these two tables closer together makes it easier to debug the SSH agent spawning machinery. https://git.schokokeks.org/derivepassphrase.git/commit/b88771770033d318a041c6ac0b0c380ae41c9f7d software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 14:13:42 +0100 b88771770033d318a041c6ac0b0c380ae41c9f7d Rename testing symbols in anticipation of The Annoying OS support Rename the `pageant` spawn handler to `unix-pageant`, the `ssh-agent` handler to `openssh`, and the `(system)` handler to `(system-agent)`. Similarly, rename the `Pageant` known SSH agent type to `UNIXPageant`, for the same reason. Since Pageant on The Annoying OS is the common configuration, and Pageant on UNIX is the exceptional configuration, Pageant on UNIX gets a decoration (the `unix-` or `UNIX` prefix). OpenSSH, on the other hand, has its default configuration on UNIX, and so gets no such decoration. Rename the `MANGLE_SSH_AUTH_SOCK` and `UNSET_SSH_AUTH_SOCK` socket address actions into `MANGLE_ADDRESS` and `UNSET_ADDRESS`, and add some minor additional documentation. Also subsume the `MANGLE_WINDOWS_NAMED_PIPE` and `UNSET_WINDOWS_NAMED_PIPE` actions, which are so far unused. The desire to mangle or unset the address for testing purposes is independent of the actual technology used to connect to the SSH agent, so it makes no sense to have separate symbols per connection technology. Rename the `SpawnFunc` type to `SSHAgentSpawnFunc`. A matching `SSHAgentInterfaceFunc` is soon to follow, which would have a very uninformative name if only named "Interface Func". https://git.schokokeks.org/derivepassphrase.git/commit/e98ea65d9d67e231c885e7c7c77574e04701d58e software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 12:34:37 +0100 e98ea65d9d67e231c885e7c7c77574e04701d58e Formalize SSH agent spawn handlers (in testing) as a real type Introduce a proper formal type for SSH agent spawn handlers in the test configuration (as a type-checked named tuple). This alone increases readability by removing the tuple indices (magic numbers) from the code. Also use this opportunity to introduce a real label and an explicit key for each entry, instead of (ab)using the executable name for these purposes. The executable name is no longer usable as a unique key if the SSH agent behaves differently (with respect to spawning) on different operating systems... as is the case for both PuTTY/Pageant and OpenSSH. https://git.schokokeks.org/derivepassphrase.git/commit/6340b5a541970c9d00ee653926102657028de309 software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 12:32:59 +0100 6340b5a541970c9d00ee653926102657028de309 Rename all stubbed test agents in a consistent manner All stubbed agents should either be named `stub_agent` or start with `stub_agent_`. Also, the test suite spawns the "stubbed agent with address and with deterministic DSA support" as "the more complicated stub agent", and the "stubbed agent with extensions" as "the plain stubbed agent". The parametrization keys however suggest otherwise, that the choice is between the "stubbed agent with extensions" and the "base stubbed agent". Fix the keys, and the returned `RunningSSHAgentInfo` structure. (The stubbed agent with extensions is the first agent to support specifying the address to connect to, which the test suite realistically needs to manipulate. The base stubbed agent *is* tested directly, however, for all functionality tests of the family of stubbed agents.) https://git.schokokeks.org/derivepassphrase.git/commit/a05c6007808393daae10e75745c5007246cbde24 software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 12:31:13 +0100 a05c6007808393daae10e75745c5007246cbde24 Fix some testing edge cases, formatting hiccups and missing debugging aids Fix some testing edge cases: - When re-registering existing SSH agent socket provider names, we now explicitly ensure that the set of (automatically determined) names is actually non-empty. - Using mangled `SSH_AUTH_SOCK` environment variables for test purposes requires `SSH_AUTH_SOCK` to actually be set. We supply a default name that is also invalid as a (non-directory) filename. Fix some unclear debugging aids: - Mangling `SSH_AUTH_SOCK` is (anecdotally) better at detecting faulty test setups, relative to the "unset `SSH_AUTH_SOCK`" entry (because failures in the latter tend to be silent). So, reorder the parametrizations to prioritize the former one over the latter one. - The SSH agent socket provider system was printing distribution names without checking for `None` distributions. - The `spawn_ssh_agent` fixture was printing exception messages directly, without the exception name, or the concrete parametrization. We now special-case `KeyError` instances (but not subclass instances). Fix other phrasings and formattings: - The skip message for SSH agents excluded via the `PERMITTED_AGENTS` environment variable was not a sentence, and just speaking of "agents", not "SSH agents". https://git.schokokeks.org/derivepassphrase.git/commit/695ca1e5dab18a14c2fbe6d3218b571183f8b08e software@the13thletter.info (Marco Ricci) Thu, 25 Dec 2025 11:34:27 +0100 695ca1e5dab18a14c2fbe6d3218b571183f8b08e