sq-keyring-linter - Man Page

A linter for keyrings


sequoia-keyring-linter [-t|--time] [-q|--quiet] [-f|--fix] [-e|--export-secret-keys] [-p|--password] [-k|--list-keys] [-h|--help] [-V|--version] [FILE]


A linter for keyrings


-t,  --time=TIME

Sets the reference time to TIME.

TIME is interpreted as an ISO 8601 timestamp.  To set the reference time to July 21, 2013 at midnight UTC, you can do:

$ sq-keyring-linter --time 20130721 ...

To include a time, add a T, the time and optionally the timezone (the default timezone is UTC):

$ sq-keyring-linter --time 20130721T0550+0200 ...

-q,  --quiet

Quiet; does not output any diagnostics

-f,  --fix

Attempts to fix certificates, when possible

-e,  --export-secret-keys

When fixing a certificate, the fixed certificate is exported without any secret key material.  Using this switch causes any secret key material to also be exported.

-p,  --password=PASSWORD

A key's password.  Normally this is not needed: if stdin is connected to a tty, the linter will ask for a password when needed.

-k,  --list-keys

If set, outputs a list of fingerprints, one per line, of certificates that have issues.  This output is intended for use by scripts.

This option implies "--quiet". If you also specify "--fix", errors will still be printed to stderr, and fixed certificates will still be emitted to stdout.

-h,  --help

Print help (see a summary with '-h')

-V,  --version

Print version


A list of OpenPGP keyrings to process.  If none are specified, a keyring is read from stdin.


`sq-keyring-linter` checks the supplied certificates for the following SHA-1-related issues:

 - Whether a certificate revocation uses SHA-1.

 - Whether the current self signature for a non-revoked User ID uses

 - Whether the current subkey binding signature for a non-revoked,
   live subkey uses SHA-1.

 - Whether a primary key binding signature ("backsig") for a
   non-revoked, live subkey uses SHA-1.

Diagnostics are printed to stderr.  At the end, some statistics are shown.  This is useful when examining a keyring.  If `--fix` is specified and at least one issue could be fixed, the fixed certificates are printed to stdout.

This tool does not currently support smart cards.  But, if only the subkeys are on a smart card, this tool may still be able to partially repair the certificate.  In particular, it will be able to fix any issues with User ID self signatures and subkey binding signatures for encryption-capable subkeys, but it will not be able to generate new primary key binding signatures for any signing-capable subkeys.


If `--fix` is not specified:
 2  if any issues were found,
 1  if not issues were found, but there were errors reading the input,
 0  if there were no issues.

If `--fix` is specified:
 3  if any issues could not be fixed,
 1  if not issues were found, but there were errors reading the input,
 0  if all issues were fixed or there were no issues.


 # To gather statistics, simply run:
 $ sq-keyring-linter keyring.pgp

 # To fix a key:
 $ gpg --export-secret-keys FPR | sq-keyring-linter --fix -p passw0rd -p password123 | gpg --import

 # To get a list of keys with issues:
 $ sq-keyring-linter --list-keys keyring.pgp | while read FPR; do something; done


sq-keyring-linter's homepage: <https://gitlab.com/sequoia-pgp/keyring-linter>




Neal Walfield <neal@sequoia-pgp.org>


sequoia-keyring-linter 1.0.1