sq-key - Man Page

List keys managed by the key store.

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.

Import keys into the key store.

Export keys from the key store.

Exports the secret key material associated with a certificate.  Note that even if secret key material is available, it may not be exportable.  For instance, secret key material stored on a hardware security module usually cannot be exported from the device.

If you only want to export a particular key and not all keys associate with a certificate, use `sq key subkey export`.

Delete a certificate's secret key material.

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.

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.

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.

Manage User IDs.

Add User IDs to a key, or revoke them.

Manage subkeys.

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

Manages certification approvals.

Key holders may approve of third-party certifications associated with their certificate.  This subcommand manages the approvals.

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.

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.

List the keys managed by the keystore server.

    sq key list

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

    sq key generate --without-password --name Alice --email \
    alice@example.org

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

    sq key generate --without-password --name Alice --email \
    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

Import the keys into the key store.

    sq key import alice-secret.pgp

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

    sq key export --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Delete any secret key associated with Alice's certificate.

    sq key delete --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Change the password for all of Alice's keys to the password in the specified file.

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

Clear the password protection for all of Alice's keys.

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

Make Alice's key expire in a year.

    sq key expire 1y --cert \
    EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Make Alice's key never expire.

    sq key expire never --cert \
    EB28F26E2739A4870ECC47726F0073F60FD0CBF0

Revoke Alice's key, indicating that there is a new certificate.

    sq key revoke --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0 \
    superseded \

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

    sq key revoke --cert EB28F26E2739A4870ECC47726F0073F60FD0CBF0 \
    compromised \

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

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