Struct ChallengeAction

#[non_exhaustive]
pub struct ChallengeAction {
    pub custom_request_handling: Option<CustomRequestHandling>,
}

Specifies that WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session:

• If the request includes a valid, unexpired challenge token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a CountAction.

• If the request doesn't include a valid, unexpired challenge token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

  WAF then generates a challenge response that it sends back to the client, which includes the following:

  • The header x-amzn-waf-action with a value of challenge.

  • The HTTP status code 202 Request Accepted.

  • If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script.

  Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.

  A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.

  After the client session successfully responds to the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.

You can configure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

This action option is available for rules. It isn't available for web ACL default actions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

custom_request_handling: Option<CustomRequestHandling>

Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

Implementations

impl ChallengeAction

pub fn custom_request_handling(&self) -> Option<&CustomRequestHandling>

Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

impl ChallengeAction

pub fn builder() -> ChallengeActionBuilder

Creates a new builder-style object to manufacture ChallengeAction.

Trait Implementations

impl Clone for ChallengeAction

fn clone(&self) -> ChallengeAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChallengeAction

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

Formats the value using the given formatter.

impl PartialEq for ChallengeAction

fn eq(&self, other: &ChallengeAction) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChallengeAction