CustomProtectionRule¶

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

Bases: object

The details of a custom protection rule.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CustomProtectionRule.
`compartment_id`	Gets the compartment_id of this CustomProtectionRule.
`defined_tags`	Gets the defined_tags of this CustomProtectionRule.
`description`	Gets the description of this CustomProtectionRule.
`display_name`	Gets the display_name of this CustomProtectionRule.
`freeform_tags`	Gets the freeform_tags of this CustomProtectionRule.
`id`	Gets the id of this CustomProtectionRule.
`lifecycle_state`	Gets the lifecycle_state of this CustomProtectionRule.
`mod_security_rule_ids`	Gets the mod_security_rule_ids of this CustomProtectionRule.
`template`	Gets the template of this CustomProtectionRule.
`time_created`	Gets the time_created of this CustomProtectionRule.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a CustomProtectionRule. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this CustomProtectionRule.
compartment_id (str) – The value to assign to the compartment_id property of this CustomProtectionRule.
display_name (str) – The value to assign to the display_name property of this CustomProtectionRule.
description (str) – The value to assign to the description property of this CustomProtectionRule.
mod_security_rule_ids (list[str]) – The value to assign to the mod_security_rule_ids property of this CustomProtectionRule.
template (str) – The value to assign to the template property of this CustomProtectionRule.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CustomProtectionRule. Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this CustomProtectionRule.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CustomProtectionRule.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CustomProtectionRule.

compartment_id¶

Gets the compartment_id of this CustomProtectionRule. The OCID of the custom protection rule’s compartment.

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

defined_tags¶

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

description¶

Gets the description of this CustomProtectionRule. The description of the custom protection rule.

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

display_name¶

Gets the display_name of this CustomProtectionRule. The user-friendly name of the custom protection rule.

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

freeform_tags¶

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

id¶

Gets the id of this CustomProtectionRule. The OCID of the custom protection rule.

Returns:	The id of this CustomProtectionRule.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this CustomProtectionRule. The current lifecycle state of the custom protection rule.

Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this CustomProtectionRule.
Return type:	str

mod_security_rule_ids¶

Gets the mod_security_rule_ids of this CustomProtectionRule. The auto-generated ID for the custom protection rule. These IDs are referenced in logs.

Returns:	The mod_security_rule_ids of this CustomProtectionRule.
Return type:	list[str]

template¶

Gets the template of this CustomProtectionRule. 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 CustomProtectionRule.
Return type:	str

time_created¶

Gets the time_created of this CustomProtectionRule. The date and time the protection rule was created, expressed in RFC 3339 timestamp format.

Returns:	The time_created of this CustomProtectionRule.
Return type:	datetime