WafLog

class oci.waas.models.WafLog(**kwargs)

Bases: object

A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode. For more information about WAF logs, see WAF Logs.

__init__(**kwargs)

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

Parameters:
  • action (str) -- The value to assign to the action property of this WafLog.
  • captcha_action (str) -- The value to assign to the captcha_action property of this WafLog.
  • captcha_expected (str) -- The value to assign to the captcha_expected property of this WafLog.
  • captcha_received (str) -- The value to assign to the captcha_received property of this WafLog.
  • captcha_fail_count (str) -- The value to assign to the captcha_fail_count property of this WafLog.
  • client_address (str) -- The value to assign to the client_address property of this WafLog.
  • country_name (str) -- The value to assign to the country_name property of this WafLog.
  • user_agent (str) -- The value to assign to the user_agent property of this WafLog.
  • domain (str) -- The value to assign to the domain property of this WafLog.
  • protection_rule_detections (dict(str, str)) -- The value to assign to the protection_rule_detections property of this WafLog.
  • http_method (str) -- The value to assign to the http_method property of this WafLog.
  • request_url (str) -- The value to assign to the request_url property of this WafLog.
  • http_headers (dict(str, str)) -- The value to assign to the http_headers property of this WafLog.
  • referrer (str) -- The value to assign to the referrer property of this WafLog.
  • response_code (int) -- The value to assign to the response_code property of this WafLog.
  • response_size (int) -- The value to assign to the response_size property of this WafLog.
  • incident_key (str) -- The value to assign to the incident_key property of this WafLog.
  • fingerprint (str) -- The value to assign to the fingerprint property of this WafLog.
  • device (str) -- The value to assign to the device property of this WafLog.
  • country_code (str) -- The value to assign to the country_code property of this WafLog.
  • request_headers (dict(str, str)) -- The value to assign to the request_headers property of this WafLog.
  • threat_feed_key (str) -- The value to assign to the threat_feed_key property of this WafLog.
  • access_rule_key (str) -- The value to assign to the access_rule_key property of this WafLog.
  • address_rate_limiting_key (str) -- The value to assign to the address_rate_limiting_key property of this WafLog.
  • timestamp (datetime) -- The value to assign to the timestamp property of this WafLog.
  • log_type (str) -- The value to assign to the log_type property of this WafLog.
  • origin_address (str) -- The value to assign to the origin_address property of this WafLog.
  • origin_response_time (str) -- The value to assign to the origin_response_time property of this WafLog.
access_rule_key

Gets the access_rule_key of this WafLog. The AccessRule key that matched the request. For more information about access rules, see UpdateAccessRules.

Returns:The access_rule_key of this WafLog.
Return type:str
action

Gets the action of this WafLog. The action taken on the request, either ALLOW, DETECT, or BLOCK.

Returns:The action of this WafLog.
Return type:str
address_rate_limiting_key

Gets the address_rate_limiting_key of this WafLog. The AddressRateLimiting key that matched the request. For more information about address rate limiting, see UpdateWafAddressRateLimiting.

Returns:The address_rate_limiting_key of this WafLog.
Return type:str
captcha_action

Gets the captcha_action of this WafLog. The CAPTCHA action taken on the request, ALLOW or BLOCK. For more information about CAPTCHAs, see UpdateCaptchas.

Returns:The captcha_action of this WafLog.
Return type:str
captcha_expected

Gets the captcha_expected of this WafLog. The CAPTCHA challenge answer that was expected.

Returns:The captcha_expected of this WafLog.
Return type:str
captcha_fail_count

Gets the captcha_fail_count of this WafLog. The number of times the CAPTCHA challenge was failed.

Returns:The captcha_fail_count of this WafLog.
Return type:str
captcha_received

Gets the captcha_received of this WafLog. The CAPTCHA challenge answer that was received.

Returns:The captcha_received of this WafLog.
Return type:str
client_address

Gets the client_address of this WafLog. The IPv4 address of the requesting client.

Returns:The client_address of this WafLog.
Return type:str
country_code

Gets the country_code of this WafLog. ISO 3166-1 alpha-2 code of the country from which the request originated. For a list of codes, see ISO's website.

Returns:The country_code of this WafLog.
Return type:str
country_name

Gets the country_name of this WafLog. The name of the country where the request originated.

Returns:The country_name of this WafLog.
Return type:str
device

Gets the device of this WafLog. The type of device that the request was made from.

Returns:The device of this WafLog.
Return type:str
domain

Gets the domain of this WafLog. The Host header data of the request.

Returns:The domain of this WafLog.
Return type:str
fingerprint

Gets the fingerprint of this WafLog. The hashed signature of the device's fingerprint. For more information, see DeviceFingerPrintChallenge.

Returns:The fingerprint of this WafLog.
Return type:str
http_headers

Gets the http_headers of this WafLog. The map of the request's header names to their respective values.

Returns:The http_headers of this WafLog.
Return type:dict(str, str)
http_method

Gets the http_method of this WafLog. The HTTP method of the request.

Returns:The http_method of this WafLog.
Return type:str
incident_key

Gets the incident_key of this WafLog. The incident key of a request. An incident key is generated for each request processed by the Web Application Firewall and is used to idenitfy blocked requests in applicable logs.

Returns:The incident_key of this WafLog.
Return type:str
log_type

Gets the log_type of this WafLog. The type of log of the request. For more about log types, see WAF Logs.

Returns:The log_type of this WafLog.
Return type:str
origin_address

Gets the origin_address of this WafLog. The address of the origin server where the request was sent.

Returns:The origin_address of this WafLog.
Return type:str
origin_response_time

Gets the origin_response_time of this WafLog. The amount of time it took the origin server to respond to the request, in seconds.

Returns:The origin_response_time of this WafLog.
Return type:str
protection_rule_detections

Gets the protection_rule_detections of this WafLog. A map of protection rule keys to detection message details. Detections are requests that matched the criteria of a protection rule but the rule's action was set to DETECT.

Returns:The protection_rule_detections of this WafLog.
Return type:dict(str, str)
referrer

Gets the referrer of this WafLog. The Referrer header value of the request.

Returns:The referrer of this WafLog.
Return type:str
request_headers

Gets the request_headers of this WafLog. A map of header names to values of the request sent to the origin, including any headers appended by the Web Application Firewall.

Returns:The request_headers of this WafLog.
Return type:dict(str, str)
request_url

Gets the request_url of this WafLog. The path and query string of the request.

Returns:The request_url of this WafLog.
Return type:str
response_code

Gets the response_code of this WafLog. The status code of the response.

Returns:The response_code of this WafLog.
Return type:int
response_size

Gets the response_size of this WafLog. The size in bytes of the response.

Returns:The response_size of this WafLog.
Return type:int
threat_feed_key

Gets the threat_feed_key of this WafLog. The ThreatFeed key that matched the request. For more information about threat feeds, see UpdateThreatFeeds.

Returns:The threat_feed_key of this WafLog.
Return type:str
timestamp

Gets the timestamp of this WafLog. The date and time the Web Application Firewall processed the request and logged it.

Returns:The timestamp of this WafLog.
Return type:datetime
user_agent

Gets the user_agent of this WafLog. The value of the request's User-Agent header field.

Returns:The user_agent of this WafLog.
Return type:str