Skip to content

AnalysisResult

Source code in docs_src/capo_network_firewall/types/analysis_result.py
class AnalysisResult(TypedDict, closed=True):
    identified_rule_ids: NotRequired[
        "capo_network_firewall.types.rule_id_list.RuleIdList"
    ]
    """<p>The priority number of the stateless rules identified in the analysis.</p>"""
    identified_type: NotRequired[
        "capo_network_firewall.types.identified_type.IdentifiedType"
    ]
    """<p>The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:</p> <ul> <li> <p> <code>STATELESS_RULE_FORWARDING_ASYMMETRICALLY</code> </p> <p>Cause: One or more stateless rules with the action <code>pass</code> or <code>forward</code> are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.</p> <p>To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.</p> </li> <li> <p> <code>STATELESS_RULE_CONTAINS_TCP_FLAGS</code> </p> <p>Cause: At least one stateless rule with the action <code>pass</code> or<code>forward</code> contains TCP flags that are inconsistent in the forward and return directions.</p> <p>To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:</p> <ul> <li> <p>Remove unnecessary TCP flag inspections from the rules.</p> </li> <li> <p>If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example <code>SYN</code> and <code>ACK</code> flags used in a 3-way TCP handshake.</p> </li> </ul> </li> </ul>"""
    analysis_detail: NotRequired[
        "capo_network_firewall.types.collection_member_string.CollectionMember_String"
    ]
    """<p>Provides analysis details for the identified rule.</p>"""

analysis_detail instance-attribute

analysis_detail: NotRequired[CollectionMember_String]

Provides analysis details for the identified rule.

identified_rule_ids instance-attribute

identified_rule_ids: NotRequired[RuleIdList]

The priority number of the stateless rules identified in the analysis.

identified_type instance-attribute

identified_type: NotRequired[IdentifiedType]

The types of rule configurations that Network Firewall analyzes your rule groups for. Network Firewall analyzes stateless rule groups for the following types of rule configurations:

  • STATELESS_RULE_FORWARDING_ASYMMETRICALLY

    Cause: One or more stateless rules with the action pass or forward are forwarding traffic asymmetrically. Specifically, the rule's set of source IP addresses or their associated port numbers, don't match the set of destination IP addresses or their associated port numbers.

    To mitigate: Make sure that there's an existing return path. For example, if the rule allows traffic from source 10.1.0.0/24 to destination 20.1.0.0/24, you should allow return traffic from source 20.1.0.0/24 to destination 10.1.0.0/24.

  • STATELESS_RULE_CONTAINS_TCP_FLAGS

    Cause: At least one stateless rule with the action pass orforward contains TCP flags that are inconsistent in the forward and return directions.

    To mitigate: Prevent asymmetric routing issues caused by TCP flags by following these actions:

    • Remove unnecessary TCP flag inspections from the rules.

    • If you need to inspect TCP flags, check that the rules correctly account for changes in TCP flags throughout the TCP connection cycle, for example SYN and ACK flags used in a 3-way TCP handshake.