Module: Falconz::APIs::Submission

Included in:
Client
Defined in:
lib/falconz/apis/submission.rb

Instance Method Summary collapse

Instance Method Details

#hash_for_url(url) ⇒ Hash

determine a SHA256 that an online file or URL submission will have when being processed by the system. Note: this is useful when looking up URL analysis

www.hybrid-analysis.com/docs/api/v2#/Submission/post_submit_hash_for_url

Parameters:

  • options (Hash)

Returns:

  • (Hash) 


65
66
67
 
# File 'lib/falconz/apis/submission.rb', line 65

def hash_for_url(url)
  post_request("/submit/hash-for-url", url: url)
end

#submit_dropped_file(**options) ⇒ Hash

submit dropped file for analysis

www.hybrid-analysis.com/docs/api/v2#/Submission/post_submit_dropped_file

Parameters:

  • options (Hash)

Returns:

  • (Hash) 


75
76
77
 
# File 'lib/falconz/apis/submission.rb', line 75

def submit_dropped_file(**options)
  post_request("/submit/dropped-file", options)
end

#submit_file(**options) ⇒ Hash

Submit a local file for analysis.

Example

response = client.submit_file(file: "/path/to/local/file", environment_id: 300)

# print job ID from response
puts response["job_id"]

www.hybrid-analysis.com/docs/api/v2#/Submission/post_submit_file

Parameters:

  • options (Hash) —

    the hashes to search for.

Returns:

  • (Hash) 


17
18
19
20
21
22
 
# File 'lib/falconz/apis/submission.rb', line 17

def submit_file(**options)
  options[:file] = File.open(options[:file], "r")
  response = post_request("/submit/file", options)
  options[:file].close
  return response
end

#submit_file_by_url(**options) ⇒ Hash

Submit a file by URL for analysis.

Example

response = client.submit_url(url: "www.malicious-google.com/malware.exe", environment_id: 100, no_share_third_party: true)

# print job ID from response
puts response["job_id"]

www.hybrid-analysis.com/docs/api/v2#/Submission/post_submit_url_to_file

Parameters:

  • options (Hash)

Returns:

  • (Hash) 


37
38
39
 
# File 'lib/falconz/apis/submission.rb', line 37

def submit_file_by_url(**options)
  post_request("/submit/url-to-file", options)
end

#submit_url(**options) ⇒ Hash

Submit a url for analysis.

Example

response = client.submit_url(url: "www.malicious-google.com", environment_id: 100, experimental_anti_evasion: true)

# print job ID from response
puts response["job_id"]

www.hybrid-analysis.com/docs/api/v2#/Submission/post_submit_url_for_analysis

Parameters:

  • options (Hash)

Returns:

  • (Hash) 


54
55
56
 
# File 'lib/falconz/apis/submission.rb', line 54

def submit_url(**options)
  post_request("/submit/url-for-analysis", options)
end