@Generated(value="OracleSDKGenerator", comments="API Version: 20181116") public final class CustomProtectionRule extends Object
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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
CustomProtectionRule.Builder |
| Constructor and Description |
|---|
CustomProtectionRule(String id,
String compartmentId,
String displayName,
String description,
List<String> modSecurityRuleIds,
String template,
LifecycleStates lifecycleState,
Date timeCreated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CustomProtectionRule.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the custom protection rule’s compartment.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the custom protection rule.
|
String |
getDisplayName()
The user-friendly name of the custom protection rule.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the custom protection rule.
|
LifecycleStates |
getLifecycleState()
The current lifecycle state of the custom protection rule.
|
List<String> |
getModSecurityRuleIds()
The auto-generated ID for the custom protection rule.
|
String |
getTemplate()
The template text of the custom protection rule.
|
Date |
getTimeCreated()
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
|
int |
hashCode() |
CustomProtectionRule.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","displayName","description","modSecurityRuleIds","template","lifecycleState","timeCreated","freeformTags","definedTags"}) @Deprecated public CustomProtectionRule(String id, String compartmentId, String displayName, String description, List<String> modSecurityRuleIds, String template, LifecycleStates lifecycleState, Date timeCreated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static CustomProtectionRule.Builder builder()
Create a new builder.
public CustomProtectionRule.Builder toBuilder()
public String getCompartmentId()
The OCID of the custom protection rule’s compartment.
public String getDisplayName()
The user-friendly name of the custom protection rule.
public String getDescription()
The description of the custom protection rule.
public List<String> getModSecurityRuleIds()
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
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.cloud.oracle.com/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).
public LifecycleStates getLifecycleState()
The current lifecycle state of the custom protection rule.
public Date getTimeCreated()
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
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\"}`
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\"}}`
Copyright © 2016–2021. All rights reserved.