477 Commits

Author SHA1 Message Date
David Runge
d7c7f8b56b
Use common facility to provide password when setting password for key
Use the common `prompt_for_password()` function to generically ask for a
new password, when setting a new password for a key.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:55:56 +02:00
David Runge
4d2eb9aaf9
Use common facility to provide password when generating new key
Use the common `prompt_for_password()` function to generically ask for a
new password.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:55:55 +02:00
David Runge
6789a408d8
Use common facility to provide password for new subkey
Use the common `prompt_for_password()` function to generically ask for a
new password (twice!), using a common facility.
This allows to provide no password, by providing no input twice.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:55:54 +02:00
David Runge
8c317d4be5
Prompt twice for password when encrypting symmetrically
Previously, the user was only prompted once for a symmetric password,
which is potentially error-prone.
The `encrypt()` function now errors, instead of allowing to provide an
empty password.

Fixes https://gitlab.com/sequoia-pgp/sequoia-sq/-/issues/142

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:55:27 +02:00
David Runge
63f5c03e42
Add common method prompt_for_password() to create robust prompts
The `prompt_for_password()` function allows to asks for password input
twice and only returns `Some(Password)` if inputs match and are not
empty. If both inputs are empty, returns `None`.
The function takes a prompt string to provide to the user and an
optional prompt string for the repetition prompt.

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:25:05 +02:00
David Runge
963d225cb0
Improve documentation for sq encrypt --symmetric
Make clear, that the user is asked to provide a password when using this
option and that it can be provided more than once to support more than
one password.

Fixes https://gitlab.com/sequoia-pgp/sequoia-sq/-/issues/143

Signed-off-by: David Runge <dave@sleepmap.de>
2023-10-19 09:25:00 +02:00
Neal H. Walfield
61d7ad6e74
Regularize inspect's dispatch
- Adjust how `sq inspect` is dispatched to be more similar to how
    other subcommands are dispatched.
2023-10-17 14:52:23 +02:00
Neal H. Walfield
2f0fc12130
Move the deamor subcommand's dispatcher and impl to its own module 2023-10-17 14:52:23 +02:00
Neal H. Walfield
ddb3d8ffb1
Move the dump subsubcommand's impl under packet.
- The `sq packet dump` implementation lives in `commands::dump`.

  - Move the module to `commands::packet::dump` to better reflect its
    name.
2023-10-17 14:52:22 +02:00
Neal H. Walfield
51eed4ef2c
Move Convert to the root of the crate.
- `Convert` is used outside of the dump subsubcommand.

  - Move it to the root.
2023-10-17 14:52:22 +02:00
Neal H. Walfield
57b11b85f3
Move the packet subcommand's dispatcher and impl to its own module 2023-10-17 14:52:21 +02:00
Neal H. Walfield
5a2817afe5
Move the armor subcommand's dispatcher and impl to its own module 2023-10-17 14:52:21 +02:00
Neal H. Walfield
602266845e
Move the verify subcommand's dispatcher and impl to its own module 2023-10-17 14:52:20 +02:00
Neal H. Walfield
d0b583f9c0
Simplify function call
- Change `sign` from taking a single struct that bundles the
    parameters to taking each parameter as a separate argument.
2023-10-17 14:52:20 +02:00
Neal H. Walfield
58be795c25
Move the merge_signatures module under the sign module
- `merge_signatures` is only used by the `sign` subcommand.  Move
    the code under the `sign` module.
2023-10-17 14:52:19 +02:00
Neal H. Walfield
65a3b9da98
Move the sign subcommand's dispatcher to its own module 2023-10-17 14:52:18 +02:00
Neal H. Walfield
ea2feac6b1
Simplify function call
- Change `encrypt` from taking a single struct that bundles the
    parameters to taking each parameter as a separate argument.
2023-10-17 14:52:18 +02:00
Neal H. Walfield
38e16e1818
Move the encrypt subcommand's implementation to its own module 2023-10-17 14:52:17 +02:00
Neal H. Walfield
330a588377
Move the decrypt subcommand's dispatching to its own module 2023-10-17 14:52:17 +02:00
Neal H. Walfield
33e900e1f7
ci: Allow fehler
- RUSTSEC-2023-0067 was published to encourage projects to move from
    `fehler` to culpa.  `fehler` is an indirect dependency.  Allow it
    for now.
2023-10-17 14:52:16 +02:00
David Runge
66ee42f337
Allow providing a password when adding a new subkey
When providing `--with-password` to `sq key subkey add`, prompt the user
for a password, which will be added to encrypt the new subkey.
If the option is not provided and the key material is encrypted, the
password of the primary key is used.
2023-09-04 18:23:22 +02:00
David Runge
ccbbd64828
Attempt to use previously submitted password for decrypting keys.
When decrypting encrypted key material in `get_keys()` first attempt to
use passwords previously provided and only afterwards prompt the user
for a password.
2023-09-04 15:42:12 +02:00
David Runge
4e891fe36f
Allow adding new subkeys to certificates with encrypted secret keys
Without providing a password to the `KeyBuilder` and setting a primary
key signer for the `SubKeyBuilder`, it is not possible to add a new
subkey to a certificate with encrypted secret key material.

Adapt the helper function `get_primary_keys()` to return the optional
`Password` as provided by the user input, so that it may be used when
attaching a new subkey.
2023-09-04 15:42:07 +02:00
Neal H. Walfield
0dd20af066
Release 0.31.0.
* New functionality
  - `sq key subkey add` allows to create and add a new subkey to an
    existing certificate.
  - The functionality of `sq-keyring-linter` is now available as
    `sq keyring lint`.
  - The new subcommands `sq key revoke`, `sq key subkey revoke` and
    `sq key userid revoke`, allow writing to a file using the
    `--output` option.
 * Notable changes
  - The `--keyring` option is now global and can be specified anywhere
    when calling `sq`.
 * Deprecated functionality
  - The `--expires` and `--expires-in` options used in various
    subcommands are deprecated in favor of the unifying `--expiry`.
  - `sq key generate --export FILE` is deprecated in favor of the more
    generic `sq key generate --output FILE`.
  - The `sq revoke certificate` command has been renamed to `sq key
    revoke`.
  - The `sq revoke subkey` command has been renamed to `sq key subkey
    revoke`.
  - The `sq revoke userid` command has been renamed to `sq key userid
    revoke`.
2023-07-05 14:07:56 +02:00
Neal H. Walfield
8bc9c3e578
Upgrade rpassword.
- Upgrade to the latest version of rpassword.
2023-07-05 14:07:44 +02:00
Neal H. Walfield
0c7c48d044
Upgrade subplot.
- Upgrade to the latest version of subplot.
2023-07-05 14:07:39 +02:00
Neal H. Walfield
494e46b06c
Widen the itertools' version requirements.
- `sq` works with 0.11, but other depenedencies pull in 0.10.

  - We prefer fewer dependencies so keep the version in `Cargo.lock`
    at 0.10.
2023-07-05 14:00:02 +02:00
Neal H. Walfield
3f0a6facc4
Update Cargo.lock. 2023-07-05 13:54:05 +02:00
David Runge
e3954d176a
Fix publishing of container image to registry
Use the name of the git repository to match that of the published
target, as otherwise the registry denies it.

Fixes 
2023-07-04 11:07:22 +02:00
David Runge
283370b155
Add NEWS entries for 0.31.0. 2023-07-03 16:35:16 +02:00
David Runge
82a866c18d
Consolidate sq revoke commands as sq key subcommands
- Move the `sq revoke certificate`, `sq revoke subkey` and `sq revoke
  userid` subcommands below the `sq key` namespace as `sq key revoke`,
  `sq key subkey revoke` and `sq key userid revoke` (respectively). This
  consolidates commands relevant to key management below `sq key`, which
  is in line with already existing subcommands (e.g. `sq key generate`,
  `sq key subkey add` or `sq key userid add`).
- Replace the use of a common `revoke()` with `CertificateRevocation`,
  `SubkeyRevocation` and `UserIDRevocation` to reduce complexity and
  allow for easier per target (i.e., certificate, subkey or userid)
  command modification.
- Allow specifying an output file using `--output`/ `-o` for all
  revocation subcommands (i.e., `sq key revoke`, `sq key subkey revoke`,
  `sq key userid revoke`). If unspecified, output goes to stdout as
  before.
- Add common test facilities to create a default certificate in a
  temporary directory.
- Add common test function to compare a set of notations with those in
  a `Signature`.
- Replace the integration tests which used to test a combined `sq
  revoke` subcommand with integration tests for `sq key subkey revoke`,
  `sq key userid revoke` and `sq key revoke` using direct and third
  party revocation.

Fixes 
2023-07-03 16:04:51 +02:00
David Runge
27d04a26f1
Make commands::get_certification_keys() public
As we have to use it in further subcommands it is easier to have a public function.
2023-07-03 14:51:24 +02:00
David Runge
3adec8e545
Rename sq keyring linter to sq keyring lint
To match the setup of the other subcommands (which follow a noun [noun]
verb approach), rename `sq keyring linter` to `sq keyring lint`.

Fixes 
2023-07-03 14:23:17 +02:00
Heiko Schaefer
da0660a1c3
Terminology fix. 2023-06-30 17:53:40 +02:00
Jan Christian Grünhage
5fb976a2a9
Update Cargo.lock. 2023-06-22 11:56:19 +02:00
Jan Christian Grünhage
01cb33e27a
ci: Make codespell happy.
- `codespell` is unhappy with the names `certp`, `certi`, and
  `certo`.  Allow them.
2023-06-22 11:19:28 +02:00
Jan Christian Grünhage
1504a3aa2c
Clean up emacs comments in sq keyring linter subcommand definition 2023-06-22 11:19:28 +02:00
Jan Christian Grünhage
74fd9dd8fe
Move keyring-linter into sq keyring as a subcommand
This commit is mostly a copy over from the keyring-linter repository,
with a few changes included to make it work in the sq codebase. These
changes are:
 - replaced calls to atty with calls to is-terminal. This was done due
   to is-terminal already being in the dependency tree of sq, and atty
   being unmaintained.
 - replace ansi_term with termcolor, because ansi_term is unmaintained
 - removed a few things from the keyring linter, that were also present
   in sq itself, to avoid duplication. This included the reference time
   parameter, key decryption and IO handling
 - added output file and binary parameters to the linter, so that I
   could handle output the same as the other commands do
2023-06-22 11:19:27 +02:00
Jan Christian Grünhage
f3cfb1b602
Only prompt for passwords when trying to decrypt a key if stdin is a terminal 2023-06-21 10:36:58 +02:00
David Runge
6ac9c2761a
Fix use of --output when importing to cert-store is the default
- As clap can not use `Default` as advertised for certain types [1], use
  `Option<FileOrStdout>` instead in cases where the default is to import
  to cert-store. Semantically, this works as before: By default import
  to cert-store, when providing "-" output to stdout and when providing
  a file name output to the file.
- Since `FileOrCertStore` can not wrap any other type under the given
  circumstances, turn it into an empty struct that only implements
  `ClapData` to provide static strings for the clap setup.
- Adapt the help message for `FileOrCertStore` to mention, that
  providing "-" leads to output on stdout.

Fixes 

[1] https://github.com/clap-rs/clap/issues/4558
2023-06-20 10:45:58 +02:00
Stacey Sheldon
e8b31100cb
Fix minor typo in help text. 2023-06-19 09:31:00 +02:00
David Runge
3c90428112
Rename --export option of sq key generate to the generic --output
Instead of using a non-uniform `--export` for `sq key generate` to
indicate the file path to output to, rely on the generic `--output`,
provided by `sq_cli::types::FileOrStdout`.
2023-06-17 15:51:25 +02:00
David Runge
ed6069623b
Replace CLI I/O argument duplication with common facilities
- Replace `sq_cli::types::IoArgs` with the more granular
  `sq_cli::types::FileOrStdin`, `sq_cli::types::FileOrCertStore` and
  `sq_cli::types::FileOrStdout`.
- Replace all generic `input` (describing single files) and `output`
  arguments with the respective new facilities to share code and not
  repeat ourselves.
- Replace the `open_or_stdin()` function with `FileOrStdin::open()`.
- Replace the `create_or_stdout()` function with the private
  `FileOrStdout::create()`, so that it can not be called directly.
- Replace the `emit_unstable_cli_warning()`
  and `create_or_stdout_unsafe()` functions with
  `FileOrStdout::create_unsafe()`.
- Replace the `create_or_stdout_safe()` function with
  `FileOrStdout::create_safe()`.
- Replace the `create_or_stdout_pgp()` function with
  `FileOrStdout::create_pgp_safe()`.
- Remove the field `unstable_cli_warning_emitted` from `Config`, as
  it is replaced by the static `UNSTABLE_CLI_WARNING`, which allows for
  tracking whether a warning has been emitted across several instances
  of `FileOrStdout`.
2023-06-17 15:39:14 +02:00
David Runge
8f57c0d9f2
Refactor: Use PathBuf instead of String for file related CLI options
- Replace `Option<String>` and `Vec<String>` based CLI options dealing
  with files with `Option<PathBuf>` and `Vec<PathBuf>` based ones
  (respectively).
  This allows us to unify the use of input and output facilities using
  globally available CLI options while ensuring (cross-platform) type
  safety.
2023-06-12 17:44:55 +02:00
David Runge
3f147af820
Make --keyring option globally available and use it in sq key adopt
- Set the `--keyring` option to be globally available, allowing it to
  be added anywhere on the commandline and not just as first parameter
  before any subcommand.
- Replace the `Vec<String>` based `--keyring` option for `sq key adopt`
  with the now globally available `Vec<PathBuf>` based `--keyring`
  option and adopt the code accordingly.
2023-06-12 17:44:52 +02:00
David Runge
3ea5afe4e3
Add instructions on man page creation to README
- Add instructions on how to build the `sq` executable and its shell
 completions.
- Add information on how to generate the man pages using the `SQ_MAN`
  environment variable.
- Disable printing of info about `clap_mangen` generated man pages,
  since they still lack features and are partially incorrect.
2023-06-12 16:14:50 +02:00
David Runge
dc501f7a6e
Add specific information on validity period to subcommand docs
Add specific information on default validity periods to the long
documentation of `sq certify`, `sq key generate` and `sq link add`.
2023-06-05 15:57:45 +02:00
David Runge
96bd7e9b9e
Fix help output for sq key generate
Make a specific connection between "both" and "universal", so that the
user has an easier time to infer, that with choosing "universal" both
encryption purposes are added.
2023-06-05 15:57:43 +02:00
David Runge
9c35ffa019
Use common abstraction to get CipherSuite in sq key generate
Use `sq_cli:🔑:CipherSuite::as_ciphersuite()` in `sq key` subcommand
to derive a valid `openpgp::cert::CipherSuite` from a variant of
`sq_cli:🔑:CipherSuite`.
2023-06-05 15:57:40 +02:00
David Runge
778741b2f8
Simplify use of validity in certify, key and link subcommands
- Change the behavior of the `sq certify`, `sq key generate` and `sq
  link add` subcommands to rely on a single `--expiry` input argument
  (same as `sq key subkey generate`), which replaces `--expires` and
  `--expires-in`. This allows to directly parse a specific ISO 8601
  timestamp, a custom duration or `"never"` and create a verified data
  type that can be used further.
- Use `Expiry::as_duration()` in `sq certify` and `sq key`
  subcommands to calculate the validity (duration until expiration) of
  certifications and keys.
- Add the constants `KEY_VALIDITY_IN_YEARS` and
  `THIRD_PARTY_CERTIFICATION_VALIDITY_IN_YEARS` to `sq_cli` to allow
  centralized modifications of the default validity duration of keys and
  certifications (in years).
- Add the constants `KEY_VALIDITY_DURATION` and
  `THIRD_PARTY_CERTIFICATION_VALIDITY_DURATION` to provide
  the default `Duration` for keys/subkeys and third party
  certifications (based on `KEY_VALIDITY_IN_YEARS` and
  `THIRD_PARTY_CERTIFICATION_VALIDITY_IN_YEARS`).
2023-06-05 15:57:38 +02:00