Struct KeyArgs

pub struct KeyArgs {
    pub key_path: Option<PathBuf>,
    pub key: Option<String>,
    pub pass: PassphraseArgs,
}

Clap arguments for keys (public, secret, and identity).

use clap::Parser;
use miette::Result;
use algae_cli::keys::KeyArgs;

/// Your CLI tool
#[derive(Parser)]
struct Args {
    #[command(flatten)]
    key: KeyArgs,
}

#[tokio::main]
async fn main() -> Result<()> {
    let args = Args::parse();
    let key = args.key.require_secret_key().await?;
    // use key somehow...
    Ok(())
}

Fields

key_path: Option<PathBuf>

Path to the key or identity file to use for encrypting/decrypting.

The file can either be:

• an identity file, which contains both a public and secret key, in age format;
• a passphrase-protected identity file;
• a secret key in Bech32 encoding (starts with AGE-SECRET-KEY);
• when encrypting, a public key in Bech32 encoding (starts with age).

When encrypting and provided with a secret key, the corresponding public key will be derived first; there is no way to encrypt with a secret key such that a file is decodable with the public key.

Examples

An identity file:

# created: 2024-12-20T05:36:10.267871872+00:00
# public key: age1c3jdepjm05aey2dq9dgkfn4utj9a776zwqzqcar3879smuh04ysqttvmyd
AGE-SECRET-KEY-1N84CR29PJTUQA22ALHP4YDL5ZFMXPW5GVETVY3UK58ZD6NPNPDLS4MCZFS

An passphrase-protected identity file:

age-encryption.org/v1
-> scrypt BIsqC5QmFKsr4IJmVyHovQ 20
GKscLTw0+n/z+vktrgcoW5eCh0qCfTkFnbTFLrhvXrI
--- rFMmV2H+FgP27oaLC6SHQOLy5d5DPGSp2pktFo/AOh8
U�`OZ�rGЕ~N}Ͷ
MbE/2m��`aQfl&$QCx
n:T?#�k!_�ΉIa�Y|�}j[頙߄)JJ{څ1y}cܪB���7�

A public key file:

age1c3jdepjm05aey2dq9dgkfn4utj9a776zwqzqcar3879smuh04ysqttvmyd

A secret key file:

AGE-SECRET-KEY-1N84CR29PJTUQA22ALHP4YDL5ZFMXPW5GVETVY3UK58ZD6NPNPDLS4MCZFS

key: Option<String>

The key to use for encrypting/decrypting as a string.

This does not support the age identity format, only single keys.

When encrypting and provided with a secret key, the corresponding public key will be derived first; there is no way to encrypt with a secret key such that a file is decodable with the public key.

There is no support for password-protected secret keys.

Examples

With a public key:

--key age1c3jdepjm05aey2dq9dgkfn4utj9a776zwqzqcar3879smuh04ysqttvmyd

With a secret key:

--key AGE-SECRET-KEY-1N84CR29PJTUQA22ALHP4YDL5ZFMXPW5GVETVY3UK58ZD6NPNPDLS4MCZFS

pass: PassphraseArgs

Implementations

impl KeyArgs

pub async fn get_secret_key(&self) -> Result<Option<Box<dyn Identity>>>

Retrieve the secret key from the arguments, if one was provided.

Returns None if neither of --key-path or --key was given.

Use Self::require_secret_key instead of dealing with the None yourself if you need to have a mandatory interface.

pub async fn require_secret_key(&self) -> Result<Box<dyn Identity>>

Retrieve the secret key from the arguments, and error if none is available.

Use Self::get_secret_key instead of parsing the error if you need to have optional keys.

pub async fn get_public_key(&self) -> Result<Option<Box<dyn Recipient + Send>>>

Retrieve the public key from the arguments, if one was provided.

Returns None if neither of --key-path or --key was given.

Use Self::require_public_key instead of dealing with the None yourself if you need to have a mandatory interface.

pub async fn require_public_key(&self) -> Result<Box<dyn Recipient + Send>>

Retrieve the public key from the arguments, and error if none is available.

Use Self::get_public_key instead of parsing the error if you need to have optional keys.

Trait Implementations

impl Args for KeyArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for KeyArgs

fn clone(&self) -> KeyArgs

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for KeyArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for KeyArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for KeyArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for KeyArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.