diff options
author | Justus Winter <justus@sequoia-pgp.org> | 2021-01-28 18:44:39 +0100 |
---|---|---|
committer | Justus Winter <justus@sequoia-pgp.org> | 2021-01-28 18:44:39 +0100 |
commit | c1da612d8dd4b15e11ea0d2d0968c3f52ca98650 (patch) | |
tree | 42188ddcb32c69ace80c22f22d8e9e7e53ea5657 /sq/man-sq-net-autocrypt | |
parent | eab0f433a0847918ac9d9549cdde3a010e35ceac (diff) |
sq: Release 0.24.0.sq/v0.24.0
Diffstat (limited to 'sq/man-sq-net-autocrypt')
35 files changed, 2311 insertions, 0 deletions
diff --git a/sq/man-sq-net-autocrypt/sq-armor.1 b/sq/man-sq-net-autocrypt/sq-armor.1 new file mode 100644 index 00000000..85283687 --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-armor.1 @@ -0,0 +1,56 @@ +.TH SQ-ARMOR "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-armor \- Converts binary to ASCII + +To make encrypted data easier to handle and transport, OpenPGP data +can be transformed to an ASCII representation called ASCII Armor. sq +emits armored data by default, but this subcommand can be used to +convert existing OpenPGP data to its ASCII\-encoded representation. + +The converse operation is "sq dearmor". + +.SH SYNOPSIS +\fBsq armor\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted + +.TP +\fB\-\-label\fR LABEL +Selects the kind of armor header [default: auto] [possible values: auto, message, cert, key, sig, file] +.SH ARGS +.TP +FILE +Reads from FILE or stdin if omitted +.SH EXAMPLES +.TP +# Convert a binary certificate to ASCII +\fB $ sq armor binary\-juliet.pgp\fR +.TP +# Convert a binary message to ASCII +\fB $ sq armor binary\-message.pgp\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-autocrypt-decode.1 b/sq/man-sq-net-autocrypt/sq-autocrypt-decode.1 new file mode 100644 index 00000000..e9b7f22a --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-autocrypt-decode.1 @@ -0,0 +1,51 @@ +.TH SQ-AUTOCRYPT-DECODE "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-autocrypt\-decode \- Reads Autocrypt\-encoded certificates + +Given an autocrypt header (or an key\-gossip header), this command +extracts the certificate encoded within it. + +The converse operation is "sq autocrypt encode\-sender". + +.SH SYNOPSIS +\fBsq autocrypt decode\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information + +.TP +\fB\-B\fR, \fB\-\-binary\fR +Emits binary data +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted +.SH ARGS +.TP +FILE +Reads from FILE or stdin if omitted +.SH EXAMPLES +.TP +# Extract all certificates from a mail +\fB $ sq autocrypt decode autocrypt.eml\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-autocrypt\-decode(1), sq\-autocrypt\-encode\-sender(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-autocrypt-encode-sender.1 b/sq/man-sq-net-autocrypt/sq-autocrypt-encode-sender.1 new file mode 100644 index 00000000..6d12946c --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-autocrypt-encode-sender.1 @@ -0,0 +1,64 @@ +.TH SQ-AUTOCRYPT-ENCODE-SENDER "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-autocrypt\-encode\-sender \- Encodes a certificate into an Autocrypt header + +A certificate can be encoded and included in a header of an email +message. This command encodes the certificate, adds the senders email +address (which must match the one used in the "From" header), and the +senders "prefer\-encrypt" state (see the Autocrypt spec for more +information). + +The converse operation is "sq autocrypt decode". + +.SH SYNOPSIS +\fBsq autocrypt encode\-sender\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted + +.TP +\fB\-\-email\fR ADDRESS +Sets the address [default: primary userid] + +.TP +\fB\-\-prefer\-encrypt\fR prefer\-encrypt +Sets the prefer\-encrypt attribute [default: nopreference] [possible values: nopreference, mutual] +.SH ARGS +.TP +FILE +Reads from FILE or stdin if omitted +.SH EXAMPLES +.TP +# Encodes a certificate +\fB $ sq autocrypt encode\-sender juliet.pgp\fR +.TP +# Encodes a certificate with an explicit sender address +\fB $ sq autocrypt encode\-sender \-\-email juliet@example.org juliet.pgp\fR +.TP +# Encodes a certificate while indicating the willingness to encrypt +\fB $ sq autocrypt encode\-sender \-\-prefer\-encrypt mutual juliet.pgp\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-autocrypt\-decode(1), sq\-autocrypt\-encode\-sender(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-autocrypt.1 b/sq/man-sq-net-autocrypt/sq-autocrypt.1 new file mode 100644 index 00000000..da09c4ae --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-autocrypt.1 @@ -0,0 +1,61 @@ +.TH SQ-AUTOCRYPT "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-autocrypt \- Communicates certificates using Autocrypt + +Autocrypt is a standard for mail user agents to provide convenient +end\-to\-end encryption of emails. This subcommand provides a limited +way to produce and consume headers that are used by Autocrypt to +communicate certificates between clients. + +See https://autocrypt.org/ + +.SH SYNOPSIS +\fBsq autocrypt\fR [FLAGS] <SUBCOMMAND> +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information +.SH SUBCOMMANDS +.TP +\fBhelp\fR +Prints this message or the help of the given subcommand(s) + +.TP +\fBdecode\fR +Reads Autocrypt\-encoded certificates + +Given an autocrypt header (or an key\-gossip header), this command +extracts the certificate encoded within it. + +The converse operation is "sq autocrypt encode\-sender". + +.TP +\fBencode\-sender\fR +Encodes a certificate into an Autocrypt header + +A certificate can be encoded and included in a header of an email +message. This command encodes the certificate, adds the senders email +address (which must match the one used in the "From" header), and the +senders "prefer\-encrypt" state (see the Autocrypt spec for more +information). + +The converse operation is "sq autocrypt decode". +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-autocrypt\-decode(1), sq\-autocrypt\-encode\-sender(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-certify.1 b/sq/man-sq-net-autocrypt/sq-certify.1 new file mode 100644 index 00000000..02d83336 --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-certify.1 @@ -0,0 +1,98 @@ +.TH SQ-CERTIFY "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-certify \- +Certifies a User ID for a Certificate + +Using a certification a keyholder may vouch for the fact that another +certificate legitimately belongs to a user id. In the context of +emails this means that the same entity controls the key and the email +address. These kind of certifications form the basis for the Web Of +Trust. + +This command emits the certificate with the new certification. The +updated certificate has to be distributed, preferably by sending it to +the certificate holder for attestation. See also "sq key +attest\-certification". + +.SH SYNOPSIS +\fBsq certify\fR [FLAGS] [OPTIONS] <CERTIFIER\-KEY> <CERTIFICATE> <USERID> +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information + +.TP +\fB\-B\fR, \fB\-\-binary\fR +Emits binary data + +.TP +\fB\-l\fR, \fB\-\-local\fR +Makes the certification a local certification. Normally, local certifications are not exported. + +.TP +\fB\-\-non\-revocable\fR +Marks the certification as being non\-revocable. That is, you cannot later revoke this certification. This should normally only be used with an expiration. +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted + +.TP +\fB\-d\fR, \fB\-\-depth\fR 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. The default is 0. + +.TP +\fB\-a\fR, \fB\-\-amount\fR TRUST_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. The default is 120. + +.TP +\fB\-r\fR, \fB\-\-regex\fR 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. + +.TP +\fB\-\-notation\fR NAME +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. + +.TP +\fB\-\-expires\fR TIME +Makes the certification expire at TIME (as ISO 8601). Use "never" to create certifications that do not expire. + +.TP +\fB\-\-expires\-in\fR DURATION +Makes the certification expire after DURATION. Either "N[ymwd]", for N years, months, weeks, or days, or "never". [default: 5y] +.SH ARGS +.TP +CERTIFIER\-KEY +Creates the certificate using CERTIFIER\-KEY. + +.TP +CERTIFICATE +Certifies CERTIFICATE. + +.TP +USERID +Certifies USERID for CERTIFICATE. +.SH EXAMPLES +.TP +# Juliet certifies that Romeo controls romeo.pgp and romeo@example.org +\fB $ sq certify juliet.pgp romeo.pgp "<romeo@example.org>"\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-dearmor.1 b/sq/man-sq-net-autocrypt/sq-dearmor.1 new file mode 100644 index 00000000..db5a0fd4 --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-dearmor.1 @@ -0,0 +1,53 @@ +.TH SQ-DEARMOR "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-dearmor \- Converts ASCII to binary + +To make encrypted data easier to handle and transport, OpenPGP data +can be transformed to an ASCII representation called ASCII Armor. sq +transparently handles armored data, but this subcommand can be used to +explicitly convert existing ASCII\-encoded OpenPGP data to its binary +representation. + +The converse operation is "sq armor". + +.SH SYNOPSIS +\fBsq dearmor\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted +.SH ARGS +.TP +FILE +Reads from FILE or stdin if omitted +.SH EXAMPLES +.TP +# Convert a ASCII certificate to binary +\fB $ sq dearmor ascii\-juliet.pgp\fR +.TP +# Convert a ASCII message to binary +\fB $ sq dearmor ascii\-message.pgp\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-decrypt.1 b/sq/man-sq-net-autocrypt/sq-decrypt.1 new file mode 100644 index 00000000..f9902ba1 --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-decrypt.1 @@ -0,0 +1,77 @@ +.TH SQ-DECRYPT "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-decrypt \- Decrypts a message + +Decrypts a message using either supplied keys, or by prompting for a +password. Any signatures are checked using the supplied certificates. + +The converse operation is "sq encrypt". + +.SH SYNOPSIS +\fBsq decrypt\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information + +.TP +\fB\-\-dump\-session\-key\fR +Prints the session key to stderr + +.TP +\fB\-\-dump\fR +Prints a packet dump to stderr + +.TP +\fB\-x\fR, \fB\-\-hex\fR +Prints a hexdump (implies \-\-dump) +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted + +.TP +\fB\-n\fR, \fB\-\-signatures\fR N +Sets the threshold of valid signatures to N. If this threshold is not reached, the message will not be considered verified. [default: 0] + +.TP +\fB\-\-signer\-cert\fR CERT +Verifies signatures with CERT + +.TP +\fB\-\-recipient\-key\fR KEY +Decrypts with KEY +.SH ARGS +.TP +FILE +Reads from FILE or stdin if omitted +.SH EXAMPLES +.TP +# Decrypt a file using a secret key +\fB $ sq decrypt \-\-recipient\-key juliet.pgp ciphertext.pgp\fR +.TP +# Decrypt a file verifying signatures +\fB $ sq decrypt \-\-recipient\-key juliet.pgp \-\-signer\-cert romeo.pgp ciphertext.pgp\fR +.TP +# Decrypt a file using a password +\fB $ sq decrypt ciphertext.pgp\fR + +.SH SEE ALSO +For the full documentation see <https://docs.sequoia\-pgp.org/sq/>. + +.ad l +.nh +sq(1), sq\-armor(1), sq\-autocrypt(1), sq\-certify(1), sq\-dearmor(1), sq\-decrypt(1), sq\-encrypt(1), sq\-inspect(1), sq\-key(1), sq\-keyring(1), sq\-keyserver(1), sq\-packet(1), sq\-sign(1), sq\-verify(1), sq\-wkd(1) + + +.SH AUTHORS +.P +.RS 2 +.nf +Azul <azul@sequoia\-pgp.org> +Igor Matuszewski <igor@sequoia\-pgp.org> +Justus Winter <justus@sequoia\-pgp.org> +Kai Michaelis <kai@sequoia\-pgp.org> +Neal H. Walfield <neal@sequoia\-pgp.org> +Nora Widdecke <nora@sequoia\-pgp.org> +Wiktor Kwapisiewicz <wiktor@sequoia\-pgp.org> diff --git a/sq/man-sq-net-autocrypt/sq-encrypt.1 b/sq/man-sq-net-autocrypt/sq-encrypt.1 new file mode 100644 index 00000000..f08c271d --- /dev/null +++ b/sq/man-sq-net-autocrypt/sq-encrypt.1 @@ -0,0 +1,85 @@ +.TH SQ-ENCRYPT "1" "JANUARY 2021" "0.24.0 (SEQUOIA-OPENPGP 1.0.0)" "USER COMMANDS" 5 +.SH NAME +sq\-encrypt \- Encrypts a message + +Encrypts a message for any number of recipients and with any number of +passwords, optionally signing the message in the process. + +The converse operation is "sq decrypt". + +.SH SYNOPSIS +\fBsq encrypt\fR [FLAGS] [OPTIONS] [\-\-] [FILE] +.SH FLAGS +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints help information + +.TP +\fB\-B\fR, \fB\-\-binary\fR +Emits binary data + +.TP +\fB\-s\fR, \fB\-\-symmetric\fR +Adds a password to encrypt with. The message can be decrypted with either one of the recipient's keys, or any password. + +.TP +\fB\-\-use\-expired\-subkey\fR +If a certificate has only expired encryption\-capable subkeys, falls back to using the one that expired last +.SH OPTIONS +.TP +\fB\-o\fR, \fB\-\-output\fR FILE +Writes to FILE or stdout if omitted + +.TP +\fB\-\-recipient\-cert\fR CERT\-RING +Encrypts for all recipients in CERT\-RING + +.TP +\fB\-\-signer\-key\fR KEY +Signs the message with KEY + +.TP +\fB\-\-mode\fR MODE +Selects what kind of keys are considered for encryption. Transport select subkeys marked as suitable for transport encryption, rest selects those for encrypting data at rest, and all selects all encryption\-capable subkeys. [default: all] [possible |