.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.1.
.TH SEQUOIA-KEYRING-LINTER "1" "February 2023" "sequoia-keyring-linter 1.0.0" "User Commands"
.SH NAME
sequoia-keyring-linter \- sq-keyring-linter
.SH SYNOPSIS
.B sq-keyring-linter
[\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]...
.SH DESCRIPTION
A linter for keyrings
.SS "Arguments:"
.IP
[FILE]...
.TP
A list of OpenPGP keyrings to process.
If none are specified,
.IP
a keyring is read from stdin.
.SH OPTIONS
.HP
\fB\-t\fR, \fB\-\-time\fR <TIME>
.IP
Sets the reference time to TIME.
.TP
TIME is interpreted as an ISO 8601 timestamp.
To set the reference time to July 21, 2013
.IP
at midnight UTC, you can do:
.IP
\f(CW$ sq-keyring-linter --time 20130721 ...\fR
.IP
To include a time, add a T, the time and optionally the timezone (the default timezone is
UTC):
.IP
\f(CW$ sq-keyring-linter --time 20130721T0550+0200 ...\fR
.HP
\fB\-q\fR, \fB\-\-quiet\fR
.IP
Quiet; does not output any diagnostics
.HP
\fB\-f\fR, \fB\-\-fix\fR
.IP
Attempts to fix certificates, when possible
.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\-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.
.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\-h\fR, \fB\-\-help\fR
.IP
Print help information (use `\-h` for a summary)
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Print version information
.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 ("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 \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 something; done
.PP
SEE ALSO:
.PP
sq\-keyring\-linter's homepage: <https://gitlab.com/sequoia\-pgp/keyring\-linter>