Recent commits to derivepassphrase.git (09e86bfa6549230d20c41600a57c3a7c37bb9397)

Fortify the argument parsing and handling in the command-line interface

2024-06-22T21:19:30+02:00

Currently, we use a one-to-one correspondence between command-line
argument name and function argument, via catch-all keyword arguments.
This is very unwieldy to use with type checking, it exposes us to name
clashes with Python keywords, and it doesn't even save that much typing
effort because the arguments still ought to be documented in the
documentation anyway. Therefore, introduce an explicit target parameter
name for the `click` interface and corresponding explicit function
arguments. (The implicit list of (function) arguments that `click`
passes to the function is already readily available in the context
object.)

As a related problem, the code for checking whether incompatible options
were specified also relies (excessively cleverly) on command-line
argument names and function argument names being equal, and sometimes
conflates short and long option names, leading to it missing some
examples of incompatible options. Therefore, instead, explicitly build
a map of (short and long) option names to option objects and test
whether incompatible option objects were used.
</pre>

Move typing classes into separate module `derivepassphrase.typing`

2024-06-22T21:19:30+02:00

In particular, include type guard functions here as well.
</pre>

Support textual passphrases, if it is safe

2024-06-22T21:19:30+02:00

Some level of awareness is necessary to support passphrases stored in
(JSON) config files.  We reject the passphrase if there are multiple
Unicode representations (and thus UTF-8 representations) of the same
text but with different normalizations.  In such a case, a byte string
must be used, and the value cannot currently be stored in the JSON
config file.
</pre>

Fix passphrase-from-SSH-signature calculation

2024-06-22T21:19:30+02:00

In vault(1), the passphrase derived from an SSH key signature is *not*
just the (framed, binary) SSH signature of the vault UUID.  Instead, the
payload part of the signature, in binary, is converted to base64,
yielding the passphrase.  Rewrite the `Vault.phrase_from_signature`
method to match vault's behavior, and rename it to `phrase_from_key` to
better match the *actual* interface (which takes an SSH key, not
a signature).

(This design – emitting an SSH signature as payload only, in base64 – is
hard-coded into the SSH agent client library used by vault, and likely
not a conscious design by vault's primary author.)
</pre>

Expose some functionality from `Vault` as interal methods

2024-06-22T21:19:30+02:00

Expose some functionality from `derivepassphrase.Vault` as interal
methods, to facilitate testing and to avoid reimplementing the same
functionality again in the command-line interface.  This includes hash
length estimation and SSH key suitability checking.
</pre>

Add function for SSH framed byte strings with trailing data

2024-06-22T21:19:30+02:00

The new function `ssh_agent_client.unstring_prefix` does not abort if
there is trailing data after the SSH framed byte string.
</pre>

Remove public attributes of `ssh_agent_client.SSHAgentClient`

2024-06-22T21:19:30+02:00

</pre>

Add prototype command-line interface

2024-06-22T19:54:19+02:00

</pre>

Reformat binary test data to aligned hex view

2024-06-08T19:14:35+02:00

For those familiar with SSH protocol messages, make the data more
readable by aligning the hex view on the data boundaries according to
the protocol.
</pre>

Remove about.py files, use init.py instead

2024-06-08T19:07:53+02:00

Apparently, this is a `hatch` convention/tradeoff, but one that doesn't
appear sensible to a project like this.

On that note, since we're starting with a clear target API in mind,
start directly at release 0.1.0 instead of the `hatch` default 0.0.1.
</pre>

Recent commits to derivepassphrase.git (09e86bfa6549230d20c41600a57c3a7c37bb9397)

Fortify the argument parsing and handling in the command-line interface

Move typing classes into separate module `derivepassphrase.typing`

Support textual passphrases, if it is safe

Fix passphrase-from-SSH-signature calculation

Expose some functionality from `Vault` as interal methods

Add function for SSH framed byte strings with trailing data

Remove public attributes of `ssh_agent_client.SSHAgentClient`

Add prototype command-line interface

Reformat binary test data to aligned hex view

Remove __about__.py files, use __init__.py instead

Remove about.py files, use init.py instead