aws_waf_xss_match_set resource

Use the aws_waf_xss_match_set InSpec audit resource to test the properties of a single AWS WAF XssMatchSet object.

For additional information, including details on parameters and properties, see the AWS documentation on the AWS::WAF::XssMatchSet resource.

Install

This resource is available in the Chef InSpec AWS resource pack.

For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.

Ensure that an XssMatchSet object exists.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
  it { should exist }
end

xss_match_set_id: A unique identifier for an XssMatchSet.
name: The name of the XssMatchSet.
xss_match_tuples: Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
xss_match_tuples_field_to_match_types: The part of the web request that you want AWS WAF to search for a specified string.
xss_match_tuples_field_to_match_data: When the value of Type is HEADER , enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer.
xss_match_tuples_text_transformations: Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF.

Ensure an XssMatchSet object is available.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
  its('xss_match_set_id') { should eq 'XSS_MATCH_SET_ID' }
end

Verify the name of an XssMatchSet object.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
    its('name') { should eq 'XSS_MATCH_SET_NAME' }
end

Verify an XssMatchSet object has a type of URI.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
    its('xss_match_tuples_field_to_match_types') { should include 'URI' }
end

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

Use should to test that the entity exists.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
  it { should_not exist }
end

Use should to check if the entity is available.

describe aws_waf_xss_match_set(xss_match_set_id: 'XSS_MATCH_SET_ID') do
  it { should be_available }
end

Your Principal will need the WAF:Client:GetXssMatchSetResponse action with Effect set to Allow.