Subcommand options¶

-B, --binary

Emits binary data

-a, --amount=AMOUNT

Sets the amount of trust. Values between 1 and 120 are meaningful. 120 means fully trusted. Values less than 120 indicate the degree of trust. 60 is usually used for partially trusted.

--add-userid

Add the given user ID if it doesn't exist in the certificate.

--allow-not-alive-certifier

Allows the key to make a certification even if the current time is prior to its creation time or the current time is at or after its expiration time.

--allow-revoked-certifier

Don't fail if the certificate making the certification is revoked.

-d, --depth=TRUST_DEPTH

Sets the trust depth (sometimes referred to as the trust level). 0 means a normal certification of <CERTIFICATE, USERID>. 1 means CERTIFICATE is also a trusted introducer, 2 means CERTIFICATE is a meta-trusted introducer, etc.

--email

Treat the given user ID as an email address. If more than one user ID contain the given email address, all are certified.

--expiry=EXPIRY

Defines EXPIRY for the certification as ISO 8601 formatted string or custom duration. If an ISO 8601 formatted string is provided, the validity period reaches from the reference time (may be set using `--time`) to the provided time. Custom durations starting from the reference time may be set using `N[ymwds]`, for N years, months, weeks, days, or seconds. The special keyword `never` sets an unlimited expiry.

-l, --local

Makes the certification a local certification. Normally, local certifications are not exported.

--non-revocable

Marks the certification as being non-revocable. That is, you cannot later revoke this certification. This should normally only be used with an expiration.

--notation NAME VALUE

Adds a notation to the certification. A user-defined notation's name must be of the form `name@a.domain.you.control.org`. If the notation's name starts with a !, then the notation is marked as being critical. If a consumer of a signature doesn't understand a critical notation, then it will ignore the signature. The notation is marked as being human readable.

-o, --output=FILE

Writes to FILE or stdout if omitted

--private-key-store=KEY_STORE

Provides parameters for private key store

-r, --regex=REGEX

Adds a regular expression to constrain what a trusted introducer can certify. The regular expression must match the certified User ID in all intermediate introducers, and the certified certificate. Multiple regular expressions may be specified. In that case, at least one must match.

CERTIFIER-KEY

Creates the certification using CERTIFIER-KEY.

KEY_ID|FINGERPRINT|FILE

Certifies CERTIFICATE.

USERID

Certifies USERID for CERTIFICATE.

Global options¶

--cert-store=PATH

Specifies the location of the certificate store. By default, sq uses the OpenPGP certificate directory at `$HOME/.local/share/pgp.cert.d`, and creates it if it does not exist.

-f, --force

Overwrites existing files

-h, --help

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

--keyring=PATH

Specifies the location of a keyring to use. Keyrings are used in addition to any certificate store. The content of the keyring is not imported into the certificate store. When a certificate is looked up, it is looked up in all keyrings and any certificate store, and the results are merged together.

--known-notation=NOTATION

Adds NOTATION to the list of known notations. This is used when validating signatures. Signatures that have unknown notations with the critical bit set are considered invalid.

--no-cert-store

Disables the use of a certificate store. Normally sq uses the user's standard cert-d, which is located in `$HOME/.local/share/pgp.cert.d`.

--output-format=FORMAT

Produces output in FORMAT, if possible

--output-version=VERSION

Produces output variant VERSION, such as 0.0.0. The default is the newest version. The output version is separate from the version of the sq program. To see the current supported versions, use output-versions subcommand.

--pep-cert-store=PATH

Specifies the location of a pEp certificate store. sq does not use a pEp certificate store by default; it must be explicitly enabled using this argument or the corresponding environment variable, PEP_CERT_STORE. The pEp Engine's default certificate store is at `$HOME/.pEp/keys.db`.

--time=TIME

Sets the reference time as an ISO 8601 formatted timestamp. Normally, commands use the current time as the reference time. This argument allows the user to use a difference reference time. For instance, when creating a key using `sq key generate`, the creation time is normally set to the current time, but can be overridden using this option. Similarly, when verifying a message, the message is verified with respect to the current time. This option allows the user to use a different time.

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

$ sq --time 20130721 verify msg.pgp

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

$ sq --time 20130721T0550+0200 verify msg.pgp

--trust-root=FINGERPRINT|KEYID

Considers the specified certificate to be a trust root. Trust roots are used by trust models, e.g., the Web of Trust, to authenticate certificates and User IDs.

-v, --verbose

Be more verbose.