Struct EnvelopeArgs 

pub struct EnvelopeArgs {
    pub envelope: Option<Envelope>,
    pub envelope_aad: Option<Aad>,
    pub envelope_aad_encoding: Option<Encoding>,
}

Fields

envelope: Option<Envelope>

The URI for the crypto key from a KMS to use as envelope encryption if the keyring is to be encrypted.

The value should be in the form <gcp|aws|azure|vault>://.

• \033[1mGCP\033[0m: gcp://projects//locations//keyRings//cryptoKeys/
• AWS: aws://arn:aws:kms:::key/
• JSON: json://

envelope_aad: Option<Aad>

Additional authenticated data(AAD), if any, used to authenticate the keyring.

The value can either be a URI in the form <gcp|aws|azure|vault>:// or a possibly encoded (base64 or hex) string.

For URIs, the path should be the secret’s URI on a supported secret manager. For example, a path of: gcp://projects/my-project/secrets/my-secret/versions/1 would use the first version of the secret “my-secret” on GCP.

For both secrets hosted on a secret manager and strings, the the envelope-aad-encoding determines if and how the value is decoded.

envelope_aad_encoding: Option<Encoding>

The encoding of the envelope AAD value, if any. If not specified, the value is treated as a string.

Implementations

impl EnvelopeArgs

pub fn get_aad(&self) -> Aad<Bytes>

pub fn get_envelope(&self, plaintext: Option<bool>) -> Result<Envelope>

Trait Implementations

impl Args for EnvelopeArgs

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 CommandFactory for EnvelopeArgs

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 EnvelopeArgs

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

Formats the value using the given formatter.

impl Default for EnvelopeArgs

fn default() -> EnvelopeArgs

Returns the “default value” for a type.

impl FromArgMatches for EnvelopeArgs

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 EnvelopeArgs

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.