Struct KeygenArgs

pub struct KeygenArgs {
    pub output: Option<PathBuf>,
    pub public_path: PathBuf,
    pub plaintext: bool,
    pub random_passphrase: bool,
    pub key: PassphraseArgs,
}

Generate an identity (key pair) to encrypt and decrypt files

This creates a passphrase-protected identity file which contains both public and secret keys:

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

As well as a plaintext public key file which contains just the public key:

age1c3jdepjm05aey2dq9dgkfn4utj9a776zwqzqcar3879smuh04ysqttvmyd

The public key is also printed to stdout.

By default this command prompts for a passphrase. This can be disabled with --plaintext; the default path identity.txt instead of identity.txt.age is used if --output isn’t given, and the contents will be in plain text (in the format shown above).

On encrypting machines (e.g. servers uploading backups), you should always prefer to store just the public key, and only upload and use the passphrase-protected identity file as necessary, deleting it afterwards.

Identity files (both plaintext and passphrase-protected) generated by this command are compatible with the age CLI tool. Note that the reverse might not be true (there are age-generated identities that this tool cannot handle).

Fields

output: Option<PathBuf>

Path to write the identity file to.

Defaults to identity.txt.age, and to identity.txt if –plaintext is given.

public_path: PathBuf

Path to write the public key file to.

Set to a single hyphen (-) to disable writing this file; the public key will be printed to stdout in any case.

plaintext: bool

INSECURE: write a plaintext identity.

random_passphrase: bool

Generate a random passphrase.

Instead of entering a passphrase yourself, this will generate one with random words (from the Minilock wordlist) and print it out for you.

key: PassphraseArgs

Trait Implementations

impl Args for KeygenArgs

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 KeygenArgs

fn clone(&self) -> KeygenArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for KeygenArgs

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 KeygenArgs

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

Formats the value using the given formatter.

impl FromArgMatches for KeygenArgs

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 KeygenArgs

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.