sq-pki-link-add - Man Page

Link a certificate and a User ID

Synopsis

sq pki link add [Options] FINGERPRINT|KEYID USERID|EMAIL

Description

Link a certificate and a User ID.

This cause `sq` to considers the certificate and User ID binding to be authentic.

A certificate can also be accepted as a certification authority, which is also known as a trusted introducer, by using the `--ca` or `--depth` option.

A link can be retracted using `sq pki link retract`.

This command is similar to `sq pki certify`, but the certifications it makes are done using the certificate directory's trust root, not an arbitrary key.  Further, the certificates are marked as non-exportable.  The former makes it easier to manage certifications, especially when the user's certification key is offline.  And the latter improves the user's privacy, by reducing the chance that parts of the user's social graph is leaked when a certificate is shared.

By default a link never expires. Using the `--expiry` argument specific validity periods may be defined. It allows for providing a point in time for validity to end or a validity duration.

`sq pki link` respects the reference time set by the top-level `--time` argument. It sets the link's creation time to the reference time.

Options

Subcommand options

-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.

--all

Links all valid self-signed User ID to the certificate.

--ca=*|DOMAIN

Marks the certificate as a certification authority for a  domain.  Use `*` to make the certificate a certification
            authority for any User ID.

            A certification authority is also referred to as a trusted introducer.  This command is equivalent to making the trust depth unconstrained, i.e., setting the depth to 255.  See `--depth` for more information.

-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=EMAIL

An email address to link to the certificate.  The email address must match the email address of a self-signed User ID.  To link an email address to the certificate that does not appear in a self-signed User ID, use `--petname`.  If the specified email appears in multiple self-signed User IDs, then all of them are linked.

--expiry=EXPIRY

Defines EXPIRY for the acceptance 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.

--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.

--petname=PETNAME

A User ID to link to the certificate.  Unlike `--userid`, this does not need to match a self-signed User ID.  Bare email address are automatically wrapped in angle brackets. That is if `alice@example.org` is provided, it is silently converted to `<alice@example.org>`.

-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.

--temporary

Temporarily accepts the binding.  Creates a fully
           trust link between a certificate and one or more
           User IDs for a week.  After that, the link is
           automatically downgraded to a partially trusted link
           (trust = 40).

--userid=USERID

A User ID to link to the certificate.  This must match a self-signed User ID.  To link a User ID to the certificate that does not have a self-signature, use `--petname`.

FINGERPRINT|KEYID

The certificate to accept.

USERID|EMAIL

A User ID or email address to link to the certificate.  This must match a self-signed User ID.  To link a User ID to the certificate that does not have a self-signature, use `--petname`.  Scripts should prefer to use `--email` or `--userid`, as `sq` does not need to guess if a value is a User ID or an email address.

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.

Examples

The user links 0123456789ABCDEF and the User ID '<romeo@example.org>'.

    sq pki link add 0123456789ABCDEF '<romeo@example.org>'

The user examines 0123456789ABCDEF and then accepts the certificate 0123456789ABCDEF with its current set of self-signed User IDs.

    sq cert export --cert 0123456789ABCDEF | sq inspect

...

    sq pki link add 0123456789ABCDEF --all

The user links the certificate and its current self-signed User IDs for a week.

    sq pki link add --expires-in 1w 0123456789ABCDEF --all

The user accepts the certificate, and its current self-signed User IDs as a certification authority.  That is, the certificate is considered a trust root.

    sq pki link add --ca '*' 0123456789ABCDEF --all

The user accepts the certificate and its current self-signed User IDs as a partially trusted certification authority.

    sq pki link add --ca '*' --amount 60 0123456789ABCDEF --all

The user retracts their acceptance of 0123456789ABCDEF and any associated User IDs.  This effectively invalidates any links.

    sq pki link retract 0123456789ABCDEF

See Also

sq(1), sq-pki(1), sq-pki-link(1).

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

Version

0.33.0 (sequoia-openpgp 1.17.0)

Referenced By

sq-pki-link(1).

0.33.0 Sequoia-PGP