Reference

sq-key-password(1)

Change the password protecting secret key material

NAME

sq-key-password - Change the password protecting secret key material

SYNOPSIS

sq key password [OPTIONS]

DESCRIPTION

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.

OPTIONS

Subcommand options

--cert=FINGERPRINT|KEYID

Change the password for the secret key material from the key with the specified fingerprint or key ID

--cert-email=EMAIL

Change the password for the secret key material from the key where a user ID includes the specified email address

--cert-file=PATH

Change the password for the secret key material from the key read from PATH

--cert-userid=USERID

Change the password for the secret key material from the key with the specified user ID

--clear-password

Clear the password protecting the secret key material

--new-password-file=PASSWORD_FILE

File containing password to encrypt the secret key material

Note that the entire key file will be used as the password including any surrounding whitespace like a trailing newline.

--output=FILE

Write to FILE or stdout if omitted

Global options

See sq(1) for a description of the global options.

EXAMPLES

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

SEE ALSO

sq(1), sq-key(1).

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

VERSION

1.4.1

History

--cert since Debian 13 (Trixie); --cert-email since Debian 13 (Trixie); --cert-file since Debian 13 (Trixie); --cert-userid since Debian 13 (Trixie); --clear-password since Debian 13 (Trixie); --new-password-file since Debian 13 (Trixie).

--binary until Debian 12 (Bookworm); --clear until Debian 12 (Bookworm); --help until Debian 12 (Bookworm); -B until Debian 12 (Bookworm); -h until Debian 12 (Bookworm); -o until Debian 12 (Bookworm).