Class: OTX::IP

Inherits:
Base
  • Object
show all
Defined in:
lib/otx_ruby/ip.rb

Instance Method Summary collapse

Methods inherited from Base

#get, #initialize, #patch, #post

Constructor Details

This class inherits a constructor from OTX::Base

Instance Method Details

#get_general(ip, type = :ipv4) ⇒ Object 



3
4
5
6
7
8
9
10
11
 
# File 'lib/otx_ruby/ip.rb', line 3

def get_general(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/general"

  json_data = get(uri)

  general = OTX::Indicator::IP::General.new(json_data)

  return general
end

#get_geo(ip, type = :ipv4) ⇒ Object 



25
26
27
28
29
30
31
32
33
 
# File 'lib/otx_ruby/ip.rb', line 25

def get_geo(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/geo"

  json_data = get(uri)

  geo = OTX::Indicator::IP::Geo.new(json_data)

  return geo
end

#get_http_scans(ip, type = :ipv4) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/otx_ruby/ip.rb', line 92

def get_http_scans(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/http_scans"

  json_data = get(uri)

  results = []
  json_data['data'].each do |http_scan|
    results << OTX::Indicator::IP::HTTPScan.new(http_scan)
  end

  return results
end

#get_malware(ip, type = :ipv4) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/otx_ruby/ip.rb', line 35

def get_malware(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/malware"
  malwares = []
  params = {}

  begin
    json_data = get(uri, params)
    page = json_data['next']

    params = URI::decode_www_form(URI(page).query).to_h unless page.nil?

    malwares += json_data['data']
  end while page && !json_data['data'].empty?

  results = []
  malwares.each do |malware|
    results << OTX::Indicator::IP::Malware.new(malware)
  end

  return results
end

#get_nids_list(ip, type = :ipv4) ⇒ Object

NIDS rules associated with an IP

Parameters:

  • ip (String) —

    IP Address for lookup

  • type (String) (defaults to: :ipv4) —

    Format of IP Address e.g ‘IPv4’, ‘IPv6’

Returns:

  • (Object) —

    Object created from NIDS list json data



112
113
114
115
116
117
118
119
120
 
# File 'lib/otx_ruby/ip.rb', line 112

def get_nids_list(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/nids_list"

  json_data = get(uri)

  nids_list = OTX::Indicator::IP::NidsList.new(json_data)

  return nids_list
end

#get_passive_dns(ip, type = :ipv4) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/otx_ruby/ip.rb', line 79

def get_passive_dns(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/passive_dns"

  json_data = get(uri)

  results = []
  json_data['passive_dns'].each do |dns|
    results << OTX::Indicator::IP::DNS.new(dns)
  end

  return results
end

#get_reputation(ip, type = :ipv4) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/otx_ruby/ip.rb', line 13

def get_reputation(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/reputation"

  json_data = get(uri)

  if json_data['reputation']
    reputation = OTX::Indicator::IP::Reputation.new(json_data["reputation"])
  end

  return reputation
end

#get_url_list(ip, type = :ipv4) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/otx_ruby/ip.rb', line 57

def get_url_list(ip, type = :ipv4)
  uri = "/api/v1/indicators/#{type == :ipv6 ? 'IPv6' : 'IPv4'}/#{ip}/url_list"

  page = 0
  url_list = []
  begin
    page += 1
    params = {limit: 20, page: page}
    json_data = get(uri, params)
    has_next = json_data['has_next']

    url_list += json_data['url_list']
  end while has_next

  results = []
  url_list.each do |url|
    results << OTX::Indicator::IP::URL.new(url)
  end

  return results
end