Try Spottercreate and delete WAF Conditions
| "added in version" 2.5 of ansible.builtin"
Authors: Will Thames (@willthames), Mike Mochan (@mmochan)
preview | supported by community
pipInstall with pip install ansible==2.8.19
Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)
- name: create WAF byte condition
aws_waf_condition:
name: my_byte_condition
filters:
- field_to_match: header
position: STARTS_WITH
target_string: Hello
header: Content-type
type: byte
- name: create WAF geo condition
aws_waf_condition:
name: my_geo_condition
filters:
- country: US
- country: AU
- country: AT
type: geo
- name: create IP address condition
aws_waf_condition:
name: "{{ resource_prefix }}_ip_condition"
filters:
- ip_address: "10.0.0.0/8"
- ip_address: "192.168.0.0/24"
type: ip
- name: create WAF regex condition
aws_waf_condition:
name: my_regex_condition
filters:
- field_to_match: query_string
regex_pattern:
name: greetings
regex_strings:
- '[hH]ello'
- '^Hi there'
- '.*Good Day to You'
type: regex
- name: create WAF size condition
aws_waf_condition:
name: my_size_condition
filters:
- field_to_match: query_string
size: 300
comparison: GT
type: size
- name: create WAF sql injection condition
aws_waf_condition:
name: my_sql_condition
filters:
- field_to_match: query_string
transformation: url_decode
type: sql
- name: create WAF xss condition
aws_waf_condition:
name: my_xss_condition
filters:
- field_to_match: query_string
transformation: url_decode
type: xss
name:
description: Name of the Web Application Firewall condition to manage.
required: true
type:
choices:
- byte
- geo
- ip
- regex
- size
- sql
- xss
description: the type of matching to perform.
state:
choices:
- present
- absent
default: present
description: Whether the condition should be C(present) or C(absent).
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
filters:
description:
- A list of the filters against which to match.
- For I(type)=C(byte), valid keys are C(field_to_match), C(position), C(header), C(transformation).
- For I(type)=C(geo), the only valid key is C(country).
- For I(type)=C(ip), the only valid key is C(ip_address).
- For I(type)=C(regex), valid keys are C(field_to_match), C(transformation) and C(regex_pattern).
- For I(type)=C(size), valid keys are C(field_to_match), C(transformation), C(comparison)
and C(size).
- For I(type)=C(sql), valid keys are C(field_to_match) and C(transformation).
- For I(type)=C(xss), valid keys are C(field_to_match) and C(transformation).
- I(field_to_match) can be one of C(uri), C(query_string), C(header) C(method) and
C(body).
- If I(field_to_match) is C(header), then C(header) must also be specified.
- I(transformation) can be one of C(none), C(compress_white_space), C(html_entity_decode),
C(lowercase), C(cmd_line), C(url_decode).
- I(position), can be one of C(exactly), C(starts_with), C(ends_with), C(contains),
C(contains_word).
- I(comparison) can be one of C(EQ), C(NE), C(LE), C(LT), C(GE), C(GT).
- I(target_string) is a maximum of 50 bytes.
- I(regex_pattern) is a dict with a C(name) key and C(regex_strings) list of strings
to match.
profile:
aliases:
- aws_profile
description:
- Uses a boto profile. Only works with boto >= 2.24.0.
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Only used for boto3 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
purge_filters:
default: false
description:
- Whether to remove existing filters from a condition if not passed in I(filters).
type: bool
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY
or EC2_ACCESS_KEY environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY,
or EC2_SECRET_KEY environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN
environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
type: bool
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
condition:
contains:
byte_match_set_id:
description: ID for byte match set
returned: always
sample: c4882c96-837b-44a2-a762-4ea87dbf812b
type: str
byte_match_tuples:
contains:
field_to_match:
contains:
data:
description: Which specific header (if type is header)
sample: content-type
type: str
type:
description: Type of field
sample: HEADER
type: str
description: Field to match
returned: always
type: complex
positional_constraint:
description: Position in the field to match
sample: STARTS_WITH
type: str
target_string:
description: String to look for
sample: Hello
type: str
text_transformation:
description: Transformation to apply to the field before matching
sample: NONE
type: str
description: list of byte match tuples
returned: always
type: complex
condition_id:
description: type-agnostic ID for the condition
returned: when state is present
sample: dd74b1ff-8c06-4a4f-897a-6b23605de413
type: str
geo_match_constraints:
contains:
type:
description: Type of geo constraint
sample: Country
type: str
value:
description: Value of geo constraint (typically a country code)
sample: AT
type: str
description: List of geographical constraints
returned: when type is geo and state is present
type: complex
geo_match_set_id:
description: ID of the geo match set
returned: when type is geo and state is present
sample: dd74b1ff-8c06-4a4f-897a-6b23605de413
type: str
ip_set_descriptors:
contains:
type:
description: Type of IP address (IPV4 or IPV6)
returned: always
sample: IPV4
type: str
value:
description: IP address
returned: always
sample: 10.0.0.0/8
type: str
description: list of IP address filters
returned: when type is ip and state is present
type: complex
ip_set_id:
description: ID of condition
returned: when type is ip and state is present
sample: 78ad334a-3535-4036-85e6-8e11e745217b
type: str
name:
description: Name of condition
returned: when state is present
sample: my_waf_condition
type: str
regex_match_set_id:
description: ID of the regex match set
returned: when type is regex and state is present
sample: 5ea3f6a8-3cd3-488b-b637-17b79ce7089c
type: str
regex_match_tuples:
contains:
field_to_match:
contains:
type:
description: The field name
returned: when type is regex and state is present
sample: QUERY_STRING
type: str
description: Field on which the regex match is applied
type: complex
regex_pattern_set_id:
description: ID of the regex pattern
sample: 6fdf7f2d-9091-445c-aef2-98f3c051ac9e
type: str
text_transformation:
description: transformation applied to the text before matching
sample: NONE
type: str
description: List of regex matches
returned: when type is regex and state is present
type: complex
size_constraint_set_id:
description: ID of the size constraint set
returned: when type is size and state is present
sample: de84b4b3-578b-447e-a9a0-0db35c995656
type: str
size_constraints:
contains:
comparison_operator:
description: Comparison operator to apply
sample: GT
type: str
field_to_match:
contains:
type:
description: Field name
sample: QUERY_STRING
type: str
description: Field on which the size constraint is applied
type: complex
size:
description: size to compare against the field
sample: 300
type: int
text_transformation:
description: transformation applied to the text before matching
sample: NONE
type: str
description: List of size constraints to apply
returned: when type is size and state is present
type: complex
sql_injection_match_set_id:
description: ID of the SQL injection match set
returned: when type is sql and state is present
sample: de84b4b3-578b-447e-a9a0-0db35c995656
type: str
sql_injection_match_tuples:
contains:
field_to_match:
contains:
type:
description: Field name
sample: QUERY_STRING
type: str
description: Field on which the SQL injection match is applied
type: complex
text_transformation:
description: transformation applied to the text before matching
sample: URL_DECODE
type: str
description: List of SQL injection match sets
returned: when type is sql and state is present
type: complex
xss_match_set_id:
description: ID of the XSS match set
returned: when type is xss and state is present
sample: de84b4b3-578b-447e-a9a0-0db35c995656
type: str
xss_match_tuples:
contains:
field_to_match:
contains:
type:
description: Field name
sample: QUERY_STRING
type: str
description: Field on which the XSS match is applied
type: complex
text_transformation:
description: transformation applied to the text before matching
sample: URL_DECODE
type: str
description: List of XSS match sets
returned: when type is xss and state is present
type: complex
description: condition returned by operation
returned: always
type: complex