Class: OCI::Waas::Models::JsChallenge

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

Overview

The JavaScript challenge settings. JavaScript Challenge is the function to filter abnormal or malicious bots and allow access to real clients.

Constant Summary collapse

ACTION_ENUM =
[
  ACTION_DETECT = 'DETECT'.freeze,
  ACTION_BLOCK = 'BLOCK'.freeze,
  ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JsChallenge

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



101
102
103
104
105
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/oci/waas/models/js_challenge.rb', line 101

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

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

  self.failure_threshold = attributes[:'failureThreshold'] if attributes[:'failureThreshold']

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

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

  self.action_expiration_in_seconds = attributes[:'actionExpirationInSeconds'] if attributes[:'actionExpirationInSeconds']

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

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

  self.set_http_header = attributes[:'setHttpHeader'] if attributes[:'setHttpHeader']

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

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

  self.challenge_settings = attributes[:'challengeSettings'] if attributes[:'challengeSettings']

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

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

  self.are_redirects_challenged = attributes[:'areRedirectsChallenged'] unless attributes[:'areRedirectsChallenged'].nil?
  self.are_redirects_challenged = true if are_redirects_challenged.nil? && !attributes.key?(:'areRedirectsChallenged') # rubocop:disable Style/StringLiterals

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

  self.are_redirects_challenged = attributes[:'are_redirects_challenged'] unless attributes[:'are_redirects_challenged'].nil?
  self.are_redirects_challenged = true if are_redirects_challenged.nil? && !attributes.key?(:'areRedirectsChallenged') && !attributes.key?(:'are_redirects_challenged') # rubocop:disable Style/StringLiterals

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

  self.is_nat_enabled = attributes[:'isNatEnabled'] unless attributes[:'isNatEnabled'].nil?
  self.is_nat_enabled = true if is_nat_enabled.nil? && !attributes.key?(:'isNatEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_nat_enabled = attributes[:'is_nat_enabled'] unless attributes[:'is_nat_enabled'].nil?
  self.is_nat_enabled = true if is_nat_enabled.nil? && !attributes.key?(:'isNatEnabled') && !attributes.key?(:'is_nat_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#actionString

The action to take against requests from detected bots. If unspecified, defaults to DETECT.

Returns:

  • (String)


23
24
25
# File 'lib/oci/waas/models/js_challenge.rb', line 23

def action
  @action
end

#action_expiration_in_secondsInteger

The number of seconds between challenges from the same IP address. If unspecified, defaults to 60.

Returns:

  • (Integer)


31
32
33
# File 'lib/oci/waas/models/js_challenge.rb', line 31

def action_expiration_in_seconds
  @action_expiration_in_seconds
end

#are_redirects_challengedBOOLEAN

When enabled, redirect responses from the origin will also be challenged. This will change HTTP 301/302 responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection.

Returns:

  • (BOOLEAN)


42
43
44
# File 'lib/oci/waas/models/js_challenge.rb', line 42

def are_redirects_challenged
  @are_redirects_challenged
end

#challenge_settingsOCI::Waas::Models::BlockChallengeSettings



38
39
40
# File 'lib/oci/waas/models/js_challenge.rb', line 38

def challenge_settings
  @challenge_settings
end

#criteriaArray<OCI::Waas::Models::AccessRuleCriteria>

When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.



46
47
48
# File 'lib/oci/waas/models/js_challenge.rb', line 46

def criteria
  @criteria
end

#failure_thresholdInteger

The number of failed requests before taking action. If unspecified, defaults to 10.

Returns:

  • (Integer)


27
28
29
# File 'lib/oci/waas/models/js_challenge.rb', line 27

def failure_threshold
  @failure_threshold
end

#is_enabledBOOLEAN

[Required] Enables or disables the JavaScript challenge Web Application Firewall feature.

Returns:

  • (BOOLEAN)


19
20
21
# File 'lib/oci/waas/models/js_challenge.rb', line 19

def is_enabled
  @is_enabled
end

#is_nat_enabledBOOLEAN

When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.

Returns:

  • (BOOLEAN)


50
51
52
# File 'lib/oci/waas/models/js_challenge.rb', line 50

def is_nat_enabled
  @is_nat_enabled
end

#set_http_headerOCI::Waas::Models::Header

Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action is set to DETECT.



35
36
37
# File 'lib/oci/waas/models/js_challenge.rb', line 35

def set_http_header
  @set_http_header
end

Class Method Details

.attribute_mapObject

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/waas/models/js_challenge.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'action': :'action',
    'failure_threshold': :'failureThreshold',
    'action_expiration_in_seconds': :'actionExpirationInSeconds',
    'set_http_header': :'setHttpHeader',
    'challenge_settings': :'challengeSettings',
    'are_redirects_challenged': :'areRedirectsChallenged',
    'criteria': :'criteria',
    'is_nat_enabled': :'isNatEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/oci/waas/models/js_challenge.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'action': :'String',
    'failure_threshold': :'Integer',
    'action_expiration_in_seconds': :'Integer',
    'set_http_header': :'OCI::Waas::Models::Header',
    'challenge_settings': :'OCI::Waas::Models::BlockChallengeSettings',
    'are_redirects_challenged': :'BOOLEAN',
    'criteria': :'Array<OCI::Waas::Models::AccessRuleCriteria>',
    'is_nat_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/oci/waas/models/js_challenge.rb', line 178

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    action == other.action &&
    failure_threshold == other.failure_threshold &&
    action_expiration_in_seconds == other.action_expiration_in_seconds &&
    set_http_header == other.set_http_header &&
    challenge_settings == other.challenge_settings &&
    are_redirects_challenged == other.are_redirects_challenged &&
    criteria == other.criteria &&
    is_nat_enabled == other.is_nat_enabled
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
# File 'lib/oci/waas/models/js_challenge.rb', line 216

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

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
# File 'lib/oci/waas/models/js_challenge.rb', line 196

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



205
206
207
# File 'lib/oci/waas/models/js_challenge.rb', line 205

def hash
  [is_enabled, action, failure_threshold, action_expiration_in_seconds, set_http_header, challenge_settings, are_redirects_challenged, criteria, is_nat_enabled].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



249
250
251
252
253
254
255
256
257
258
# File 'lib/oci/waas/models/js_challenge.rb', line 249

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



243
244
245
# File 'lib/oci/waas/models/js_challenge.rb', line 243

def to_s
  to_hash.to_s
end