slipenkomk/sequoia-sq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
33dc4a1b41
sequoia-sq/NEWS
Neal H. Walfield 5ec89e8abe
Allow modifying the key flags when adopting a key. 
- Add `--can-sign`, `--cannot-sign`, `--can-authenticate`,
    `--cannot-authenticate`, `--can-encrypt`, `--cannot-encrypt` to `sq
    key adopt`, which modify the key flags of the adopted key.
2024-09-26 13:05:36 +02:00

357 lines
17 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

-*- org -*-
#+TITLE: sequoia-sq NEWS – history of user-visible changes
#+STARTUP: content hidestars
* Changes in 0.39.0
** Notable changes
- Subcommand `sq key userid strip` has been moved to `sq toolbox
strip-userid`.
- `sq key adopt` supports adopting bare keys (i.e., a primary key
without any signatures).
- `sq key adopt` add options (`--can-`--can-sign`, `--cannot-sign`,
`--can-authenticate`, `--cannot-authenticate`, `--can-encrypt`,
`--cannot-encrypt`) to allow overriding the key flags.
* Changes in 0.38.0
** Notable changes
- New subcommand `sq key subkey delete` to delete secret key
material.
- New subcommand `sq network wkd publish` that publishes
certificates in a WKD over rsync.
- Removed now obsolete `sq network wkd generate`.
- Removed `sq network wkd url` and `sq network wkd direct-url`.
- Renamed subcommand `sq key attest-certifications` to `sq key
approvals update` to reflect the new name in the draft, and to
make room for introspection commands.
- New subcommand `sq key subkey password` to change the password
protecting secret key material.
- The subcommand `sq network keyserver publish` can now publish
certs from the certificate store using the `--cert` parameter.
- The subcommands `sq key generate` and `sq key userid add` gained
the options `--name` and `--email` as a more user-friendly way to
specify user IDs.
- All short options with the exception of `-v` have been removed.
We will judiciously add some back before releasing 1.0.
- The dot output has been removed. Those relying on it can use the
standalone sq-wot tool.
- New subcommand `sq key subkey export` to export individual keys.
This functionality was split off from `sq key export`.
- `sq key generate` and `sq key subkey add` now prompt for a
password by default. This can be disabled by passing
`--without-password`.
- New subcommand `sq key approvals list` that lists approved
third-party certifications and those pending approval.
- Remove `sq cert export`'s `--key` argument. Change `--cert` to
match both primary keys and subkeys.
* Changes in 0.37.0
** Notable changes
- Remove PKS support.
- `sq key userid add` can now use the certificate store and the
keystore.
- `sq key userid add` no longer accepts positional arguments. The
user ID is provided by the `--userid` argument, and the
certificate by `--cert` or `--cert-file`.
- Drop the `--certificate-file` argument from `sq key revoke`, `sq
key subkey revoke`, and `sq key userid revoke` drop the
`--certificate-file`. (The certificate can still be specified
using `--cert-file`.)
- Rename the `--revocation-file` argument to `--revoker-file` in
`sq key revoke`, `sq key subkey revoke`, and `sq key userid
revoke`.
- `sq key revoke --cert-file`, `sq key revoke --revoker-file` `sq
key subkey revoke --cert-file`, `sq key subkey revoke
--revoker-file`, `sq key userid revoke --cert-file`, and `sq key
userid revoke --revoker-file` now accept `-`, which means to read
from stdin.
- `sq key revoke`, `sq key subkey revoke`, and `sq key userid
revoke` now reads from the certificate store when using `--cert`
or --revoker`. When `--cert` is used, and `--output` is not
specified, the resulting revocation certificate is saved to the
certificate store.
- The user ID argument to `sq key userid revoke` is no longer a
positional argument, but must be specified with `--userid`.
- Change `sq cert lint` to not read from stdin by default.
- In `sq cert lint`, change the certificate file parameter from a
positional parameter to a named parameter, `--cert-file`.
- `sq cert lint` can now use the certificate store and the
keystore.
- In `sq key subkey add`, change the certificate file parameter
from a positional parameter to a named parameter, `--cert-file`.
- `sq key subkey add` now reads from the certificate store when
using `--cert`. When `--cert` is used, and `--output` is not
specified, the new subkey is saved to the key store.
- In `sq key expire`, change the certificate file parameter from a
positional parameter to a named parameter, `--cert-file`.
- Split the functionality to update a subkey's expiration time off
of `sq key expire` and into `sq key subkey expire`.
- Rename `sq key subkey expire`'s `--subkey` argument to `--key`.
- `sq key expire` and `sq key subkey expire` can now use the
cert store and the key store.
- Add the `--password-file` argument to the `sq sign` command to
allow the user to prefill the password cache with a password from
a file.
- In `sq key password`, change the certificate file parameter from a
positional parameter to a named parameter, `--cert-file`.
- `sq pki certify`'s certifier parameter interprets `-` as meaning
it should read the certificate from stdin.
- In `sq pki certify`, change the certifier file parameter from a
positional parameter to a named parameter, `--certifier-file`.
- `sq pki certify` can now use the cert store and the key store.
- In `sq key adopt`, change the certificate file parameter from a
positional parameter to a named parameter, `--cert-file`.
- `sq key adopt` can now use the cert store and the key store.
- In `sq key attest-certifications`, change the certificate file
parameter from a positional parameter to a named parameter,
`--cert-file`.
- In `sq key attest-certifications`, don't make `--all` the
default, but require the user to specify it (or `--none`)
explicitly.
- `sq key attest-certifications` can now use the cert store and the
key store.
- Rename the `--expiry` argument to `--expiration`.
- Rename `sq key password`'s `--clear` argument to `--clear-password`.
- Add a top-level `--password-file` argument to seed the password
cache. Remove `sq key password`'s `--old-password-file`, and `sq
sign`'s `--password-file` local arguments in favor of this
argument.
* Changes in 0.36.0
- Missing
* Changes in 0.35.0
- Missing
* Changes in 0.34.0
** Notable changes
- `sq` now uses `sequoia-keystore` for secret key operations.
When decrypting a message, `sq` will automatically ask the
keystore to decrypt the message. `sq sign --signer-key` can be
used to specify a signing key managed by the key store.
- New top-level option: `sq --no-key-store`: A new switch to
disable the use of the key store.
- New top-level option: `sq --key-store`: A new option to use an
alternate key store.
- New subcommand `sq key list` to list keys managed by the key
store.
- New subcommand `sq key import` to import a key into the key
store.
- When showing a user ID for a certificate, choose the one that is
most authenticated.
- `sq network wkd publish` publishes and updates WKD hierarchies
via rsync.
* Changes in 0.33.0
** Notable changes
- The command line interface has been restructured. Please consult
the manual pages and review any code and documents using the
interface. Notably:
- `sq import` and `sq export` have been moved to `sq cert`.
- `sq wot` has been renamed to `sq pki`.
- `sq link` and `sq certify` have been moved to `sq pki`.
- `sq lookup, `sq keyserver`, `sq wkd`, and `sq dane` have been
moved to `sq network`.
- All commands retrieving certificates from network services are
now called `fetch`, e.g. `sq network fetch` and `sq network
dane fetch`. The command for publishing certs on key servers
is now called `sq network keyserver publish`.
- `sq armor`, `sq dearmor`, and `sq packet` have been moved to
`sq toolbox`.
- `sq --version` is now `sq version`, and `sq output-versions`
has been integrated with that command.
- The manual page generation has been improved, and manual pages
and shell completions are generated during the build process. To
write the assets to a predictable location, set the environment
variable `ASSET_OUT_DIR` to a suitable location.
* Changes in 0.32.0
** New functionality
- Support for password-encrypted keys has been improved. For
example, a newly generated subkey can be password protected.
- When encrypting a message with a password, or creating a new
password-protected key or subkey, or changing passwords on a key,
sq now prompts you to repeat the password to catch typos.
- Literal data metadata can now be set using
`--set-metadata-filename` and `--set-metadata-time`.
- sq now reads the file
/etc/crypto-policies/back-ends/sequoia.config
to configure its cryptographic policy. The file to load can be
overridden using the SEQUOIA_CRYPTO_POLICY environment variable.
For more information on the format, see:
https://docs.rs/sequoia-policy-config/latest/sequoia_policy_config/#format
- New subcommand: `sq dane generate`.
Generates DANE records for the given domain and certificates. DANE is a
way to distribute OpenPGP certificates via DNS.
https://www.rfc-editor.org/rfc/rfc7929.html
- When querying network resources via `sq keyserver get`, `sq wkd
get`, or `sq dane get`, multiple queries can be given that are
executed simultaneously.
- When querying key servers via `sq keyserver get` or `sq keyserver
send`, multiple servers are queried simultaneously.
- There are now four default keyservers:
- hkps://keys.openpgp.org
- hkps://mail-api.proton.me
- hkps://keys.mailvelope.com
- hkps://keyserver.ubuntu.com
- New subcommand: `sq lookup`.
Searches for certificates using all supported network services.
** Notable changes
- Padding has been disabled to increase compatibility with other
implementations.
The padding method we previously used relies on a compressed data
packet to pad the message. However, some implementations do not
gracefully process these padded encryption containers, so until
we get proper padding support from the next revision of OpenPGP,
we disable padding.
- Message notarization has been disabled.
Message notarization and their semantics are not well defined,
and there is no consensus on how to do that.
- When doing a userid, subkey, or third-party certificate
revocation, with the cert given to --certificate-file containing
secret key material, we previously emitted a revocation
certificate containing secret key material. This has been fixed,
and tests have been added to ensure secret key material is only
emitted where we expect it to be.
* Changes in 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`.
* Changes in 0.30.1
** Notable changes
- The `crypto-botan` feature now selects Botan's v3 interface. Use
the new `crypto-botan2` feature to continue using Botan's v2
interface.
** Notable fixes
- Several parser bugs were fixed in sequoia-openpgp 1.16.0 and
buffered-reader 1.2.0. These are all low-severity as Rust
correctly detects the out of bounds access and panics. Update
Cargo.lock to make sure we use these versions.
* Changes in 0.30
** New functionality
- `sq key adopt` now honors `--time`.
- Add `sq key adopt --expire` to allow setting an adopted key's
expiration time.
- Add support for using pEp's certificate store. A pEp certificate
store can be used by specifying `sq --pep-cert-store PATH` or
setting the environment variable `PEP_CERT_STORE`.
* Changes in 0.29
** New functionality
- `sq` now supports and implicitly uses a certificate store. By
default, `sq` uses the standard OpenPGP certificate directory.
This is located at `$HOME/.local/share/pgp.cert.d` on XDG
compliant systems.
- `sq --no-cert-store`: A new switch to disable the use of the
certificate store.
- `sq --cert-store`: A new option to use an alternate certificate
store. Currently, only OpenPGP certificate directories are
supported.
- `sq import`: A new command to import certificates into the
certificate store.
- `sq export`: A new command to export certificates from the
certificate store.
- `sq encrypt --recipient-cert`: A new option to specify a
recipient's certificate by fingerprint or key ID, which is then
looked up in the certificate store.
- `sq verify --signer-cert`: A new option to specify a signer's
certificate by fingerprint or key ID, which is then looked up in
the certificate store.
- `sq verify` now also implicitly looks for missing certificates in
the certificate store. But, unless they are explicitly named
using `--signer-cert`, they are not considered authenticated and
the verification will always fail.
- `sq certify`: If the certificate to certify is a fingerprint or
Key ID, then the corresponding certificate is looked up in the
certificate store.
- Add a global option, `--time`, to set the reference time. This
option replaces the various subcommand's `--time` argument as
well as `sq key generate` and `sq key userid add`'s
`--creation-time` arguments.
- Add top-level option, `--trust-root`, to allow the user to
specify trust roots.
- Extend `sq encrypt` to allow addressing recipients by User ID
(`--recipient-userid`) or email address (`--recipient-email`).
Only User IDs that can be fully authenticated are considered.
- Extend `sq verify` to verify certificates looked up from the
certificate store using the web of trust. If the signature
includes a Signer's User ID packet, and the binding can be fully
authenticated, consider the signature to be authenticated. If
there is no Signer's User ID packet, consider the signature to be
authenticated if any binding can fully be authenticated.
- Add `sq link add`, which uses the local trust root to
certify the specified bindings.
- Add `sq link retract`, which retracts certifications made by the
local trust root on the specified bindings.
- Add `sq link list`, which lists the links.
- Add a top-level option, `--keyring`, to allow the user to specify
additional keyrings to search for certificates.
- Import web of trust subcommands from sq-wot. Specifically, add:
- `sq wot authenticate` to authenticate a binding.
- `sq wot lookup` to find a certificate with a particular User ID.
- `sq wot identify` to list authenticated bindings for a
certificate.
- `sq wot list` to list authenticated bindings.
- `sq wot path` to authenticate and lint a path in a web of trust.
- `sq keyserver get`, `sq wkd get`, and `sq dane get` now import any
certificates into the certificate store by default instead of
exporting them on stdout. It is still possible to export them
using the `--output` option.
- When `sq keyserver get` (for verifying key servers), `sq wkd get`,
or `sq dane get` saves a certificate to the local certificate
store, `sq` certifies the validated User IDs (all returned User
IDs in the case of verifying key servers; User IDs that contain
the looked up email address in the case of WKD and DANE) using a
local service-specific proxy CA. If the proxy key doesn't exist,
it is created, and certified as a minimally trusted CA (trust
amount 1 of 120) by the local trust root. The proxy certificates
can be managed in the usual way using `sq link add` and `sq link
retract`.
- Extend `sq inspect` to inspect certificates from the certificate
store using the `--cert` option.
** Deprecated functionality
- `sq key generate --creation-time TIME` is deprecated in favor of
`sq key generate --time TIME`.
- `sq key user id --creation-time TIME` is deprecated in favor of
`sq user id --time TIME`.
* Started the NEWS file.
Reference in New Issue View Git Blame Copy Permalink