Class: OCI::Waas::Models::CustomProtectionRule
- Inherits:
-
Object
- Object
- OCI::Waas::Models::CustomProtectionRule
- Defined in:
- lib/oci/waas/models/custom_protection_rule.rb
Overview
The details of a custom protection rule.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the custom protection rule's compartment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the custom protection rule.
-
#display_name ⇒ String
The user-friendly name of the custom protection rule.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
The OCID of the custom protection rule.
-
#lifecycle_state ⇒ String
The current lifecycle state of the custom protection rule.
-
#mod_security_rule_ids ⇒ Array<String>
The auto-generated ID for the custom protection rule.
-
#template ⇒ String
The template text of the custom protection rule.
-
#time_created ⇒ DateTime
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CustomProtectionRule
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CustomProtectionRule
Initializes the object
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 153 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.id = attributes[:'id'] if attributes[:'id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.description = attributes[:'description'] if attributes[:'description'] self.mod_security_rule_ids = attributes[:'modSecurityRuleIds'] if attributes[:'modSecurityRuleIds'] raise 'You cannot provide both :modSecurityRuleIds and :mod_security_rule_ids' if attributes.key?(:'modSecurityRuleIds') && attributes.key?(:'mod_security_rule_ids') self.mod_security_rule_ids = attributes[:'mod_security_rule_ids'] if attributes[:'mod_security_rule_ids'] self.template = attributes[:'template'] if attributes[:'template'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID of the custom protection rule's compartment.
28 29 30 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 28 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
99 100 101 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 99 def @defined_tags end |
#description ⇒ String
The description of the custom protection rule.
36 37 38 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 36 def description @description end |
#display_name ⇒ String
The user-friendly name of the custom protection rule.
32 33 34 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 32 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
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\"}
91 92 93 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 91 def @freeform_tags end |
#id ⇒ String
The OCID of the custom protection rule.
24 25 26 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 24 def id @id end |
#lifecycle_state ⇒ String
The current lifecycle state of the custom protection rule.
79 80 81 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 79 def lifecycle_state @lifecycle_state end |
#mod_security_rule_ids ⇒ Array<String>
The auto-generated ID for the custom protection rule. These IDs are referenced in logs.
40 41 42 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 40 def mod_security_rule_ids @mod_security_rule_ids end |
#template ⇒ String
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.
75 76 77 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 75 def template @template end |
#time_created ⇒ DateTime
The date and time the protection rule was created, expressed in RFC 3339 timestamp format.
83 84 85 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 83 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 102 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'description': :'description', 'mod_security_rule_ids': :'modSecurityRuleIds', 'template': :'template', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 120 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'description': :'String', 'mod_security_rule_ids': :'Array<String>', 'template': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 228 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && display_name == other.display_name && description == other.description && mod_security_rule_ids == other.mod_security_rule_ids && template == other.template && lifecycle_state == other.lifecycle_state && time_created == other.time_created && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 267 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
247 248 249 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 247 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
256 257 258 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 256 def hash [id, compartment_id, display_name, description, mod_security_rule_ids, template, lifecycle_state, time_created, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
300 301 302 303 304 305 306 307 308 309 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 300 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
294 295 296 |
# File 'lib/oci/waas/models/custom_protection_rule.rb', line 294 def to_s to_hash.to_s end |