Class: Mihari::Analyzers::Urlscan

Inherits:
Base show all
Defined in:
lib/mihari/analyzers/urlscan.rb

Overview

urlscan.io analyzer

Constant Summary collapse

SUPPORTED_DATA_TYPES = 
%w[url domain ip].freeze

Constants included from Concerns::Retriable

Concerns::Retriable::DEFAULT_CONDITION, Concerns::Retriable::RETRIABLE_ERRORS

Instance Attribute Summary collapse

Attributes inherited from Base

#query

Attributes inherited from Mihari::Actor

#options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#call, from_query, #ignore_error?, inherited, #normalized_artifacts, #pagination_interval, #pagination_limit, #parallel?, #result, #truncated_query

Methods inherited from Mihari::Actor

#call, key, key_aliases, keys, #result, #retry_exponential_backoff, #retry_interval, #retry_times, #timeout, type, #validate_configuration!

Methods included from Concerns::Retriable

#retry_on_error

Methods included from Concerns::Configurable

#configuration_keys?, #configured?

Constructor Details

#initialize(query, options: nil, api_key: nil, allowed_data_types: SUPPORTED_DATA_TYPES) ⇒ Urlscan

Returns a new instance of Urlscan.

Parameters:

  • query (String)
  • options (Hash, nil) (defaults to: nil)
  • api_key (String, nil) (defaults to: nil)
  • allowed_data_types (Array<String>) (defaults to: SUPPORTED_DATA_TYPES)

Raises:



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/mihari/analyzers/urlscan.rb', line 23

def initialize(query, options: nil, api_key: nil, allowed_data_types: SUPPORTED_DATA_TYPES)
  super(query, options: options)

  @api_key = api_key || Mihari.config.urlscan_api_key
  @allowed_data_types = allowed_data_types

  return if valid_allowed_data_types?

  raise ValueError, "allowed_data_types should be any of url, domain and ip."
end

Instance Attribute Details

#allowed_data_types ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


15
16
17
 
# File 'lib/mihari/analyzers/urlscan.rb', line 15

def allowed_data_types
  @allowed_data_types
end

#api_key ⇒ String? (readonly)

Returns:

  • (String, nil) 


12
13
14
 
# File 'lib/mihari/analyzers/urlscan.rb', line 12

def api_key
  @api_key
end

Class Method Details

.configuration_keys ⇒ Object 



41
42
43
 
# File 'lib/mihari/analyzers/urlscan.rb', line 41

def configuration_keys
  %w[urlscan_api_key]
end

Instance Method Details

#artifacts ⇒ Object 



34
35
36
37
38
 
# File 'lib/mihari/analyzers/urlscan.rb', line 34

def artifacts
  # @type [Array<Mihari::Models::Artifact>]
  artifacts = client.search_with_pagination(query, pagination_limit: pagination_limit).map(&:artifacts).flatten
  artifacts.select { |artifact| allowed_data_types.include? artifact.data_type }
end