Sponsor:

Your company here — click to reach over 10,000 unique daily visitors

sq-key - Man Page

Manage keys

Synopsis

sq key list [OPTIONS]  
sq key generate [OPTIONS]  
sq key import [OPTIONS] KEY_FILE
sq key export [OPTIONS]  
sq key delete [OPTIONS]  
sq key password [OPTIONS]  
sq key expire [OPTIONS] EXPIRATION
sq key revoke [OPTIONS] REASON MESSAGE
sq key userid [OPTIONS]  SUBCOMMAND
sq key subkey [OPTIONS]  SUBCOMMAND
sq key attest-certifications [OPTIONS]  
sq key adopt [OPTIONS]  

Description

Manage keys.

We use the term "key" to refer to OpenPGP keys that do contain secrets.  This subcommand provides primitives to generate and otherwise manipulate keys.

Conversely, we use the term "certificate", or "cert" for short, to refer to OpenPGP keys that do not contain secrets.  See `sq cert` for operations on certificates.

Subcommands

sq key list

List keys managed by the key store.

sq key generate

Generate a new key.

Generating a key is the prerequisite to receiving encrypted messages and creating signatures.  There are a few parameters to this process, but we provide reasonable defaults for most users.

When generating a key, we also generate an emergency revocation certificate. This can be used in case the key is lost or compromised.  It is saved alongside the key.  This can be changed using the `--rev-cert` argument.

By default a key expires after 3 years.  This can be changed using the `--expiration` argument.

`sq key generate` respects the reference time set by the top-level `--time` argument.  It sets the creation time of the primary key, any subkeys, and the binding signatures to the reference time.

sq key import

Import keys into the key store.

sq key export

Export keys from the key store.

sq key delete

Delete a certificate's secret key material.

sq key password

Change the password protecting secret key material.

Secret key material can be protected by a password.  This subcommand changes or clears the password.

To strip the password either use `--clear` or supply a zero-length password when prompted for the new password.

If a key is password protected, and the correct password was not supplied using the `--password-file` argument, the user is prompted for the password.  Likewise, if the new password isn't provided, the user is prompted.

sq key expire

Change expiration times.

Change or clear a certificate's expiration time.

This subcommand changes the certificate's expiration time.  To change the expiration time of an individual subkey, use the `sq key subkey expire` subcommand.

sq key revoke

Revoke a certificate.

Creates a revocation certificate for a certificate.

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 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

Manage User IDs.

Add User IDs to a key, or revoke them.

sq key subkey

Manage subkeys.

Add new subkeys to an existing certificate, change their expiration, and revoke them.

sq key attest-certifications

Attest to third-party certifications allowing for their distribution.

To prevent certificate flooding attacks, modern key servers prevent uncontrolled distribution of third-party certifications on certificates.  To allow the key holder to control what information is distributed with their certificate, these key servers only distribute third-party certifications that the key holder has explicitly approved.

After the attestation has been created, the certificate has to be distributed, e.g. by uploading it to a key server.

sq key adopt

Bind keys from one certificate to another.

This command allows the user to attach a primary key or a subkey attached to one certificate to another certificate.  Say you want to transition to a new certificate, but have an authentication subkey on your current certificate that you want to keep because it allows access a server and updating its configuration is not feasible.  This command makes it easy to attach the subkey to the new certificate.

Examples

sq key list

List the keys managed by the keystore server.

    sq key list

sq key generate

Generate a key, and save it on the key store.

    sq key generate --userid "Alice <alice@example.org>"

Generate a key, and save it in a file instead of in the key store.

    sq key generate --userid "Alice <alice@example.org>" --output \
    alice-priv.pgp

Strip the secret key material from the new key.

    sq toolbox extract-cert alice-priv.pgp --output alice.pgp

sq key import

Import the keys into the key store.

    sq key import alice-secret.pgp

sq key export

Import a certificate.

    sq key import alice-secret.pgp

Export Alice's certificate with all available secret key material.

    sq key export --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Export Alice's signing-capable and encryption-capable subkeys, but not her primary key or her authentication-capable subkey.

    sq key export --key 42020B87D51877E5AF8D272124F3955B0B8DECC8 \
    --key 74DCDEAF17D9B995679EB52BA6E65EA2C8497728

sq key delete

Import Alice's key.

    sq key import alice-secret.pgp

Delete any secret key associated with the certificate.

    sq key delete --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0

sq key password

Import a key that has no password protection.

    sq key import alice-secret.pgp

Change the password for all keys to password in the specified file.

    sq key password --new-password-file password-file.txt --cert \
    EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Clear the password protection.

    sq key password --password-file password-file.txt \
    --clear-password --cert \

EB28F26E2739A4870ECC47726F0073F60FD0CBF0

sq key expire

Make Alice's key expire in a year.

    sq key expire 1y --cert-file alice-secret.pgp

Make Alice's key never expire.

    sq key expire never --cert-file alice-secret.pgp

sq key revoke

Import a key.

    sq key import alice-secret.pgp

Revoke the key, indicating that there is a new certificate.

    sq key revoke --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0 \
    superseded \

"My new cert is 31EC6A9453BC59F1239C785E4CA79EF01933A2ED"

Revoke the key, indicating that the secret key material was compromised.

    sq key revoke --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0 \
    compromised \

"Computer attacked, secret key material compromised"

sq key attest-certifications

Import Alice's key.

    sq key import alice-secret.pgp

Attest to all of the certifications on all the user IDs.

    sq key attest-certifications --all --cert \
    EB28F26E2739A4870ECC47726F0073F60FD0CBF0

sq key adopt

Import Alice's old key and new key.

    sq key import alice-secret.pgp alice-new-secret.pgp

Have the new certificate adopt Alice's old authentication subkey.

    sq key adopt --cert C5999E8191BF7B503653BE958B1F7910D01F86E5 \
    --key 0D45C6A756A038670FDFD85CB1C82E8D27DB23A1

See Also

sq(1), sq-key-list(1), sq-key-generate(1), sq-key-import(1), sq-key-export(1), sq-key-delete(1), sq-key-password(1), sq-key-expire(1), sq-key-revoke(1), sq-key-userid(1), sq-key-subkey(1), sq-key-attest-certifications(1), sq-key-adopt(1).

For the full documentation see <https://book.sequoia-pgp.org>.

Version

0.37.0 (sequoia-openpgp 1.21.1)

Referenced By

sq(1), sq-key-adopt(1), sq-key-attest-certifications(1), sq-key-delete(1), sq-key-expire(1), sq-key-export(1), sq-key-generate(1), sq-key-import(1), sq-key-list(1), sq-key-password(1), sq-key-revoke(1), sq-key-subkey(1), sq-key-subkey-add(1), sq-key-subkey-expire(1), sq-key-subkey-revoke(1), sq-key-userid(1), sq-key-userid-add(1), sq-key-userid-revoke(1), sq-key-userid-strip(1).

0.37.0 Sequoia PGP