Package com.oracle.bmc.waas.model

Class CustomProtectionRule

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public final class CustomProtectionRule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of a custom protection rule.
    Note: Objects should always be created or deserialized using the CustomProtectionRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CustomProtectionRule.Builder, which maintain a set of all explicitly set fields called CustomProtectionRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the custom protection rule.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the custom protection rule’s compartment.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The user-friendly name of the custom protection rule.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the custom protection rule.
        Returns:
        the value

      • getModSecurityRuleIds

        public List<String> getModSecurityRuleIds()
        The auto-generated ID for the custom protection rule.

        These IDs are referenced in logs.

        Returns:
        the value

      • getTemplate

        public String getTemplate()
        The template text of the custom protection rule.

        All custom protection rules are expressed in ModSecurity Rule Language.

        Additionally, each rule must include two placeholder variables that are updated by the WAF service upon publication of the rule.

        id: {{id_1}} - This field is populated with a unique rule ID generated by the WAF service which identifies a SecRule. More than one SecRule can be defined in the template field of a CreateCustomSecurityRule call. The value of the first SecRule must be id: {{id_1}} and the id field of each subsequent SecRule should increase by one, as shown in the example.

        ctl:ruleEngine={{mode}} - The action to be taken when the criteria of the SecRule are met, either OFF, DETECT or BLOCK. This field is automatically populated with the corresponding value of the action field of the CustomProtectionRuleSetting schema when the WafConfig is updated.

        Example:* SecRule REQUEST_COOKIES "regex matching SQL injection - part 1/2" \\ "phase:2, \\ msg:'Detects chained SQL injection attempts 1/2.', \\ id: {{id_1}}, \\ ctl:ruleEngine={{mode}}, \\ deny" SecRule REQUEST_COOKIES "regex matching SQL injection - part 2/2" \\ "phase:2, \\ msg:'Detects chained SQL injection attempts 2/2.', \\ id: {{id_2}}, \\ ctl:ruleEngine={{mode}}, \\ deny"

        The example contains two SecRules each having distinct regex expression to match the Cookie header value during the second input analysis phase.

        For more information about custom protection rules, see [Custom Protection Rules](https://docs.oracle.com/iaas/Content/WAF/Tasks/customprotectionrules.htm).

        For more information about ModSecurity syntax, see [Making Rules: The Basic Syntax](https://www.modsecurity.org/CRS/Documentation/making.html).

        For more information about ModSecurity's open source WAF rules, see [Mod Security's OWASP Core Rule Set documentation](https://www.modsecurity.org/CRS/Documentation/index.html).

        Returns:
        the value

      • getLifecycleState

        public LifecycleStates getLifecycleState()
        The current lifecycle state of the custom protection rule.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel