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 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
|
#!/usr/bin/env python
# 2ping - A bi-directional ping utility
# Copyright (C) 2015 Ryan Finnie
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
from __future__ import print_function, division
import random
import socket
import math
import signal
import sys
import errno
import time
from . import __version__
from . import packets
from . import monotonic_clock
from . import best_poller
from .args import parse_args
from .utils import _, _pl, lazy_div, int_to_bytearray, bytearray_to_int, platform_info, twoping_checksum
try:
random_sys = random.SystemRandom()
has_sysrandom = True
except AttributeError:
random_sys = random
has_sysrandom = False
try:
import dns.resolver
has_dns = True
except ImportError:
has_dns = False
version_string = '2ping %s - %s' % (__version__, platform_info())
clock = monotonic_clock.clock
clock_info = monotonic_clock.get_clock_info('clock')
class SocketClass():
def __init__(self, sock):
self.sock = sock
# In-flight outbound messages. Added in the following conditions:
# * Outbound packet with OpcodeReplyRequested sent.
# Removed in following conditions:
# * Inbound packet with OpcodeInReplyTo set to it.
# * Inbound packet with it in OpcodeInvestigationSeen or OpcodeInvestigationUnseen.
# * Cleanup after 10 minutes.
# If it remains for more than <10> seconds, it it sent as part of
# OpcodeInvestigate with the next outbound packet with OpcodeReplyRequested set.
self.sent_messages = {}
# Seen inbound messages. Added in the following conditions:
# * Inbound packet with OpcodeReplyRequested set.
# Referenced in the following conditions:
# * Inbound packet with it in OpcodeInvestigate.
# Removed in the following conditions:
# * Inbound packet with it in OpcodeCourtesyExpiration.
# * Cleanup after 2 minutes.
self.seen_messages = {}
# Courtesy messages waiting to be sent. Added in the following conditions:
# * Inbound packet with OpcodeInReplyTo set.
# Removed in the following conditions:
# * Outbound packet where there is room to send it as part of OpcodeCourtesyExpiration.
# * Cleanup after 2 minutes.
self.courtesy_messages = {}
# Current position of a peer tuple's incrementing ping integer.
self.ping_positions = {}
# Used during client mode for the host tuple to send UDP packets to.
self.client_host = None
# Statistics
self.pings_transmitted = 0
self.pings_received = 0
self.packets_transmitted = 0
self.packets_received = 0
self.lost_outbound = 0
self.lost_inbound = 0
self.errors_received = 0
self.rtt_total = 0
self.rtt_total_sq = 0
self.rtt_count = 0
self.rtt_min = 0
self.rtt_max = 0
self.rtt_ewma = 0
self.next_send = 0
self.is_shutdown = False
self.nagios_result = 0
def fileno(self):
return self.sock.fileno()
class TwoPing():
def __init__(self, args):
now = clock()
self.args = args
self.time_start = now
self.fake_time_epoch = random_sys.random() * (2**32)
self.fake_time_generation = random_sys.randint(0, 65535)
self.sock_classes = []
self.poller = best_poller.best_poller()
self.pings_transmitted = 0
self.pings_received = 0
self.packets_transmitted = 0
self.packets_received = 0
self.lost_outbound = 0
self.lost_inbound = 0
self.errors_received = 0
self.rtt_total = 0
self.rtt_total_sq = 0
self.rtt_count = 0
self.rtt_min = 0
self.rtt_max = 0
self.rtt_ewma = 0
# Scheduled events
self.next_cleanup = now + 60.0
self.next_stats = 0
if self.args.stats:
self.next_stats = now + self.args.stats
self.old_age_interval = 60.0
# On Windows, KeyboardInterrupt during select() will not be trapped until a socket event or timeout, so we should set
# the timeout to a short value.
if sys.platform.startswith(('win32', 'cygwin')):
self.old_age_interval = 1.0
# Test for IPv6 functionality.
self.has_ipv6 = True
if not socket.has_ipv6:
self.has_ipv6 = False
else:
# BSD jails seem to have has_ipv6 = True, but will throw "Protocol not supported" on bind. Test for this.
try:
socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
except socket.error as e:
if e.errno == errno.EPROTONOSUPPORT:
self.has_ipv6 = False
else:
raise
if self.args.send_monotonic_clock and (not clock_info.monotonic):
self.args.send_monotonic_clock = False
def print_out(self, *args, **kwargs):
'''Emulate Python 3's complete print() functionality'''
if 'sep' not in kwargs:
kwargs['sep'] = ' '
if 'end' not in kwargs:
kwargs['end'] = '\n'
if 'file' not in kwargs:
kwargs['file'] = sys.stdout
if 'flush' not in kwargs:
kwargs['flush'] = False
kwargs['file'].write(kwargs['sep'].join(args) + kwargs['end'])
if kwargs['flush']:
kwargs['file'].flush()
def print_debug(self, *args, **kwargs):
if not self.args.debug:
return
self.print_out(*args, **kwargs)
def shutdown(self):
self.print_stats()
if self.args.nagios:
sys.exit(self.nagios_result)
sys.exit(0)
def handle_socket_error(self, e, sock_class, peer_address=None):
sock = sock_class.sock
# Errors from the last send() can be trapped via IP_RECVERR (Linux only).
self.errors_received += 1
sock_class.errors_received += 1
error_string = str(e)
try:
MSG_ERRQUEUE = 8192
(error_data, error_address) = sock.recvfrom(16384, MSG_ERRQUEUE)
if self.args.quiet:
pass
elif self.args.flood:
self.print_out('E', end='', flush=True)
else:
self.print_out('%s: %s' % (error_address[0], error_string))
except socket.error:
if self.args.quiet:
pass
elif self.args.flood:
self.print_out('E', end='', flush=True)
else:
if peer_address:
self.print_out('%s: %s' % (peer_address[0], error_string))
else:
self.print_out(error_string)
def process_incoming_packet(self, sock_class):
sock = sock_class.sock
try:
(data, peer_address) = sock.recvfrom(16384)
except socket.error as e:
self.handle_socket_error(e, sock_class)
return
socket_address = sock.getsockname()
self.print_debug('Socket address: %s' % repr(socket_address))
self.print_debug('Peer address: %s' % repr(peer_address))
data = bytearray(data)
# Simulate random packet loss.
if self.args.packet_loss_in and (random.random() < (self.args.packet_loss_in / 100.0)):
return
# Simulate data corruption
if self.args.fuzz:
data = self.fuzz_packet(data)
# Per-packet options.
self.packets_received += 1
sock_class.packets_received += 1
calculated_rtt = None
time_begin = clock()
peer_tuple = (socket_address, peer_address, sock.type)
# Preload state tables if the client has not been seen (or has been cleaned).
if peer_tuple not in sock_class.seen_messages:
sock_class.seen_messages[peer_tuple] = {}
if peer_tuple not in sock_class.sent_messages:
sock_class.sent_messages[peer_tuple] = {}
if peer_tuple not in sock_class.courtesy_messages:
sock_class.courtesy_messages[peer_tuple] = {}
if peer_tuple not in sock_class.ping_positions:
sock_class.ping_positions[peer_tuple] = 0
# Load/parse the packet.
packet_in = packets.Packet()
packet_in.load(data)
if self.args.verbose:
self.print_out('RECV: %s' % repr(packet_in))
# Verify HMAC if required.
if self.args.auth:
if packets.OpcodeHMAC.id not in packet_in.opcodes:
self.errors_received += 1
sock_class.errors_received += 1
self.print_out(_('Auth required but not provided by {address}').format(address=peer_address[0]))
return
if packet_in.opcodes[packets.OpcodeHMAC.id].digest_index != self.args.auth_digest_index:
self.errors_received += 1
sock_class.errors_received += 1
self.print_out(
_('Auth digest type mismatch from {address} (expected {expected}, got {got})').format(
address=peer_address[0],
expected=self.args.auth_digest_index,
got=packet_in.opcodes[packets.OpcodeHMAC.id].digest_index,
)
)
return
(test_begin, test_length) = packet_in.opcode_data_positions[packets.OpcodeHMAC.id]
test_begin += 2
test_length -= 2
packet_in.opcodes[packets.OpcodeHMAC.id].key = bytearray(self.args.auth)
test_data = data
test_data[2:4] = bytearray(2)
test_data[test_begin:(test_begin+test_length)] = bytearray(test_length)
test_hash = packet_in.opcodes[packets.OpcodeHMAC.id].hash
test_hash_calculated = packet_in.calculate_hash(packet_in.opcodes[packets.OpcodeHMAC.id], test_data)
if test_hash_calculated != test_hash:
self.errors_received += 1
sock_class.errors_received += 1
self.print_out(
_('Auth hash failed from {address} (expected {expected}, got {got})').format(
address=peer_address[0],
expected=''.join('{hex:02x}'.format(hex=x) for x in test_hash_calculated),
got=''.join('{hex:02x}'.format(hex=x) for x in test_hash),
)
)
return
# If this is in reply to one of our sent packets, it's a ping reply, so handle it specially.
if packets.OpcodeInReplyTo.id in packet_in.opcodes:
replied_message_id = packet_in.opcodes[packets.OpcodeInReplyTo.id].message_id
replied_message_id_int = bytearray_to_int(replied_message_id)
if replied_message_id_int in sock_class.sent_messages[peer_tuple]:
(sent_time, _unused, ping_position) = sock_class.sent_messages[peer_tuple][replied_message_id_int]
del(sock_class.sent_messages[peer_tuple][replied_message_id_int])
calculated_rtt = (time_begin - sent_time) * 1000
self.pings_received += 1
sock_class.pings_received += 1
self.update_rtts(sock_class, calculated_rtt)
if self.args.quiet:
pass
elif self.args.flood:
self.print_out('\x08', end='', flush=True)
else:
if self.args.audible:
self.print_out('\x07', end='', flush=True)
if packets.OpcodeRTTEnclosed.id in packet_in.opcodes:
self.print_out(
_('{bytes} bytes from {address}: ping_seq={seq} time={ms:0.03f} ms peertime={peerms:0.03f} ms').format(
bytes=len(data),
address=peer_tuple[1][0],
seq=ping_position,
ms=calculated_rtt,
peerms=(packet_in.opcodes[packets.OpcodeRTTEnclosed.id].rtt_us / 1000.0),
)
)
else:
self.print_out(
_('{bytes} bytes from {address}: ping_seq={seq} time={ms:0.03f} ms').format(
bytes=len(data),
address=peer_tuple[1][0],
seq=ping_position,
ms=calculated_rtt,
)
)
if (
(packets.OpcodeExtended.id in packet_in.opcodes) and
(packets.ExtendedNotice.id in packet_in.opcodes[packets.OpcodeExtended.id].segments)
):
notice = unicode(str(packet_in.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedNotice.id].text), 'UTF-8', 'replace')
self.print_out(' ' + _('Peer notice: {notice}').format(notice=notice))
sock_class.courtesy_messages[peer_tuple][replied_message_id_int] = (time_begin, replied_message_id)
# Check if any invesitgations results have come back.
self.check_investigations(sock_class, peer_tuple, packet_in)
# Process courtesy expirations
if packets.OpcodeCourtesyExpiration.id in packet_in.opcodes:
for message_id in packet_in.opcodes[packets.OpcodeCourtesyExpiration.id].message_ids:
message_id_int = bytearray_to_int(message_id)
if message_id_int in sock_class.seen_messages[peer_tuple]:
del(sock_class.seen_messages[peer_tuple][message_id_int])
# If the peer requested a reply, prepare one.
if packets.OpcodeReplyRequested.id in packet_in.opcodes:
# Populate seen_messages.
sock_class.seen_messages[peer_tuple][bytearray_to_int(packet_in.message_id)] = time_begin
# Basic packet configuration.
packet_out = self.base_packet()
packet_out.opcodes[packets.OpcodeInReplyTo.id] = packets.OpcodeInReplyTo()
packet_out.opcodes[packets.OpcodeInReplyTo.id].message_id = packet_in.message_id
# If we are matching packet sizes of the peer, adjust the minimum if it falls between min_packet_size
# and max_packet_size.
if not self.args.no_match_packet_size:
data_len = len(data)
if (data_len <= self.args.max_packet_size) and (data_len >= self.args.min_packet_size):
packet_out.min_length = data_len
# 3-way pings already have the first roundtrip calculated.
if calculated_rtt is not None:
packet_out.opcodes[packets.OpcodeRTTEnclosed.id] = packets.OpcodeRTTEnclosed()
packet_out.opcodes[packets.OpcodeRTTEnclosed.id].rtt_us = int(calculated_rtt * 1000)
# Check for any investigations the peer requested.
if packets.OpcodeInvestigate.id in packet_in.opcodes:
for message_id in packet_in.opcodes[packets.OpcodeInvestigate.id].message_ids:
if bytearray_to_int(message_id) in sock_class.seen_messages[peer_tuple]:
if packets.OpcodeInvestigationSeen.id not in packet_out.opcodes:
packet_out.opcodes[packets.OpcodeInvestigationSeen.id] = packets.OpcodeInvestigationSeen()
packet_out.opcodes[packets.OpcodeInvestigationSeen.id].message_ids.append(message_id)
else:
if packets.OpcodeInvestigationUnseen.id not in packet_out.opcodes:
packet_out.opcodes[packets.OpcodeInvestigationUnseen.id] = packets.OpcodeInvestigationUnseen()
packet_out.opcodes[packets.OpcodeInvestigationUnseen.id].message_ids.append(message_id)
# If the packet_in is ReplyRequested but not InReplyTo, it is a second leg. Unless 3-way ping was
# disabled, request a reply.
if (packets.OpcodeInReplyTo.id not in packet_in.opcodes) and (not self.args.no_3way):
packet_out.opcodes[packets.OpcodeReplyRequested.id] = packets.OpcodeReplyRequested()
# Send any investigations we would like to know about.
self.start_investigations(sock_class, peer_tuple, packet_out)
# Any courtesy expirations we have waiting should be sent.
if len(sock_class.courtesy_messages[peer_tuple]) > 0:
packet_out.opcodes[packets.OpcodeCourtesyExpiration.id] = packets.OpcodeCourtesyExpiration()
for (courtesy_time, courtesy_message_id) in sock_class.courtesy_messages[peer_tuple].values():
packet_out.opcodes[packets.OpcodeCourtesyExpiration.id].message_ids.append(courtesy_message_id)
# Calculate the host latency as late as possible.
packet_out.opcodes[packets.OpcodeHostLatency.id] = packets.OpcodeHostLatency()
time_send = clock()
packet_out.opcodes[packets.OpcodeHostLatency.id].delay_us = int((time_send - time_begin) * 1000000)
# Dump the packet.
dump_out = packet_out.dump()
# Send the packet.
self.sock_sendto(sock_class, dump_out, peer_address)
self.packets_transmitted += 1
sock_class.packets_transmitted += 1
# If ReplyRequested is set, we care about its arrival.
if packets.OpcodeReplyRequested.id in packet_out.opcodes:
self.pings_transmitted += 1
sock_class.pings_transmitted += 1
sock_class.ping_positions[peer_tuple] += 1
sock_class.sent_messages[peer_tuple][bytearray_to_int(packet_out.message_id)] = (
time_send,
packet_out.message_id,
sock_class.ping_positions[peer_tuple]
)
# Examine the sent packet.
packet_out_examine = packets.Packet()
packet_out_examine.load(dump_out)
# Any courtesy expirations which had room in the sent packet should be forgotten.
if packets.OpcodeCourtesyExpiration.id in packet_out_examine.opcodes:
for courtesy_message_id in packet_out_examine.opcodes[packets.OpcodeCourtesyExpiration.id].message_ids:
courtesy_message_id_int = bytearray_to_int(courtesy_message_id)
if courtesy_message_id_int in sock_class.courtesy_messages[peer_tuple]:
del(sock_class.courtesy_messages[peer_tuple][courtesy_message_id_int])
if self.args.verbose:
self.print_out('SEND: %s' % repr(packet_out_examine))
# If we're in flood mode and this is a ping reply, send a new ping ASAP.
if self.args.flood and (not self.args.listen) and (packets.OpcodeInReplyTo.id in packet_in.opcodes):
sock_class.next_send = time_begin
def sock_sendto(self, sock_class, data, address):
sock = sock_class.sock
# Simulate random packet loss.
if self.args.packet_loss_out and (random.random() < (self.args.packet_loss_out / 100.0)):
return
# Send the packet.
try:
sock.sendto(data, address)
except socket.error as e:
self.handle_socket_error(e, sock_class, peer_address=address)
def start_investigations(self, sock_class, peer_tuple, packet_check):
if len(sock_class.sent_messages[peer_tuple]) == 0:
return
if packets.OpcodeInvestigate.id in packet_check.opcodes:
iobj = packet_check.opcodes[packets.OpcodeInvestigate.id]
else:
iobj = None
now = clock()
for message_id_str in sock_class.sent_messages[peer_tuple]:
(sent_time, message_id, _unused) = sock_class.sent_messages[peer_tuple][message_id_str]
if now >= (sent_time + self.args.inquire_wait):
if iobj is None:
iobj = packets.OpcodeInvestigate()
if message_id not in iobj.message_ids:
iobj.message_ids.append(message_id)
if iobj is not None:
packet_check.opcodes[packets.OpcodeInvestigate.id] = iobj
def check_investigations(self, sock_class, peer_tuple, packet_check):
found = {}
# Inbound
if packets.OpcodeInvestigationSeen.id in packet_check.opcodes:
for message_id in packet_check.opcodes[packets.OpcodeInvestigationSeen.id].message_ids:
message_id_int = bytearray_to_int(message_id)
if message_id_int not in sock_class.sent_messages[peer_tuple]:
continue
(_unused, _unused, ping_seq) = sock_class.sent_messages[peer_tuple][message_id_int]
found[ping_seq] = ('inbound', peer_tuple[1][0])
del(sock_class.sent_messages[peer_tuple][message_id_int])
self.lost_inbound += 1
sock_class.lost_inbound += 1
# Outbound
if packets.OpcodeInvestigationUnseen.id in packet_check.opcodes:
for message_id in packet_check.opcodes[packets.OpcodeInvestigationUnseen.id].message_ids:
message_id_int = bytearray_to_int(message_id)
if message_id_int not in sock_class.sent_messages[peer_tuple]:
continue
(_unused, _unused, ping_seq) = sock_class.sent_messages[peer_tuple][message_id_int]
found[ping_seq] = ('outbound', peer_tuple[1][0])
del(sock_class.sent_messages[peer_tuple][message_id_int])
self.lost_outbound += 1
sock_class.lost_outbound += 1
if self.args.quiet:
return
# Print results
for ping_seq in sorted(found):
(loss_type, address) = found[ping_seq]
if loss_type == 'inbound':
if self.args.flood:
self.print_out('<', end='', flush=True)
else:
self.print_out(_('Lost inbound packet from {address}: ping_seq={seq}').format(
address=address,
seq=ping_seq,
))
else:
if self.args.flood:
self.print_out('>', end='', flush=True)
else:
self.print_out(_('Lost outbound packet to {address}: ping_seq={seq}').format(
address=address,
seq=ping_seq,
))
def setup_listener(self):
bound_addresses = []
if self.args.interface_address:
interface_addresses = self.args.interface_address
else:
interface_addresses = ['0.0.0.0']
if self.has_ipv6:
interface_addresses.append('::')
for interface_address in interface_addresses:
for l in socket.getaddrinfo(
interface_address,
self.args.port,
socket.AF_UNSPEC,
socket.SOCK_DGRAM,
socket.IPPROTO_UDP
):
if l in bound_addresses:
continue
if (l[0] == socket.AF_INET6) and (not self.args.ipv4) and self.has_ipv6:
pass
elif (l[0] == socket.AF_INET) and (not self.args.ipv6):
pass
else:
continue
sock = self.new_socket(l[0], l[1], l[4])
sock_class = SocketClass(sock)
self.sock_classes.append(sock_class)
self.poller.register(sock_class)
bound_addresses.append(l)
self.print_out(_('2PING listener ({address}): {min} to {max} bytes of data.').format(
address=l[4][0],
min=self.args.min_packet_size,
max=self.args.max_packet_size,
))
def setup_client(self):
if self.args.srv:
if not has_dns:
raise socket.error('DNS SRV lookups not available; please install dnspython')
hosts = []
for lookup in self.args.host:
lookup_hosts_found = 0
self.print_debug('SRV lookup: %s' % lookup)
try:
res = dns.resolver.query('_2ping._udp.%s' % lookup, 'srv')
except dns.exception.DNSException as e:
raise socket.error('%s: %s' % (lookup, repr(e)))
for rdata in res:
self.print_debug('SRV result for %s: %s' % (
lookup,
repr(rdata),
))
if (str(rdata.target), rdata.port) in hosts:
continue
hosts.append((str(rdata.target), rdata.port))
lookup_hosts_found += 1
if lookup_hosts_found == 0:
raise socket.error('%s: No SRV results' % lookup)
else:
hosts = [(x, self.args.port) for x in self.args.host]
for (hostname, port) in hosts:
try:
self.setup_client_host(hostname, port)
except socket.error as e:
eargs = list(e.args)
if len(eargs) == 1:
eargs[0] = '%s: %s' % (hostname, eargs[0])
else:
eargs[1] = '%s: %s' % (hostname, eargs[1])
raise socket.error(*eargs)
def setup_client_host(self, hostname, port):
host_info = None
for l in socket.getaddrinfo(
hostname,
port,
socket.AF_UNSPEC,
socket.SOCK_DGRAM,
socket.IPPROTO_UDP,
socket.AI_CANONNAME,
):
if (l[0] == socket.AF_INET6) and (not self.args.ipv4) and self.has_ipv6:
host_info = l
break
elif (l[0] == socket.AF_INET) and (not self.args.ipv6):
host_info = l
break
else:
continue
if host_info is None:
raise socket.error('Name or service not known')
bind_info = None
if self.args.interface_address:
h = self.args.interface_address[-1]
else:
if host_info[0] == socket.AF_INET6:
h = '::'
else:
h = '0.0.0.0'
for l in socket.getaddrinfo(h, 0, host_info[0], socket.SOCK_DGRAM, socket.IPPROTO_UDP):
bind_info = l
break
if bind_info is None:
raise socket.error(_('Cannot find suitable bind for {address}').format(address=host_info[4]))
sock = self.new_socket(bind_info[0], bind_info[1], bind_info[4])
sock_class = SocketClass(sock)
sock_class.client_host = host_info
self.sock_classes.append(sock_class)
self.poller.register(sock_class)
if not self.args.nagios:
self.print_out(
_('2PING {hostname} ({address}): {min} to {max} bytes of data.').format(
hostname=host_info[3],
address=host_info[4][0],
min=self.args.min_packet_size,
max=self.args.max_packet_size,
)
)
def fuzz_packet(self, packet):
def fuzz_bytearray(data, pct):
for p in range(len(data)):
xor_byte = 0
for i in range(8):
if random.random() < pct:
xor_byte = xor_byte + (2 ** i)
data[p] = data[p] ^ xor_byte
return data
fuzz_fraction = self.args.fuzz / 100.0
# Fuzz the entire packet
packet[4:] = fuzz_bytearray(packet[4:], fuzz_fraction)
# Fuzz the magic number, at a lower probability
packet[0:2] = fuzz_bytearray(packet[0:2], fuzz_fraction / 10.0)
# Fuzz the recalculated checksum itself, at a lower probability
packet[2:4] = bytearray(2)
packet[2:4] = fuzz_bytearray(int_to_bytearray(twoping_checksum(packet), 2), fuzz_fraction / 10.0)
return packet
def send_new_ping(self, sock_class, peer_address):
sock = sock_class.sock
socket_address = sock.getsockname()
peer_tuple = (socket_address, peer_address, sock.type)
if peer_tuple not in sock_class.sent_messages:
sock_class.sent_messages[peer_tuple] = {}
if peer_tuple not in sock_class.ping_positions:
sock_class.ping_positions[peer_tuple] = 0
packet_out = self.base_packet()
packet_out.opcodes[packets.OpcodeReplyRequested.id] = packets.OpcodeReplyRequested()
self.start_investigations(sock_class, peer_tuple, packet_out)
dump_out = packet_out.dump()
now = clock()
self.sock_sendto(sock_class, dump_out, peer_address)
self.packets_transmitted += 1
sock_class.packets_transmitted += 1
self.pings_transmitted += 1
sock_class.pings_transmitted += 1
sock_class.ping_positions[peer_tuple] += 1
sock_class.sent_messages[peer_tuple][bytearray_to_int(packet_out.message_id)] = (
now,
packet_out.message_id,
sock_class.ping_positions[peer_tuple]
)
packet_out_examine = packets.Packet()
packet_out_examine.load(dump_out)
if self.args.quiet:
pass
elif self.args.flood:
self.print_out('.', end='', flush=True)
if self.args.verbose:
self.print_out('SEND: %s' % repr(packet_out_examine))
def update_rtts(self, sock_class, rtt):
for c in (self, sock_class):
c.rtt_total += rtt
c.rtt_total_sq += (rtt ** 2)
c.rtt_count += 1
if (rtt < c.rtt_min) or (c.rtt_min == 0):
c.rtt_min = rtt
if rtt > c.rtt_max:
c.rtt_max = rtt
if c.rtt_ewma == 0:
c.rtt_ewma = rtt * 8.0
else:
c.rtt_ewma += (rtt - (c.rtt_ewma / 8.0))
def sigquit_handler(self, signum, frame):
self.print_stats(short=True)
def stats_time(self, seconds):
conversion = (
(1000, 'ms'),
(60, 's'),
(60, 'm'),
(24, 'h'),
(365, 'd'),
(None, 'y'),
)
out = ''
rest = int(seconds * 1000)
for (div, suffix) in conversion:
if div is None:
if(out):
out = ' ' + out
out = '%d%s%s' % (rest, suffix, out)
break
p = rest % div
rest = int(rest / div)
if p > 0:
if(out):
out = ' ' + out
out = '%d%s%s' % (p, suffix, out)
if rest == 0:
break
return out
def print_stats(self, short=False):
time_end = clock()
if self.args.listen:
self.print_stats_sock(time_end, short=short, sock_class=None)
else:
for sock_class in self.sock_classes:
self.print_stats_sock(time_end, short=short, sock_class=sock_class)
def print_stats_sock(self, time_end, short=False, sock_class=None):
if sock_class is not None:
stats_class = sock_class
else:
stats_class = self
time_start = self.time_start
pings_lost = stats_class.pings_transmitted - stats_class.pings_received
lost_pct = lazy_div(pings_lost, stats_class.pings_transmitted) * 100
lost_undetermined = pings_lost - (stats_class.lost_outbound + stats_class.lost_inbound)
outbound_pct = lazy_div(stats_class.lost_outbound, stats_class.pings_transmitted) * 100
inbound_pct = lazy_div(stats_class.lost_inbound, stats_class.pings_transmitted) * 100
undetermined_pct = lazy_div(lost_undetermined, stats_class.pings_transmitted) * 100
rtt_avg = lazy_div(float(stats_class.rtt_total), stats_class.rtt_count)
rtt_ewma = stats_class.rtt_ewma / 8.0
rtt_mdev = math.sqrt(
lazy_div(stats_class.rtt_total_sq, stats_class.rtt_count) -
(lazy_div(stats_class.rtt_total, stats_class.rtt_count) ** 2)
)
if self.args.listen:
hostname = _('Listener')
else:
hostname = sock_class.client_host[3]
if short:
self.print_out('\x0d', end='', flush=True, file=sys.stderr)
self.print_out(_pl(
'{hostname}: {transmitted}/{received} ping, {loss}% loss ' +
'({outbound}/{inbound}/{undetermined} out/in/undet), min/avg/ewma/max/mdev = ' +
'{min:0.03f}/{avg:0.03f}/{ewma:0.03f}/{max:0.03f}/{mdev:0.03f} ms',
'{hostname}: {transmitted}/{received} pings, {loss}% loss ' +
'({outbound}/{inbound}/{undetermined} out/in/undet), min/avg/ewma/max/mdev = ' +
'{min:0.03f}/{avg:0.03f}/{ewma:0.03f}/{max:0.03f}/{mdev:0.03f} ms',
stats_class.pings_received
).format(
hostname=hostname,
transmitted=stats_class.pings_transmitted,
received=stats_class.pings_received,
loss=int(lost_pct),
outbound=stats_class.lost_outbound,
inbound=stats_class.lost_inbound,
undetermined=lost_undetermined,
min=stats_class.rtt_min,
avg=rtt_avg,
ewma=rtt_ewma,
max=stats_class.rtt_max,
mdev=rtt_mdev,
), file=sys.stderr)
elif self.args.nagios:
if (lost_pct >= self.args.nagios_crit_loss) or (rtt_avg >= self.args.nagios_crit_rta):
self.nagios_result = 2
nagios_result_text = 'CRITICAL'
elif (lost_pct >= self.args.nagios_warn_loss) or (rtt_avg >= self.args.nagios_warn_rta):
self.nagios_result = 1
nagios_result_text = 'WARNING'
else:
self.nagios_result = 0
nagios_result_text = 'OK'
self.print_out(_(
'2PING {result} - Packet loss = {loss}%, RTA = {avg:0.03f} ms'
).format(
result=nagios_result_text,
loss=int(lost_pct),
avg=rtt_avg,
) + (
'|rta={avg:0.06f}ms;{avgwarn:0.06f};{avgcrit:0.06f};0.000000 ' +
'pl={loss}%;{losswarn};{losscrit};0'
).format(
avg=rtt_avg,
loss=int(lost_pct),
avgwarn=self.args.nagios_warn_rta,
avgcrit=self.args.nagios_crit_rta,
losswarn=int(self.args.nagios_warn_loss),
losscrit=int(self.args.nagios_crit_loss),
))
else:
self.print_out('')
self.print_out('--- %s ---' % _('{hostname} 2ping statistics').format(hostname=hostname))
self.print_out(_pl(
'{transmitted} ping transmitted, {received} received, {loss}% ping loss, time {time}',
'{transmitted} pings transmitted, {received} received, {loss}% ping loss, time {time}',
stats_class.pings_transmitted
).format(
transmitted=stats_class.pings_transmitted,
received=stats_class.pings_received,
loss=int(lost_pct),
time=self.stats_time(time_end - time_start),
))
self.print_out(_pl(
'{outbound} outbound ping loss ({outboundpct}%), {inbound} inbound ({inboundpct}%), ' +
'{undetermined} undetermined ({undeterminedpct}%)',
'{outbound} outbound ping losses ({outboundpct}%), {inbound} inbound ({inboundpct}%), ' +
'{undetermined} undetermined ({undeterminedpct}%)',
stats_class.lost_outbound
).format(
outbound=stats_class.lost_outbound,
outboundpct=int(outbound_pct),
inbound=stats_class.lost_inbound,
inboundpct=int(inbound_pct),
undetermined=lost_undetermined,
undeterminedpct=int(undetermined_pct),
))
self.print_out(_('rtt min/avg/ewma/max/mdev = {min:0.03f}/{avg:0.03f}/' +
'{ewma:0.03f}/{max:0.03f}/{mdev:0.03f} ms').format(
min=stats_class.rtt_min,
avg=rtt_avg,
ewma=rtt_ewma,
max=stats_class.rtt_max,
mdev=rtt_mdev,
))
self.print_out(_pl(
'{transmitted} raw packet transmitted, {received} received',
'{transmitted} raw packets transmitted, {received} received',
stats_class.packets_transmitted
).format(
transmitted=stats_class.packets_transmitted,
received=stats_class.packets_received,
))
def run(self):
self.print_debug('Clock: %s, value: %f' % (clock_info, clock()))
self.print_debug('Poller: %s' % self.poller.poller_type)
if hasattr(signal, 'SIGQUIT'):
signal.signal(signal.SIGQUIT, self.sigquit_handler)
try:
if self.args.listen:
self.setup_listener()
else:
self.setup_client()
except (socket.error, socket.gaierror) as e:
self.print_out(str(e))
return 1
try:
self.loop()
except KeyboardInterrupt:
self.shutdown()
return
def base_packet(self):
packet_out = packets.Packet()
if (not self.args.no_send_version) or (self.args.notice):
packet_out.opcodes[packets.OpcodeExtended.id] = packets.OpcodeExtended()
if not self.args.no_send_version:
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedVersion.id] = packets.ExtendedVersion()
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedVersion.id].text = version_string
if self.args.send_time:
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedWallClock.id] = packets.ExtendedWallClock()
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedWallClock.id].time_us = int(time.time() * 1000000)
if self.args.send_monotonic_clock:
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedMonotonicClock.id] = packets.ExtendedMonotonicClock()
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedMonotonicClock.id].generation = self.fake_time_generation
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedMonotonicClock.id].time_us = int((clock() - self.time_start + self.fake_time_epoch) * 1000000)
if self.args.send_random:
random_data = bytearray([random_sys.randint(0, 255) for x in xrange(self.args.send_random)])
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedRandom.id] = packets.ExtendedRandom()
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedRandom.id].is_hwrng = False
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedRandom.id].is_os = has_sysrandom
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedRandom.id].random_data = random_data
if self.args.notice:
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedNotice.id] = packets.ExtendedNotice()
packet_out.opcodes[packets.OpcodeExtended.id].segments[packets.ExtendedNotice.id].text = self.args.notice
if self.args.auth:
packet_out.opcodes[packets.OpcodeHMAC.id] = packets.OpcodeHMAC()
packet_out.opcodes[packets.OpcodeHMAC.id].key = bytearray(self.args.auth)
packet_out.opcodes[packets.OpcodeHMAC.id].digest_index = self.args.auth_digest_index
packet_out.padding_pattern = self.args.pattern_bytearray
packet_out.min_length = self.args.min_packet_size
packet_out.max_length = self.args.max_packet_size
return packet_out
def scheduled_cleanup(self):
self.print_debug('Cleanup')
for sock_class in self.sock_classes:
self.scheduled_cleanup_sock_class(sock_class)
def scheduled_cleanup_sock_class(self, sock_class):
now = clock()
for peer_tuple in sock_class.sent_messages.keys():
for message_id_int in sock_class.sent_messages[peer_tuple].keys():
if now > (sock_class.sent_messages[peer_tuple][message_id_int][0] + 120.0):
del(sock_class.sent_messages[peer_tuple][message_id_int])
self.print_debug('Cleanup: Removed sent_messages %s %d' % (repr(peer_tuple), message_id_int))
if len(sock_class.sent_messages[peer_tuple]) == 0:
del(sock_class.sent_messages[peer_tuple])
self.print_debug('Cleanup: Removed sent_messages empty %s' % repr(peer_tuple))
for peer_tuple in sock_class.seen_messages.keys():
for message_id_int in sock_class.seen_messages[peer_tuple].keys():
if now > (sock_class.seen_messages[peer_tuple][message_id_int] + 600.0):
del(sock_class.seen_messages[peer_tuple][message_id_int])
self.print_debug('Cleanup: Removed seen_messages %s %d' % (repr(peer_tuple), message_id_int))
if len(sock_class.seen_messages[peer_tuple]) == 0:
del(sock_class.seen_messages[peer_tuple])
self.print_debug('Cleanup: Removed seen_messages empty %s' % repr(peer_tuple))
for peer_tuple in sock_class.courtesy_messages.keys():
for message_id_int in sock_class.courtesy_messages[peer_tuple].keys():
if now > (sock_class.courtesy_messages[peer_tuple][message_id_int][0] + 120.0):
del(sock_class.courtesy_messages[peer_tuple][message_id_int])
self.print_debug('Cleanup: Removed courtesy_messages %s %d' % (repr(peer_tuple), message_id_int))
if len(sock_class.courtesy_messages[peer_tuple]) == 0:
del(sock_class.courtesy_messages[peer_tuple])
self.print_debug('Cleanup: Removed courtesy_messages empty %s' % repr(peer_tuple))
def new_socket(self, family, type, bind):
sock = socket.socket(family, type)
try:
import IN
sock.setsockopt(socket.IPPROTO_IP, IN.IP_RECVERR, int(True))
except (ImportError, AttributeError, socket.error):
pass
if family == socket.AF_INET6:
try:
sock.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, int(True))
except (AttributeError, socket.error):
pass
sock.bind(bind)
self.print_debug('Bound to: %s' % repr((family, type, bind)))
return sock
def loop(self):
while True:
now = clock()
if now >= self.next_cleanup:
self.scheduled_cleanup()
self.next_cleanup = now + 60.0
if not self.args.listen:
for sock_class in self.sock_classes:
if sock_class.is_shutdown:
continue
if now >= sock_class.next_send:
if self.args.count and (sock_class.pings_transmitted >= self.args.count):
sock_class.is_shutdown = True
continue
if (sock_class.pings_transmitted == 0) and (self.args.preload > 1):
for i in xrange(self.args.preload):
self.send_new_ping(sock_class, sock_class.client_host[4])
else:
self.send_new_ping(sock_class, sock_class.client_host[4])
sock_class.next_send = now + self.args.interval
if self.args.flood:
next_send = now + 0.01
for sock_class in self.sock_classes:
if next_send < sock_class.next_send:
sock_class.next_send = next_send
next_wakeup = now + self.old_age_interval
next_wakeup_reason = 'old age'
for sock_class in self.sock_classes:
if (not self.args.listen) and (sock_class.next_send < next_wakeup):
next_wakeup = sock_class.next_send
next_wakeup_reason = 'send'
if self.args.stats:
if now >= self.next_stats:
self.print_stats(short=True)
self.next_stats = now + self.args.stats
if self.next_stats < next_wakeup:
next_wakeup = self.next_stats
next_wakeup_reason = 'stats'
if self.args.deadline:
time_deadline = self.time_start + self.args.deadline
if now >= time_deadline:
self.shutdown()
if time_deadline < next_wakeup:
next_wakeup = time_deadline
next_wakeup_reason = 'deadline'
if self.next_cleanup < next_wakeup:
next_wakeup = self.next_cleanup
next_wakeup_reason = 'cleanup'
if next_wakeup < now:
next_wakeup = now
next_wakeup_reason = 'time travel'
self.print_debug('Next wakeup: %s (%s)' % ((next_wakeup - now), next_wakeup_reason))
for sock_class in self.poller.poll(next_wakeup - now):
try:
self.process_incoming_packet(sock_class)
except Exception as e:
self.print_out(_('Exception: {error}').format(error=str(e)))
if self.args.debug:
raise
if self.args.adaptive and sock_class.rtt_ewma:
target = sock_class.rtt_ewma / 8.0 / 1000.0
sock_class.next_send = now + target
if (
self.args.count and
(sock_class.pings_transmitted >= self.args.count) and
(sock_class.pings_transmitted == sock_class.pings_received)
):
sock_class.is_shutdown = True
all_shutdown = True
for sock_class in self.sock_classes:
if not sock_class.is_shutdown:
all_shutdown = False
break
if all_shutdown:
self.shutdown()
def main():
args = parse_args()
t = TwoPing(args)
return(t.run())
if __name__ == '__main__':
sys.exit(main())
|