sequoia-sq 1.4.0

Command-line frontends for Sequoia
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use clap::ArgGroup;
use clap::Parser;

use crate::cli::types::*;
use crate::cli::types::cert_designator::CertUserIDEmailDomainGrepArgs;
use crate::cli::types::cert_designator::CertPrefix;
use crate::cli::types::cert_designator::OptionalValue;
use crate::cli::examples::*;

const EXAMPLES: Actions = Actions {
    actions: &[
        Action::setup().command(&[
            "sq", "pki", "link", "add",
            "--cert=EB28F26E2739A4870ECC47726F0073F60FD0CBF0",
            "--userid=Alice <alice@example.org>",
        ]).build(),

        Action::setup().command(&[
            "sq", "pki", "link", "add",
            "--cert=511257EBBF077B7AEDAE5D093F68CB84CE537C9A",
            "--userid=Bob <bob@example.org>",
        ]).build(),

        Action::example().comment(
            "Export certificates with a User ID containing the \
             email address."
        ).command(&[
            "sq", "cert", "export", "--cert-email=alice@example.org",
        ]).build(),

        Action::example().comment(
            "Export certificates that contain a User ID with *either* \
             (not both!) email address."
        ).command(&[
            "sq", "cert", "export",
            "--cert-email=alice@example.org",
            "--cert-email=bob@example.org",
        ]).build(),

        Action::example().comment(
            "Export all certificates."
        ).command(&[
            "sq", "cert", "export", "--all",
        ]).build(),
    ],
};

test_examples!(sq_cert_export, EXAMPLES);


#[derive(Parser, Debug)]
#[clap(
    name = "export",
    about = "Export certificates from the local certificate store",
    long_about =
"Export certificates from the local certificate store

If multiple predicates are specified a certificate is returned if \
at least one of them matches.

This does not check the authenticity of the certificates in anyway. \
Before using the certificates, be sure to validate and authenticate \
them.

When matching on subkeys or User IDs, the component must have a valid \
self signature according to the policy.

Fails if search criteria are specified and none of them matches any \
certificates.  Note: this means if the certificate store is empty and \
no search criteria are specified, then this will return success.
",
    after_help = EXAMPLES,
)]
#[clap(group(ArgGroup::new("some-designator")
             .args(&["cert", "cert-userid", "cert-email", "cert-domain", "cert-grep", "all"])
             .required(true)
             .multiple(true)))]
pub struct Command {
    #[clap(
        default_value_t = FileOrStdout::default(),
        help = FileOrStdout::HELP_OPTIONAL,
        long,
        value_name = FileOrStdout::VALUE_NAME,
    )]
    pub output: FileOrStdout,

    #[clap(
        long = "local",
        help = "Export local (non-exportable) signatures",
        long_help = "\
Export local (non-exportable) signatures

By default, non-exportable signatures are not emitted when exporting \
certificates, certificate components that are only bound by \
non-exportable signatures are not emitted, and certificates consisting \
of only non-exportable components are not emitted.

This flag enables exporting of non-exportable signatures, components, \
and certs.  This is useful for synchronization between ones devices, \
for example.",
    )]
    pub local: bool,

    #[clap(
        long,
        conflicts_with_all = [
            "cert", "cert-userid", "cert-email", "cert-domain", "cert-grep",
        ],
        help = "Export all certificates",
    )]
    pub all: bool,

    #[command(flatten)]
    pub certs: CertDesignators<CertUserIDEmailDomainGrepArgs,
                               CertPrefix,
                               OptionalValue>,
}