Class: OCI::Waas::Models::UpdateCustomProtectionRuleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/update_custom_protection_rule_details.rb

Overview

Updates the configuration details of a custom protection rule. Custom protection rules can only be updated if they are not active in a WAAS policy. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateCustomProtectionRuleDetails

Initializes the object

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :template (String) —

    The value to assign to the #template property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 106

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.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.template = attributes[:'template'] if attributes[:'template']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`



67
68
69
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 67

def defined_tags
  @defined_tags
end

#description ⇒ String

A description for the custom protection rule.



16
17
18
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 16

def description
  @description
end

#display_name ⇒ String

A user-friendly name for the custom protection rule.



12
13
14
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 12

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`



59
60
61
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 59

def freeform_tags
  @freeform_tags
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](docs.cloud.oracle.com/Content/WAF/tasks/customprotectionrules.htm).

For more information about ModSecurity syntax, see [Making Rules: The Basic Syntax](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](www.modsecurity.org/CRS/Documentation/index.html).



51
52
53
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 51

def template
  @template
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 70

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'template': :'template',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 83

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'template': :'String',
    '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.



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 142

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    template == other.template &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 176

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

See Also:

  • `==` method


156
157
158
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



165
166
167
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 165

def hash
  [display_name, description, template, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 209

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



203
204
205
 
# File 'lib/oci/waas/models/update_custom_protection_rule_details.rb', line 203

def to_s
  to_hash.to_s
end