sequoia-sq 1.4.0

use clap::{Args, Parser, Subcommand};

use crate::cli::config;
use crate::cli::examples::*;
use crate::cli::types::ClapData;
use crate::cli::types::FileOrCertStore;
use crate::cli::types::FileOrStdout;
use crate::cli::types::cert_designator::*;

/// The default key servers to query.
pub const DEFAULT_KEYSERVERS: &[&'static str] = &[
    "hkps://keys.openpgp.org",
    "hkps://mail-api.proton.me",
    "hkps://keys.mailvelope.com",
    "hkps://keyserver.ubuntu.com",
    "hkps://sks.pod01.fleetstreetops.com",
];

#[derive(Parser, Debug)]
#[clap(
    name = "keyserver",
    about = "Retrieve and publishes certificates via key servers",
    long_about =
"Retrieve and publishes certificates via key servers

The OpenPGP HTTP Keyserver Protocol (HKP) is a method for publishing \
and retrieving certificates from key servers.
",
    subcommand_required = true,
    arg_required_else_help = true,
    disable_help_subcommand = true,
)]
pub struct Command {
    #[clap(
        long = "server",
        default_values_t = DEFAULT_KEYSERVERS.iter().map(ToString::to_string),
        global = true,
        // All global options should have a high display_order, so
        // that they are sorted to the bottom.
        display_order = 800,
        value_name = "URI",
        help = "Set a key server to use (can be given multiple times)",
        long_help = config::augment_help(
            "network.keyserver.servers",
            "Set a key server to use (can be given multiple times)"),
    )]
    pub servers: Vec<String>,

    #[clap(subcommand)]
    pub subcommand: Subcommands,
}

#[derive(Debug, Subcommand)]
pub enum Subcommands {
    Search(SearchCommand),
    Publish(PublishCommand),
}

#[derive(Debug, Args)]
#[clap(
    about = "Retrieve certificates from key servers",
    long_about =
"Retrieve certificates from key servers

By default, any returned certificates are stored in the local \
certificate store.  This can be overridden by using `--output` \
option.

When a certificate is retrieved from a verifying key server (currently, \
this is limited to a list of known servers: `hkps://keys.openpgp.org`, \
`hkps://keys.mailvelope.com`, and `hkps://mail-api.proton.me`), and \
imported into the local certificate store, the User IDs are also \
certificated with a local server-specific key.  That proxy certificate \
is in turn certified as a minimally trusted CA (trust amount: 1 of \
120) by the local trust root.  How much a proxy key server CA is \
trusted can be tuned using `sq pki link add` or `sq pki link retract` in \
the usual way.
",
    after_help = SEARCH_EXAMPLES,
)]
pub struct SearchCommand {
    #[clap(
        help = FileOrCertStore::HELP_OPTIONAL,
        long,
        value_name = FileOrCertStore::VALUE_NAME,
    )]
    pub output: Option<FileOrStdout>,

    #[clap(
        long,
        conflicts_with = "query",
        help = "Fetch updates for all known certificates",
    )]
    pub all: bool,

    #[clap(
        value_name = "QUERY",
        required = true,
        help = "Retrieve certificate(s) using QUERY",
        long_help = "Retrieve certificate(s) using QUERY

This may be a fingerprint, a KeyID, \
or an email address.",
    )]
    pub query: Vec<String>,
}

const SEARCH_EXAMPLES: Actions = Actions {
    actions: &[
        Action::example().comment(
            "Retrieve Alice's certificate from the default keyservers."
        ).command(&[
            "sq", "network", "keyserver", "search", "alice@example.org",
        ]).syntax_check(),

        Action::example().comment(
            "Retrieve Alice's certificate addressed by fingerprint \
             from the default keyservers."
        ).command(&[
            "sq", "network", "keyserver", "search",
            "EB28F26E2739A4870ECC47726F0073F60FD0CBF0",
        ]).syntax_check(),

        Action::example().comment(
            "Retrieve Alice's certificate from a non-default keyserver."
        ).command(&[
            "sq", "network", "keyserver", "search",
            "--server=hkps://keys.example.org",
            "alice@example.org",
        ]).syntax_check(),

        Action::example().comment(
            "Retrieve updates for all known certificates from the default \
             keyservers."
        ).command(&[
            "sq", "network", "keyserver", "search", "--all",
        ]).syntax_check(),
    ],
};
test_examples!(sq_network_keyserver_search, SEARCH_EXAMPLES);

#[derive(Debug, Args)]
#[clap(
    about = "Publish certificates on key servers",
    long_about = format!(
"Publish certificates on key servers

Sends certificates to the configured key servers for publication.  By \
default, the certificates are sent to {}.  This can be tweaked using \
`--servers`.
",
        join(DEFAULT_KEYSERVERS.iter().cloned())),
    after_help = PUBLISH_EXAMPLES,
)]
pub struct PublishCommand {
    #[command(flatten)]
    pub certs: CertDesignators<FileCertUserIDEmailDomainArgs,
                               CertPrefix>,
}

const PUBLISH_EXAMPLES: Actions = Actions {
    actions: &[
        Action::example().comment(
            "Publish Alice's certificate on the default keyservers."
        ).command(&[
            "sq", "network", "keyserver", "publish",
            "--cert-email=alice@example.org",
        ]).syntax_check(),
    ],
};
test_examples!(sq_network_keyserver_publish, PUBLISH_EXAMPLES);

/// Joins the given key server URLs into a list.
fn join<'a>(i: impl Iterator<Item = &'a str>) -> String {
    let mut i = i.map(|u| format!("`{}`", u)).collect::<Vec<_>>();
    match i.len() {
        0 => panic!("empty list"),
        1 => i.pop().unwrap(),
        2 => format!("{} and {}", i[0], i[1]),
        n => format!("{}, and {}", i[..n-1].join(", "), i[n-1]),
    }
}