.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH SQ-KEYRING-LINTER "1" "October 2022" "sq-keyring-linter 0.5.0" "User Commands"
.SH NAME
sq-keyring-linter \- sq-keyring-linter
.SH DESCRIPTION
sq\-keyring\-linter 0.5.0
.PP
"sq\-keyring\-linter" checks for and optionally repairs OpenPGP
certificates that use SHA\-1.
.SS "USAGE:"
.IP
sq\-keyring\-linter [FLAGS] [OPTIONS] [\-\-] [FILES]...
.SS "FLAGS:"
.HP
\fB\-e\fR, \fB\-\-export\-secret\-keys\fR
.IP
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.
.HP
\fB\-f\fR, \fB\-\-fix\fR
.IP
Attempts to fix certificates, when possible
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Prints help information
.HP
\fB\-k\fR, \fB\-\-list\-keys\fR
.IP
If set, outputs a list of fingerprints, one per line, of
certificates that have issues.  This output is intended for
use by scripts.
.IP
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.
.HP
\fB\-q\fR, \fB\-\-quiet\fR
.IP
Quiet; does not output any diagnostics
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Prints version information
.SS "OPTIONS:"
.HP
\fB\-p\fR, \fB\-\-password\fR <password>...
.TP
A key's password.
Normally this is not needed: if stdin is
.IP
connected to a tty, the linter will ask for a password when
needed.
.SS "ARGS:"
.IP
<FILES>...
.TP
A list of OpenPGP keyrings to process.
If none are
.IP
specified,
a keyring is read from stdin.
.PP
"sq\-keyring\-linter" checks the supplied certificates for the following
SHA\-1\-related issues:
.IP
\- Whether a certificate revocation uses SHA\-1.
.IP
\- Whether the current self signature for a non\-revoked User ID uses
.IP
SHA\-1.
.IP
\- Whether the current subkey binding signature for a non\-revoked,
.IP
live subkey uses SHA\-1.
.IP
\- Whether a primary key binding signature (a "backsig") for a
.IP
non\-revoked, live subkey uses SHA\-1.
.PP
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.
.PP
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.
.PP
EXIT STATUS:
.SS "If "--fix" is not specified:"
.TP
2
if any issues were found,
.TP
1
if not issues were found, but there were errors reading the input,
.TP
0
if there were no issues.
.SS "If "--fix" is specified:"
.TP
3
if any issues could not be fixed,
.TP
1
if not issues were found, but there were errors reading the input,
.TP
0
if all issues were fixed or there were no issues.
.PP
EXAMPLES:
.IP
# To gather statistics, simply run:
$ sq\-keyring\-linter keyring.pgp
.IP
# To fix a key:
$ gpg \fB\-\-export\-secret\-keys\fR FPR | sq\-keyring\-linter \fB\-\-fix\fR \fB\-p\fR passw0rd
.PP
\fB\-p\fR password123 | gpg \fB\-\-import\fR
.IP
# To get a list of keys with issues:
$ sq\-keyring\-linter \fB\-\-list\-keys\fR keyring.pgp | while read FPR; do
.PP
something; done
.PP
SEE ALSO:
.PP
sq\-keyring\-linter's homepage: <https://gitlab.com/sequoia\-pgp/keyringlinter>