summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeal H. Walfield <neal@pep.foundation>2022-10-04 08:48:03 +0200
committerNeal H. Walfield <neal@pep.foundation>2022-10-30 07:23:04 +0100
commit8826fe15d4885f495c038e6b9c0ca7666b63025e (patch)
treef186c1b7d25669a4b364d09a389bb458e380d101
parentdb90178d5b61e3310f979fdaefc66610adf0d33e (diff)
sq: The argument to --signer-cert, etc. is a cert file, not a cert
- The argument to --signer-cert, --recipient-cert, and --certificate is a certificate *file*, not a certificate. Update the description and the documentation to reflect this.
-rw-r--r--sq/sq-usage.md18
-rw-r--r--sq/src/sq_cli/decrypt.rs4
-rw-r--r--sq/src/sq_cli/encrypt.rs4
-rw-r--r--sq/src/sq_cli/revoke.rs4
-rw-r--r--sq/src/sq_cli/verify.rs4
5 files changed, 17 insertions, 17 deletions
diff --git a/sq/sq-usage.md b/sq/sq-usage.md
index 9b83cf5a..87ecf0f4 100644
--- a/sq/sq-usage.md
+++ b/sq/sq-usage.md
@@ -134,8 +134,8 @@ OPTIONS:
--private-key-store <KEY_STORE>
Provides parameters for private key store
- --recipient-cert <CERT-RING>
- Encrypts for all recipients in CERT-RING
+ --recipient-cert <CERT_RING_FILE>
+ Encrypts to all certificates in CERT_RING_FILE
-s, --symmetric
Adds a password to encrypt with. The message can be decrypted with
@@ -221,8 +221,8 @@ OPTIONS:
--session-key <SESSION-KEY>
Decrypts an encrypted message using SESSION-KEY
- --signer-cert <CERT>
- Verifies signatures with CERT
+ --signer-cert <CERT_FILE>
+ Verifies signatures using the certificates in CERT_FILE
-x, --hex
Prints a hexdump (implies --dump)
@@ -355,8 +355,8 @@ OPTIONS:
-o, --output <FILE>
Writes to FILE or stdout if omitted
- --signer-cert <CERT>
- Verifies signatures with CERT
+ --signer-cert <CERT_FILE>
+ Verifies signatures using the certificate in CERT_FILE
EXAMPLES:
@@ -2168,9 +2168,9 @@ OPTIONS:
-B, --binary
Emits binary data
- --certificate <FILE>
- Reads the certificate to revoke from FILE or stdin, if omitted. It
- is an error for the file to contain more than one certificate.
+ --certificate <CERT_FILE>
+ Reads the certificate to revoke from CERT_FILE or stdin, if omitted.
+ It is an error for the file to contain more than one certificate.
-h, --help
Print help information
diff --git a/sq/src/sq_cli/decrypt.rs b/sq/src/sq_cli/decrypt.rs
index 30d5b697..d185193a 100644
--- a/sq/src/sq_cli/decrypt.rs
+++ b/sq/src/sq_cli/decrypt.rs
@@ -59,8 +59,8 @@ pub struct Command {
pub signatures: Option<usize>,
#[clap(
long = "signer-cert",
- value_name = "CERT",
- help = "Verifies signatures with CERT",
+ value_name = "CERT_FILE",
+ help = "Verifies signatures using the certificates in CERT_FILE",
)]
pub sender_cert_file: Vec<String>,
#[clap(
diff --git a/sq/src/sq_cli/encrypt.rs b/sq/src/sq_cli/encrypt.rs
index 867d90ac..4fc0e839 100644
--- a/sq/src/sq_cli/encrypt.rs
+++ b/sq/src/sq_cli/encrypt.rs
@@ -38,9 +38,9 @@ pub struct Command {
pub binary: bool,
#[clap(
long = "recipient-cert",
- value_name = "CERT-RING",
+ value_name = "CERT_RING_FILE",
multiple_occurrences = true,
- help = "Encrypts for all recipients in CERT-RING",
+ help = "Encrypts to all certificates in CERT_RING_FILE",
)]
pub recipients_cert_file: Vec<String>,
#[clap(
diff --git a/sq/src/sq_cli/revoke.rs b/sq/src/sq_cli/revoke.rs
index 2e1a6528..558d5bfe 100644
--- a/sq/src/sq_cli/revoke.rs
+++ b/sq/src/sq_cli/revoke.rs
@@ -358,12 +358,12 @@ include a certification-capable key.",
)]
pub struct UseridCommand {
#[clap(
- value_name = "FILE",
+ value_name = "CERT_FILE",
long = "certificate",
alias = "cert",
help = "The certificate containing the User ID to revoke",
long_help =
-"Reads the certificate to revoke from FILE or stdin, \
+"Reads the certificate to revoke from CERT_FILE or stdin, \
if omitted. It is an error for the file to contain more than one \
certificate."
)]
diff --git a/sq/src/sq_cli/verify.rs b/sq/src/sq_cli/verify.rs
index 7c96875e..e7ef8606 100644
--- a/sq/src/sq_cli/verify.rs
+++ b/sq/src/sq_cli/verify.rs
@@ -59,8 +59,8 @@ pub struct Command {
pub signatures: usize,
#[clap(
long = "signer-cert",
- value_name = "CERT",
- help = "Verifies signatures with CERT",
+ value_name = "CERT_FILE",
+ help = "Verifies signatures using the certificate in CERT_FILE",
)]
// TODO: Should at least one sender_cert_file be required? Verification does not make sense
// without one, does it?