Class: Mihari::Emitters::TheHive

Inherits:
Base
  • Object
show all
Defined in:
lib/mihari/emitters/the_hive.rb

Constant Summary

Constants included from Concerns::Retriable

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

Instance Attribute Summary collapse

Attributes inherited from Base

#rule

Attributes inherited from Actor

#options

Instance Method Summary collapse

Methods inherited from Base

inherited, #parallel?, #result

Methods inherited from Actor

configuration_keys, 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?

Constructor Details

#initialize(rule:, options: nil, **params) ⇒ TheHive

Returns a new instance of TheHive.

Parameters:

  • rule (Mihari::Rule)
  • options (Hash, nil) (defaults to: nil)
  • params (Hash) 


23
24
25
26
27
28
29
30
31
 
# File 'lib/mihari/emitters/the_hive.rb', line 23

def initialize(rule:, options: nil, **params)
  super(rule:, options:)

  @url = params[:url] || Mihari.config.thehive_url
  @api_key = params[:api_key] || Mihari.config.thehive_api_key
  @observable_tags = params[:observable_tags] || []

  @artifacts = []
end

Instance Attribute Details

#api_key ⇒ String? (readonly)

Returns:

  • (String, nil) 


10
11
12
 
# File 'lib/mihari/emitters/the_hive.rb', line 10

def api_key
  @api_key
end

#artifacts ⇒ Array<Mihari::Models::Artifact>

Returns:



16
17
18
 
# File 'lib/mihari/emitters/the_hive.rb', line 16

def artifacts
  @artifacts
end

#observable_tags ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


13
14
15
 
# File 'lib/mihari/emitters/the_hive.rb', line 13

def observable_tags
  @observable_tags
end

#url ⇒ String? (readonly)

Returns:

  • (String, nil) 


7
8
9
 
# File 'lib/mihari/emitters/the_hive.rb', line 7

def url
  @url
end

Instance Method Details

#call(artifacts) ⇒ Object

Create a Hive alert

Parameters:



52
53
54
55
56
57
58
 
# File 'lib/mihari/emitters/the_hive.rb', line 52

def call(artifacts)
  return if artifacts.empty?

  @artifacts = artifacts

  client.alert payload
end

#configured? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/mihari/emitters/the_hive.rb', line 36

def configured?
  api_key? && url?
end

#target ⇒ String

Returns:

  • (String) 


43
44
45
 
# File 'lib/mihari/emitters/the_hive.rb', line 43

def target
  URI(url).host || "N/A"
end