CreateCustomProtectionRuleDetails¶

class oci.waas.models.CreateCustomProtectionRuleDetails(**kwargs)¶

Bases: object

The required data to create a custom protection rule. For more information about custom protection rules, see Custom Protection Rules. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Methods

__init__(**kwargs) Initializes a new CreateCustomProtectionRuleDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateCustomProtectionRuleDetails.
`defined_tags`	Gets the defined_tags of this CreateCustomProtectionRuleDetails.
`description`	Gets the description of this CreateCustomProtectionRuleDetails.
`display_name`	[Required] Gets the display_name of this CreateCustomProtectionRuleDetails.
`freeform_tags`	Gets the freeform_tags of this CreateCustomProtectionRuleDetails.
`template`	[Required] Gets the template of this CreateCustomProtectionRuleDetails.

__init__(**kwargs)¶

Initializes a new CreateCustomProtectionRuleDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateCustomProtectionRuleDetails.
display_name (str) – The value to assign to the display_name property of this CreateCustomProtectionRuleDetails.
description (str) – The value to assign to the description property of this CreateCustomProtectionRuleDetails.
template (str) – The value to assign to the template property of this CreateCustomProtectionRuleDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateCustomProtectionRuleDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateCustomProtectionRuleDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateCustomProtectionRuleDetails. The OCID of the compartment in which to create the custom protection rule.

Returns:	The compartment_id of this CreateCustomProtectionRuleDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateCustomProtectionRuleDetails. 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 defined_tags of this CreateCustomProtectionRuleDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateCustomProtectionRuleDetails. A description for the Custom Protection rule.

Returns:	The description of this CreateCustomProtectionRuleDetails.
Return type:	str

display_name¶

[Required] Gets the display_name of this CreateCustomProtectionRuleDetails. A user-friendly name for the custom protection rule.

Returns:	The display_name of this CreateCustomProtectionRuleDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateCustomProtectionRuleDetails. 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 freeform_tags of this CreateCustomProtectionRuleDetails.
Return type:	dict(str, str)

template¶

[Required] Gets the template of this CreateCustomProtectionRuleDetails. 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.

For more information about ModSecurity syntax, see Making Rules: The Basic Syntax.

For more information about ModSecurity’s open source WAF rules, see Mod Security’s OWASP Core Rule Set documentation.

Returns:	The template of this CreateCustomProtectionRuleDetails.
Return type:	str