-
Notifications
You must be signed in to change notification settings - Fork 17
/
ip2trace.py
473 lines (438 loc) · 21.4 KB
/
ip2trace.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
from __future__ import print_function
import socket
import struct
import os
import platform
import time
import sys
import select
import argparse
import IP2Location
from random import choices
from re import match
from shutil import copyfile
ICMP_ECHO = 8
ICMP_V6_ECHO = 128
ICMP_ECHO_REPLY = 0
ICMP_V6_ECHO_REPLY = 129
ICMP_TIME_EXCEEDED = 11
ip2location_result_fields = ['country_short', 'country_long', 'region', 'city', 'isp', 'latitude', 'longitude', 'domain', 'zipcode', 'timezone', 'netspeed', 'idd_code', 'area_code', 'weather_code', 'weather_name', 'mcc', 'mnc', 'mobile_brand', 'elevation', 'usage_type', 'address_type', 'category', 'district', 'asn', 'as_name', ]
ip2location_outputs_reference = ['country_code', 'country_name', 'region_name', 'city_name', 'isp', 'latitude', 'longitude', 'domain', 'zip_code', 'time_zone', 'net_speed', 'idd_code', 'area_code', 'weather_station_code', 'weather_station_name', 'mcc', 'mnc', 'mobile_brand', 'elevation', 'usage_type', 'address_type', 'category', 'district', 'asn', 'as_name', ]
if platform.system() == 'Windows':
# Windows IPv6 compatibility
socket.IPPROTO_IPV6 = 41
socket.IPPROTO_ICMPV6 = 58
MIN_SLEEP = 500
# Define BIN database default path
default_path = os.path.expanduser('~') + os.sep + "Documents" + os.sep
else:
MIN_SLEEP = 100
# Define BIN database default path
default_path = '/usr/local/share/ip2location/'
# default_path = '/usr/share/ip2location/'
# Now we copy the BIN database to default_path here instead of doing it duing installation as pip kept copied to wrong location.
if (os.path.isfile(default_path + "IP2LOCATION-LITE-DB1.IPV6.BIN") == False):
try:
# create the dir is not exist
if (os.path.exists(default_path) is False):
os.mkdir(default_path)
copyfile(os.path.dirname(os.path.realpath(__file__)) + os.sep + "data" + os.sep + "IP2LOCATION-LITE-DB1.IPV6.BIN", default_path + "IP2LOCATION-LITE-DB1.IPV6.BIN")
except PermissionError as e:
sys.exit("Root permission is required. Please rerun it as 'sudo ip2tracepy' in Linux, or obtain administrator permission in Windows.")
if sys.platform.startswith('win32'):
# timer = time.clock
if sys.version_info > (3,2):
timer = time.perf_counter
else:
timer = time.clock
else:
timer = time.time
def calculate_checksum(packet):
countTo = (len(packet) // 2) * 2
count = 0
sum = 0
while count < countTo:
if sys.byteorder == "little":
loByte = packet[count]
hiByte = packet[count + 1]
else:
loByte = packet[count + 1]
hiByte = packet[count]
sum = sum + (hiByte * 256 + loByte)
count += 2
if countTo < len(packet):
sum += packet[count]
sum = (sum >> 16) + (sum & 0xffff)
sum += (sum >> 16)
answer = ~sum & 0xffff
answer = socket.htons(answer)
return answer
def is_ipv4(hostname):
pattern = r'^([0-9]{1,3}[.]){3}[0-9]{1,3}$'
if match(pattern, hostname) is not None:
return 4
return False
def is_ipv6(hostname):
if ':' in hostname:
return 6
return False
def is_valid_ip(hostname):
if is_ipv4(hostname) is not False or is_ipv6(hostname) is not False:
return True
else:
return False
def to_ip(hostname):
if is_valid_ip(hostname):
return hostname
return socket.gethostbyname(hostname)
def ip_to_domain_name(hostname):
if is_valid_ip(hostname):
# return socket.gethostbyaddr(hostname)
try:
return socket.gethostbyaddr(hostname)
except socket.herror:
# return hostname
return None
# return hostname
return None
def create_parser():
parser = argparse.ArgumentParser()
# parser.add_argument('-p', '--ip', metavar='Specify an IP address or hostname.')
gp = parser.add_mutually_exclusive_group()
gp.add_argument('-p', '--ip', metavar='Specify an IP address or hostname.')
gp.add_argument('hostname', nargs='?', metavar='Specify an IP address or hostname.')
parser.add_argument('-d', '--database', metavar='Specify the path of IP2Location BIN database file.')
parser.add_argument('-t', '--ttl', default=30, type=int, metavar='Set the max number of hops. (Default: 30)')
parser.add_argument('-o', '--output', metavar='Specify the result columns to be output.', nargs='+')
parser.add_argument('-a', '--all', action='store_true')
return parser
def print_usage():
print(
"Usage: ip2tracepy -p [IP ADDRESS/HOSTNAME] -d [IP2LOCATION BIN DATA PATH] [OPTIONS]\n"
" or: ip2tracepy [IP ADDRESS/HOSTNAME] -d [IP2LOCATION BIN DATA PATH] [OPTIONS]\n\n"
" -p, --ip\n"
" Specify an IP address or hostname.\n"
" The -p/--ip can be omitted if the IP address or hostname is defined in the first parameter.\n"
"\n"
" -d, --database\n"
" Specify the path of IP2Location BIN database file. You can download the latest free IP2Location BIN database from https://lite.ip2location.com.\n"
" If the database filename is specified but without the path, ip2tracepy will search the database file in /usr/share/ip2location/ for Linux or C:\\Users\\(your_Windows_username)\\Documents\\ for Windows.\n"
"\n"
" -t, --ttl\n"
" Set the max number of hops. (Default: 30)\n"
"\n"
" -o, --output\n"
" Set the desired IP2Location BIN database columns to output with.\n"
" Available columns are: country_code, country_name, region_name, city_name, isp, latitude, longitude, domain, zip_code, time_zone, net_speed, idd_code, area_code, weather_station_code, weather_station_name, mcc, mnc, mobile_brand, elevation, usage_type, address_type, category, district, asn, as_name.\n"
"\n"
" -a, --all\n"
"Print all the column(s) available based on the BIN file used.\n"
"\n"
" -h, -?, --help\n"
" Display this guide.\n"
"\n"
" -v, --version\n"
" Print the version of the IP2Location version.\n")
def print_version():
print(
"IP2Location Geolocation Traceroute (ip2trace) Version 3.2.1\n"
"Copyright (c) 2021 - 2024 IP2Location.com [MIT License]\n"
"https://www.ip2location.com/free/traceroute-application\n")
def traceroute(destination_server, database, ttl, output, all):
t = Traceroute(destination_server, database, ttl, output, all)
t.start_traceroute()
class Traceroute:
def __init__(self, destination_server, database, max_hops, output, all):
self.destination_server = destination_server
self.database = database
self.max_hops = max_hops
self.output = output
self.identifier = os.getpid() & 0xffff
self.seq_no = 0
self.delays = []
self.prev_sender_hostname = ""
self.all = all
self.family = None
self.count_of_packets = 1
self.packet_size = 80
# self.timeout = 1000
self.timeout = 500
self.ttl = 1
if (destination_server is None):
print ("Missing IP address or hostname.")
sys.exit()
try:
self.destination_ip = to_ip(destination_server)
self.destination_domain_name = ip_to_domain_name(destination_server)
except socket.gaierror:
self.print_unknownhost()
sys.exit()
# Open up IP2Location BIN file
if (database is not None):
if os.path.isfile(database) == False:
# Now will check if the filename passed is a BIN extension or not
if database.upper().endswith(".BIN"):
# check if the given filename is under current dir or not.
if (os.getcwd().endswith(os.sep)):
filepath = os.getcwd() + database
else:
filepath = os.getcwd() + os.sep + database
# print(filepath)
if os.path.isfile(filepath) == False:
if os.path.isfile(default_path + database) == False:
print("BIN database file not found.")
sys.exit()
else:
self.obj = IP2Location.IP2Location(default_path + database)
else:
self.obj = IP2Location.IP2Location(filepath)
else:
print("Only BIN database is accepted. You can download the latest free IP2Location BIN database from https://lite.ip2location.com.")
sys.exit()
else:
self.obj = IP2Location.IP2Location(database)
else:
if (os.path.isfile(default_path + "IP2LOCATION-LITE-DB1.IPV6.BIN") != False):
self.obj = IP2Location.IP2Location(default_path + "IP2LOCATION-LITE-DB1.IPV6.BIN")
else:
print("Missing IP2Location BIN database. Please enter 'ip2trace -h' for more information.")
sys.exit()
# check the output list
if (self.output is not None):
for i in self.output:
if i not in ip2location_outputs_reference:
print("The column name is invalid. Please get a list of valid column names at https://www.ip2location.com/database/db26-ip-country-region-city-latitude-longitude-zipcode-timezone-isp-domain-netspeed-areacode-weather-mobile-elevation-usagetype-addresstype-category-district-asn.")
sys.exit()
def print_start(self):
print("IP2Location Geolocation Traceroute (ip2trace) Version 3.2.0\n"
"Copyright (c) 2021 - 2024 IP2Location.com [MIT License]\n"
"https://www.ip2location.com/free/traceroute-application\n\n")
if self.destination_domain_name is not None:
print("Traceroute to", self.destination_domain_name[0], "(", self.destination_ip, ")\n\n", end="")
else:
print("Traceroute to", self.destination_ip, "\n\n", end="")
def print_unknownhost(self):
print("traceroute: unknown host {}".format(self.destination_server))
def print_timeout(self):
if self.seq_no == 1:
if self.ttl < 10:
print(" {} ".format(self.ttl), end="")
else:
print("{} ".format(self.ttl), end="")
print("* ", end="")
if self.seq_no == self.count_of_packets:
print()
# def print_trace(self, delay, ip_header):
def print_trace(self, delays, ip_header):
total_delays = 0
ip = socket.inet_ntoa(struct.pack('!I', ip_header['Source_IP']))
try:
sender_hostname = socket.gethostbyaddr(ip)[0]
except socket.herror:
sender_hostname = ip
if self.prev_sender_hostname != sender_hostname:
record = None
if is_valid_ip(ip):
record = self.obj.get_all(ip)
if record is None:
if self.ttl < 10:
# print(" {} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
print(" {} {} ".format(self.ttl, ip), end="")
for i in range(0, len(delays)):
total_delays = total_delays + delays[i]
print("{:.3f}ms ".format(delays[i]), end="")
else:
# print("{} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
# print("{} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
print("{} {} ".format(self.ttl, ip), end="")
for i in range(0, len(delays)):
total_delays = total_delays + delays[i]
print("{:.3f}ms ".format(delays[i]), end="")
else:
if self.ttl < 10:
# print(" {} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
# print(" {} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
print(" {} {} ".format(self.ttl, ip), end="")
for i in range(0, len(delays)):
total_delays = total_delays + delays[i]
print("{:.3f}ms ".format(delays[i]), end="")
else:
# print("{} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
# print("{} {} {:.3f}ms ".format(self.ttl, ip, delay), end="")
print("{} {} ".format(self.ttl, ip), end="")
for i in range(0, len(delays)):
total_delays = total_delays + delays[i]
print("{:.3f}ms ".format(delays[i]), end="")
display_result = '['
record_dict = {}
for attr, value in record.__dict__.items():
record_dict[attr] = value
if (self.output is not None):
for i in self.output:
if (i in ip2location_outputs_reference) and (ip2location_result_fields[ip2location_outputs_reference.index(i)] in record_dict) and (record_dict[ip2location_result_fields[ip2location_outputs_reference.index(i)]] is not None):
display_result = display_result + '"' + str(record_dict[ip2location_result_fields[ip2location_outputs_reference.index(i)]]) + '",'
else:
if (self.all is False) :
if "region" in record_dict:
display_result = display_result + '"' + str(record_dict["country_short"]) + '","' + str(record_dict["region"]) + '","' + str(record_dict["city"]) + '"'
else:
display_result = display_result + '"' + str(record_dict["country_short"]) + '"'
else :
for i in range(0,len(ip2location_result_fields)):
if (ip2location_result_fields[i] in record_dict) and (record_dict[ip2location_result_fields[i]] is not None):
display_result = display_result + '"' + str(record_dict[ip2location_result_fields[i]]) + '",'
if display_result.endswith(','):
display_result = display_result[:-1]
display_result = display_result + ']'
print("{}".format(display_result), end="")
self.prev_sender_hostname = sender_hostname
else:
print("{:.3f} ms ".format(delay), end="")
if self.seq_no == self.count_of_packets:
print()
self.prev_sender_hostname = ""
average_delays = total_delays / len(delays)
if MIN_SLEEP > average_delays:
time.sleep((MIN_SLEEP - average_delays) / 1000)
def header_to_dict(self, keys, packet, struct_format):
values = struct.unpack(struct_format, packet)
return dict(zip(keys, values))
def start_traceroute(self):
icmp_header = None
while self.ttl <= self.max_hops:
self.seq_no = 0
try:
for i in range(self.count_of_packets):
icmp_header = self.tracer()
except KeyboardInterrupt: # handles Ctrl+C
break
self.ttl += 1
if icmp_header is not None:
if is_ipv4(self.destination_ip) == 4 and icmp_header['type'] == ICMP_ECHO_REPLY:
break
elif is_ipv6(self.destination_ip) == 6 and icmp_header['type'] == ICMP_V6_ECHO_REPLY:
break
def tracer(self):
self.seq_no += 1
if self.ttl == 1 and self.seq_no == 1:
self.print_start()
delays = []
for i in range (0, 3):
try:
if is_ipv4(self.destination_ip) == 4:
self.family = socket.AF_INET
icmp_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_ICMP)
icmp_socket.setsockopt(socket.IPPROTO_IP, socket.IP_TTL, self.ttl)
elif is_ipv6(self.destination_ip) == 6:
self.family = socket.AF_INET6
icmp_socket = socket.socket(socket.AF_INET6, socket.SOCK_RAW, socket.IPPROTO_ICMPV6)
icmp_socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_UNICAST_HOPS, self.ttl)
if platform.system() == 'Linux':
icmp_socket.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_TCLASS, 0)
except socket.error as err:
if err.errno == 1:
print("Operation not permitted: ICMP messages can only be sent from a process running as root")
else:
print("Socket Error1: {}".format(err))
sys.exit()
sent_time = self.send_icmp_echo(icmp_socket)
if sent_time is None:
return
receive_time, icmp_header, ip_header = self.receive_icmp_reply(icmp_socket)
icmp_socket.close()
if receive_time:
delay = (receive_time - sent_time) * 1000.0
delays.append(delay)
time.sleep(0.005)
if len(delays) > 0 and ip_header is not None:
self.print_trace(delays, ip_header)
else:
self.print_timeout()
return icmp_header
def random_byte_message(self, size):
'''
Generate a random byte sequence of the specified size.
'''
sequence = choices(
b'abcdefghijklmnopqrstuvwxyz'
b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
b'1234567890', k=size)
return bytearray(sequence)
def send_icmp_echo(self, icmp_socket):
start_value = 65
payload = []
if is_ipv4(self.destination_ip) == 4:
header = struct.pack("!BBHHH", ICMP_ECHO, 0, 0, self.identifier, self.seq_no)
# header = struct.pack("!2B3H", ICMP_ECHO, 0, 0, self.identifier, self.seq_no)
for i in range(start_value, start_value+self.packet_size):
payload.append(i & 0xff)
data = bytearray(payload)
elif is_ipv6(self.destination_ip) == 6:
header = struct.pack("!BBHHH", ICMP_V6_ECHO, 0, 0, self.identifier, self.seq_no)
# header = struct.pack("!2B3H", ICMP_V6_ECHO, 0, 0, self.identifier, self.seq_no)
data = self.random_byte_message(56)
checksum = calculate_checksum(header + data)
if is_ipv4(self.destination_ip) == 4:
header = struct.pack("!BBHHH", ICMP_ECHO, 0, checksum, self.identifier, self.seq_no)
# header = struct.pack("!2B3H", ICMP_ECHO, 0, checksum, self.identifier, self.seq_no)
elif is_ipv6(self.destination_ip) == 6:
header = struct.pack("!BBHHH", ICMP_V6_ECHO, 0, checksum, self.identifier, self.seq_no)
# header = struct.pack("!2B3H", ICMP_V6_ECHO, 0, checksum, self.identifier, self.seq_no)
packet = header + data
send_time = timer()
try:
# icmp_socket.sendto(packet, (self.destination_ip, 0))
icmp_socket.sendto(packet, ((socket.getaddrinfo(host=self.destination_ip,port=None,family=self.family,type=socket.SOCK_RAW)[0][4])))
except socket.error as err:
print("Socket Error2: %s", err)
icmp_socket.close()
return
return send_time
def receive_icmp_reply(self, icmp_socket):
timeout = self.timeout / 1000
time_limit = timer() + timeout
while True:
inputReady, _, _ = select.select([icmp_socket], [], [], timeout)
receive_time = timer()
if receive_time > time_limit: # timeout
# self.print_timeout()
return None, None, None
packet_data, address = icmp_socket.recvfrom(1024)
icmp_keys = ['type', 'code', 'checksum', 'identifier', 'sequence number']
icmp_header = self.header_to_dict(icmp_keys, packet_data[20:28], "!BBHHH")
ip_keys = ['VersionIHL', 'Type_of_Service', 'Total_Length', 'Identification', 'Flags_FragOffset', 'TTL', 'Protocol', 'Header_Checksum', 'Source_IP', 'Destination_IP']
ip_header = self.header_to_dict(ip_keys, packet_data[:20], "!BBHHHBBHII")
# print ("Source_IP1", ip_header['Source_IP'])
return receive_time, icmp_header, ip_header
# if __name__ == '__main__':
def main():
is_help = False
# print(sys.argv)
if len(sys.argv) >= 2:
for index, arg in enumerate(sys.argv):
if arg in ['--help', '-h', '-?']:
print_usage()
is_help = True
elif arg in ['--version', '-v']:
print_version()
is_help = True
if is_help is False:
parser = create_parser()
args = parser.parse_args(sys.argv[1:])
# destination_server = args.ip
if args.ip is not None:
destination_server = args.ip
else:
destination_server = args.hostname
if args.all is not None:
all = args.all
else:
all = False
database = args.database
max_hops = args.ttl
output = args.output
# print(all)
# sys.exit()
traceroute(destination_server, database, max_hops, output, all)
else:
print("Missing parameters. Please enter 'ip2trace -h' for more information.")