sq-key-userid - Man Page
Manage User IDs
Synopsis
sq key userid add [OPTIONS]
sq key userid revoke [OPTIONS] REASON MESSAGE
sq key userid strip [OPTIONS]
Description
Manage User IDs.
Add User IDs to a key, or revoke them.
Subcommands
sq key userid add
Add a user ID.
A user ID can contain a name, like `Juliet`, or an email address, like `<juliet@example.org>`. Historically, a name and an email address were usually combined as a single user ID, like `Juliet <juliet@example.org>`. However, user IDs that include different information such as name and email address are more difficult to reason about, so using distinct user IDs for name and email address is preferred nowadays.
`sq userid add` respects the reference time set by the top-level `--time` argument. It sets the creation time of the user ID's binding signature to the specified time.
sq key userid revoke
Revoke a user ID.
Creates a revocation certificate for a user ID.
If `--revoker` or `--revoker-file` is provided, then that key is used to create the revocation certificate. If that key is different from the certificate that is being revoked, this results in a third-party revocation. This is normally only useful if the owner of the certificate designated the key to be a designated revoker.
`sq key userid revoke` respects the reference time set by the top-level `--time` argument. When set, it uses the specified time instead of the current time when determining what keys are valid, and it sets the revocation certificate's creation time to the reference time instead of the current time.
sq key userid strip
Strip a user ID.
Note that this operation does not reliably remove User IDs from a certificate that has already been disseminated! (OpenPGP software typically appends new information it receives about a certificate to its local copy of that certificate. Systems that have obtained a copy of your certificate with the User ID that you are trying to strip will not drop that User ID from their copy.)
In most cases, you will want to use the 'sq key userid revoke' operation instead. That issues a revocation for a User ID, which can be used to mark the User ID as invalidated.
However, this operation can be useful in very specific cases, in particular: to remove a mistakenly added User ID before it has been uploaded to key servers or otherwise shared.
Stripping a User ID may change how a certificate is interpreted. This is because information about the certificate like algorithm preferences, the primary key's key flags, etc. is stored in the User ID's binding signature.
Examples
sq key userid add
Add a new user ID to Alice's key.
sq key userid add --cert \
EB28F26E2739A4870ECC47726F0073F60FD0CBF0 --name Alice \--email alice@work.example.com
sq key userid revoke
Retire a user ID on Alice's key.
sq key userid revoke --cert \
EB28F26E2739A4870ECC47726F0073F60FD0CBF0 --userid \"Alice <alice@example.org>" retired \
"No longer at example.org."
sq key userid strip
Strip a User ID from a cert in the cert store.
sq key userid strip --cert \
EB28F26E2739A4870ECC47726F0073F60FD0CBF0 --userid \"Alice <alice@example.org>"
See Also
sq(1), sq-key(1), sq-key-userid-add(1), sq-key-userid-revoke(1), sq-key-userid-strip(1).
For the full documentation see <https://book.sequoia-pgp.org>.
Version
0.38.0 (sequoia-openpgp 1.21.2)
Referenced By
sq-key(1), sq-key-userid-add(1), sq-key-userid-revoke(1), sq-key-userid-strip(1).