#[non_exhaustive]pub struct VerifyInputBuilder { /* private fields */ }
Expand description
A builder for VerifyInput
.
Implementations§
Source§impl VerifyInputBuilder
impl VerifyInputBuilder
Sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name:
alias/ExampleAlias
-
Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
. To get the alias name and alias ARN, use ListAliases
.
Sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name:
alias/ExampleAlias
-
Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
. To get the alias name and alias ARN, use ListAliases
.
Sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &Option<String>
Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/"
. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
-
Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
-
Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
-
Alias name:
alias/ExampleAlias
-
Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys
or DescribeKey
. To get the alias name and alias ARN, use ListAliases
.
Sourcepub fn message(self, input: Blob) -> Self
pub fn message(self, input: Blob) -> Self
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType
parameter with a value of DIGEST
.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
This field is required.Sourcepub fn set_message(self, input: Option<Blob>) -> Self
pub fn set_message(self, input: Option<Blob>) -> Self
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType
parameter with a value of DIGEST
.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
Sourcepub fn get_message(&self) -> &Option<Blob>
pub fn get_message(&self) -> &Option<Blob>
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType
parameter with a value of DIGEST
.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
Sourcepub fn message_type(self, input: MessageType) -> Self
pub fn message_type(self, input: MessageType) -> Self
Tells KMS whether the value of the Message
parameter should be hashed as part of the signing algorithm. Use RAW
for unhashed messages; use DIGEST
for message digests, which are already hashed.
When the value of MessageType
is RAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST
, KMS skips the hashing step in the signing algorithm.
Use the DIGEST
value only when the value of the Message
parameter is a message digest. If you use the DIGEST
value with an unhashed message, the security of the verification operation can be compromised.
When the value of MessageType
is DIGEST
, the length of the Message
value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType
or specify RAW
so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify
uses is based on the SigningAlgorithm
value.
-
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
-
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
-
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
-
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Sourcepub fn set_message_type(self, input: Option<MessageType>) -> Self
pub fn set_message_type(self, input: Option<MessageType>) -> Self
Tells KMS whether the value of the Message
parameter should be hashed as part of the signing algorithm. Use RAW
for unhashed messages; use DIGEST
for message digests, which are already hashed.
When the value of MessageType
is RAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST
, KMS skips the hashing step in the signing algorithm.
Use the DIGEST
value only when the value of the Message
parameter is a message digest. If you use the DIGEST
value with an unhashed message, the security of the verification operation can be compromised.
When the value of MessageType
is DIGEST
, the length of the Message
value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType
or specify RAW
so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify
uses is based on the SigningAlgorithm
value.
-
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
-
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
-
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
-
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Sourcepub fn get_message_type(&self) -> &Option<MessageType>
pub fn get_message_type(&self) -> &Option<MessageType>
Tells KMS whether the value of the Message
parameter should be hashed as part of the signing algorithm. Use RAW
for unhashed messages; use DIGEST
for message digests, which are already hashed.
When the value of MessageType
is RAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST
, KMS skips the hashing step in the signing algorithm.
Use the DIGEST
value only when the value of the Message
parameter is a message digest. If you use the DIGEST
value with an unhashed message, the security of the verification operation can be compromised.
When the value of MessageType
is DIGEST
, the length of the Message
value must match the length of hashed messages for the specified signing algorithm.
You can submit a message digest and omit the MessageType
or specify RAW
so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.
The hashing algorithm in that Verify
uses is based on the SigningAlgorithm
value.
-
Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.
-
Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.
-
Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.
-
SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.
Sourcepub fn signature(self, input: Blob) -> Self
pub fn signature(self, input: Blob) -> Self
The signature that the Sign
operation generated.
Sourcepub fn set_signature(self, input: Option<Blob>) -> Self
pub fn set_signature(self, input: Option<Blob>) -> Self
The signature that the Sign
operation generated.
Sourcepub fn get_signature(&self) -> &Option<Blob>
pub fn get_signature(&self) -> &Option<Blob>
The signature that the Sign
operation generated.
Sourcepub fn signing_algorithm(self, input: SigningAlgorithmSpec) -> Self
pub fn signing_algorithm(self, input: SigningAlgorithmSpec) -> Self
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
This field is required.Sourcepub fn set_signing_algorithm(self, input: Option<SigningAlgorithmSpec>) -> Self
pub fn set_signing_algorithm(self, input: Option<SigningAlgorithmSpec>) -> Self
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
Sourcepub fn get_signing_algorithm(&self) -> &Option<SigningAlgorithmSpec>
pub fn get_signing_algorithm(&self) -> &Option<SigningAlgorithmSpec>
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
Sourcepub fn grant_tokens(self, input: impl Into<String>) -> Self
pub fn grant_tokens(self, input: impl Into<String>) -> Self
Appends an item to grant_tokens
.
To override the contents of this collection use set_grant_tokens
.
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
Sourcepub fn set_grant_tokens(self, input: Option<Vec<String>>) -> Self
pub fn set_grant_tokens(self, input: Option<Vec<String>>) -> Self
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
Sourcepub fn get_grant_tokens(&self) -> &Option<Vec<String>>
pub fn get_grant_tokens(&self) -> &Option<Vec<String>>
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
Sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
Sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
Sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
Sourcepub fn build(self) -> Result<VerifyInput, BuildError>
pub fn build(self) -> Result<VerifyInput, BuildError>
Consumes the builder and constructs a VerifyInput
.
Source§impl VerifyInputBuilder
impl VerifyInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<VerifyOutput, SdkError<VerifyError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<VerifyOutput, SdkError<VerifyError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for VerifyInputBuilder
impl Clone for VerifyInputBuilder
Source§fn clone(&self) -> VerifyInputBuilder
fn clone(&self) -> VerifyInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for VerifyInputBuilder
impl Debug for VerifyInputBuilder
Source§impl Default for VerifyInputBuilder
impl Default for VerifyInputBuilder
Source§fn default() -> VerifyInputBuilder
fn default() -> VerifyInputBuilder
Source§impl PartialEq for VerifyInputBuilder
impl PartialEq for VerifyInputBuilder
impl StructuralPartialEq for VerifyInputBuilder
Auto Trait Implementations§
impl Freeze for VerifyInputBuilder
impl RefUnwindSafe for VerifyInputBuilder
impl Send for VerifyInputBuilder
impl Sync for VerifyInputBuilder
impl Unpin for VerifyInputBuilder
impl UnwindSafe for VerifyInputBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);