From c2a663aeb10e0190eae172cf938abc1fec3e5acc Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Thu, 15 Dec 2005 15:10:44 +0000 Subject: [PATCH 01/42] Uploader v0.1 From 711fdab655cc339b97843fd4f33d239fbd4e2a36 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 7 Nov 2007 15:53:51 +0000 Subject: [PATCH 02/42] add ping.py --- ping.py | 205 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 ping.py diff --git a/ping.py b/ping.py new file mode 100644 index 0000000..ff3ad95 --- /dev/null +++ b/ping.py @@ -0,0 +1,205 @@ +#!/usr/bin/env python + +""" + A pure python ping implementation using raw socket. + + + Note that ICMP messages can only be sent from processes running as root. + + + Derived from ping.c distributed in Linux's netkit. That code is + copyright (c) 1989 by The Regents of the University of California. + That code is in turn derived from code written by Mike Muuss of the + US Army Ballistic Research Laboratory in December, 1983 and + placed in the public domain. They have my thanks. + + Bugs are naturally mine. I'd be glad to hear about them. There are + certainly word - size dependenceies here. + + Copyright (c) Matthew Dixon Cowles, . + Distributable under the terms of the GNU General Public License + version 2. Provided with no warranties of any sort. + + Original Version from Matthew Dixon Cowles: + -> ftp://ftp.visi.com/users/mdc/ping.py + + Rewrite by Jens Diemer: + -> http://www.python-forum.de/post-69122.html#69122 + + + Revision history + ~~~~~~~~~~~~~~~~ + + May 30, 2007 + little rewrite by Jens Diemer: + - change socket asterisk import to a normal import + - replace time.time() with time.clock() + - delete "return None" (or change to "return" only) + - in checksum() rename "str" to "source_string" + + November 22, 1997 + Initial hack. Doesn't do much, but rather than try to guess + what features I (or others) will want in the future, I've only + put in what I need now. + + December 16, 1997 + For some reason, the checksum bytes are in the wrong order when + this is run under Solaris 2.X for SPARC but it works right under + Linux x86. Since I don't know just what's wrong, I'll swap the + bytes always and then do an htons(). + + December 4, 2000 + Changed the struct.pack() calls to pack the checksum and ID as + unsigned. My thanks to Jerome Poincheval for the fix. + + + Last commit info: + ~~~~~~~~~~~~~~~~~ + $LastChangedDate: $ + $Rev: $ + $Author: $ +""" + + +import os, sys, socket, struct, select, time + +# From /usr/include/linux/icmp.h; your milage may vary. +ICMP_ECHO_REQUEST = 8 # Seems to be the same on Solaris. + + +def checksum(source_string): + """ + I'm not too confident that this is right but testing seems + to suggest that it gives the same answers as in_cksum in ping.c + """ + sum = 0 + countTo = (len(source_string)/2)*2 + count = 0 + while count> 16) + (sum & 0xffff) + sum = sum + (sum >> 16) + answer = ~sum + answer = answer & 0xffff + + # Swap bytes. Bugger me if I know why. + answer = answer >> 8 | (answer << 8 & 0xff00) + + return answer + + +def receive_one_ping(my_socket, ID, timeout): + """ + receive the ping from the socket. + """ + timeLeft = timeout + while True: + startedSelect = time.clock() + whatReady = select.select([my_socket], [], [], timeLeft) + howLongInSelect = (time.clock() - startedSelect) + if whatReady[0] == []: # Timeout + return + + timeReceived = time.clock() + recPacket, addr = my_socket.recvfrom(1024) + icmpHeader = recPacket[20:28] + type, code, checksum, packetID, sequence = struct.unpack( + "bbHHh", icmpHeader + ) + if packetID == ID: + bytesInDouble = struct.calcsize("d") + timeSent = struct.unpack("d", recPacket[28:28 + bytesInDouble])[0] + return timeReceived - timeSent + + timeLeft = timeLeft - howLongInSelect + if timeLeft <= 0: + return + + +def send_one_ping(my_socket, dest_addr, ID): + """ + Send one ping to the given >dest_addr<. + """ + dest_addr = socket.gethostbyname(dest_addr) + + # Header is type (8), code (8), checksum (16), id (16), sequence (16) + my_checksum = 0 + + # Make a dummy heder with a 0 checksum. + header = struct.pack("bbHHh", ICMP_ECHO_REQUEST, 0, my_checksum, ID, 1) + bytesInDouble = struct.calcsize("d") + data = (192 - bytesInDouble) * "Q" + data = struct.pack("d", time.clock()) + data + + # Calculate the checksum on the data and the dummy header. + my_checksum = checksum(header + data) + + # Now that we have the right checksum, we put that in. It's just easier + # to make up a new header than to stuff it into the dummy. + header = struct.pack( + "bbHHh", ICMP_ECHO_REQUEST, 0, socket.htons(my_checksum), ID, 1 + ) + packet = header + data + my_socket.sendto(packet, (dest_addr, 1)) # Don't know about the 1 + + +def do_one(dest_addr, timeout): + """ + Returns either the delay (in seconds) or none on timeout. + """ + icmp = socket.getprotobyname("icmp") + try: + my_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, icmp) + except socket.error, (errno, msg): + if errno == 1: + # Operation not permitted + msg = msg + ( + " - Note that ICMP messages can only be sent from processes" + " running as root." + ) + raise socket.error(msg) + raise # raise the original error + + my_ID = os.getpid() & 0xFFFF + + send_one_ping(my_socket, dest_addr, my_ID) + delay = receive_one_ping(my_socket, my_ID, timeout) + + my_socket.close() + return delay + + +def verbose_ping(dest_addr, timeout = 2, count = 4): + """ + Send >count< ping to >dest_addr< with the given >timeout< and display + the result. + """ + for i in xrange(count): + print "ping %s..." % dest_addr, + try: + delay = do_one(dest_addr, timeout) + except socket.gaierror, e: + print "failed. (socket error: '%s')" % e[1] + break + + if delay == None: + print "failed. (timeout within %ssec.)" % timeout + else: + delay = delay * 1000 + print "get ping in %0.4fms" % delay + print + + +if __name__ == '__main__': + verbose_ping("heise.de") + verbose_ping("google.com") + verbose_ping("a-test-url-taht-is-not-available.com") + verbose_ping("192.168.1.1") \ No newline at end of file From a6fbbb8a6ee86f2ebb3e23eb8a1d090fd2985fdb Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Thu, 24 Jun 2010 09:56:41 +0200 Subject: [PATCH 03/42] change back from time.clock() to time.time() --- ping.py | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/ping.py b/ping.py index ff3ad95..499a52c 100644 --- a/ping.py +++ b/ping.py @@ -33,7 +33,6 @@ May 30, 2007 little rewrite by Jens Diemer: - change socket asterisk import to a normal import - - replace time.time() with time.clock() - delete "return None" (or change to "return" only) - in checksum() rename "str" to "source_string" @@ -51,13 +50,6 @@ December 4, 2000 Changed the struct.pack() calls to pack the checksum and ID as unsigned. My thanks to Jerome Poincheval for the fix. - - - Last commit info: - ~~~~~~~~~~~~~~~~~ - $LastChangedDate: $ - $Rev: $ - $Author: $ """ @@ -102,13 +94,13 @@ def receive_one_ping(my_socket, ID, timeout): """ timeLeft = timeout while True: - startedSelect = time.clock() + startedSelect = time.time() whatReady = select.select([my_socket], [], [], timeLeft) - howLongInSelect = (time.clock() - startedSelect) + howLongInSelect = (time.time() - startedSelect) if whatReady[0] == []: # Timeout return - timeReceived = time.clock() + timeReceived = time.time() recPacket, addr = my_socket.recvfrom(1024) icmpHeader = recPacket[20:28] type, code, checksum, packetID, sequence = struct.unpack( @@ -137,7 +129,7 @@ def send_one_ping(my_socket, dest_addr, ID): header = struct.pack("bbHHh", ICMP_ECHO_REQUEST, 0, my_checksum, ID, 1) bytesInDouble = struct.calcsize("d") data = (192 - bytesInDouble) * "Q" - data = struct.pack("d", time.clock()) + data + data = struct.pack("d", time.time()) + data # Calculate the checksum on the data and the dummy header. my_checksum = checksum(header + data) @@ -199,7 +191,7 @@ def verbose_ping(dest_addr, timeout = 2, count = 4): if __name__ == '__main__': + verbose_ping("localhost") verbose_ping("heise.de") verbose_ping("google.com") - verbose_ping("a-test-url-taht-is-not-available.com") - verbose_ping("192.168.1.1") \ No newline at end of file + verbose_ping("a-test-url-taht-is-not-available.com") \ No newline at end of file From 9446b98bcd92162429424238c622480887536d01 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 7 Jul 2010 12:18:26 +0200 Subject: [PATCH 04/42] chmod +x --- ping.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 ping.py diff --git a/ping.py b/ping.py old mode 100644 new mode 100755 From 06d85e3fb111eb4bca87829e47e971fd91109a60 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 12 Sep 2011 12:33:34 +0200 Subject: [PATCH 05/42] add changes by George Notaras: http://www.g-loaded.eu/2009/10/30/python-ping/ --- ping.py | 82 +++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 56 insertions(+), 26 deletions(-) diff --git a/ping.py b/ping.py index 499a52c..cf328e2 100755 --- a/ping.py +++ b/ping.py @@ -2,54 +2,84 @@ """ A pure python ping implementation using raw socket. - - + + Note that ICMP messages can only be sent from processes running as root. - - + + Derived from ping.c distributed in Linux's netkit. That code is copyright (c) 1989 by The Regents of the University of California. That code is in turn derived from code written by Mike Muuss of the US Army Ballistic Research Laboratory in December, 1983 and placed in the public domain. They have my thanks. - + Bugs are naturally mine. I'd be glad to hear about them. There are certainly word - size dependenceies here. - + Copyright (c) Matthew Dixon Cowles, . Distributable under the terms of the GNU General Public License version 2. Provided with no warranties of any sort. - + Original Version from Matthew Dixon Cowles: -> ftp://ftp.visi.com/users/mdc/ping.py - + Rewrite by Jens Diemer: -> http://www.python-forum.de/post-69122.html#69122 - - + + Rewrite by George Notaras: + -> http://www.g-loaded.eu/2009/10/30/python-ping/ + Revision history ~~~~~~~~~~~~~~~~ - + + November 8, 2009 + ---------------- + Improved compatibility with GNU/Linux systems. + + Fixes by: + * George Notaras -- http://www.g-loaded.eu + Reported by: + * Chris Hallman -- http://cdhallman.blogspot.com + + Changes in this release: + - Re-use time.time() instead of time.clock(). The 2007 implementation + worked only under Microsoft Windows. Failed on GNU/Linux. + time.clock() behaves differently under the two OSes[1]. + + [1] http://docs.python.org/library/time.html#time.clock + May 30, 2007 + ------------ little rewrite by Jens Diemer: - change socket asterisk import to a normal import + - replace time.time() with time.clock() - delete "return None" (or change to "return" only) - in checksum() rename "str" to "source_string" - + November 22, 1997 + ----------------- Initial hack. Doesn't do much, but rather than try to guess what features I (or others) will want in the future, I've only put in what I need now. - + December 16, 1997 + ----------------- For some reason, the checksum bytes are in the wrong order when this is run under Solaris 2.X for SPARC but it works right under Linux x86. Since I don't know just what's wrong, I'll swap the bytes always and then do an htons(). - + December 4, 2000 + ---------------- Changed the struct.pack() calls to pack the checksum and ID as unsigned. My thanks to Jerome Poincheval for the fix. + + + Last commit info: + ~~~~~~~~~~~~~~~~~ + $LastChangedDate: $ + $Rev: $ + $Author: $ """ @@ -65,19 +95,19 @@ def checksum(source_string): to suggest that it gives the same answers as in_cksum in ping.c """ sum = 0 - countTo = (len(source_string)/2)*2 + countTo = (len(source_string) / 2) * 2 count = 0 - while count> 16) + (sum & 0xffff) + sum = (sum >> 16) + (sum & 0xffff) sum = sum + (sum >> 16) answer = ~sum answer = answer & 0xffff @@ -120,7 +150,7 @@ def send_one_ping(my_socket, dest_addr, ID): """ Send one ping to the given >dest_addr<. """ - dest_addr = socket.gethostbyname(dest_addr) + dest_addr = socket.gethostbyname(dest_addr) # Header is type (8), code (8), checksum (16), id (16), sequence (16) my_checksum = 0 @@ -169,7 +199,7 @@ def do_one(dest_addr, timeout): return delay -def verbose_ping(dest_addr, timeout = 2, count = 4): +def verbose_ping(dest_addr, timeout=2, count=4): """ Send >count< ping to >dest_addr< with the given >timeout< and display the result. @@ -177,21 +207,21 @@ def verbose_ping(dest_addr, timeout = 2, count = 4): for i in xrange(count): print "ping %s..." % dest_addr, try: - delay = do_one(dest_addr, timeout) + delay = do_one(dest_addr, timeout) except socket.gaierror, e: print "failed. (socket error: '%s')" % e[1] break - if delay == None: + if delay == None: print "failed. (timeout within %ssec.)" % timeout else: - delay = delay * 1000 + delay = delay * 1000 print "get ping in %0.4fms" % delay print if __name__ == '__main__': - verbose_ping("localhost") verbose_ping("heise.de") verbose_ping("google.com") - verbose_ping("a-test-url-taht-is-not-available.com") \ No newline at end of file + verbose_ping("a-test-url-taht-is-not-available.com") + verbose_ping("192.168.1.1") From 1a7b6369c67017463b5d48927bfddc552d071fc0 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 12 Sep 2011 12:34:18 +0200 Subject: [PATCH 06/42] Add enhancements by Martin Falatic: http://www.falatic.com/index.php/39/pinging-with-python --- ping.py | 441 +++++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 325 insertions(+), 116 deletions(-) diff --git a/ping.py b/ping.py index cf328e2..eea2097 100755 --- a/ping.py +++ b/ping.py @@ -1,53 +1,69 @@ #!/usr/bin/env python - """ - A pure python ping implementation using raw socket. - - - Note that ICMP messages can only be sent from processes running as root. - - + A pure python ping implementation using raw sockets. + + Note that ICMP messages can only be sent from processes running as root + (in Windows, you must run this script as 'Administrator'). + Derived from ping.c distributed in Linux's netkit. That code is copyright (c) 1989 by The Regents of the University of California. That code is in turn derived from code written by Mike Muuss of the US Army Ballistic Research Laboratory in December, 1983 and placed in the public domain. They have my thanks. - + Bugs are naturally mine. I'd be glad to hear about them. There are - certainly word - size dependenceies here. - + certainly word - size dependencies here. + Copyright (c) Matthew Dixon Cowles, . Distributable under the terms of the GNU General Public License version 2. Provided with no warranties of any sort. - + Original Version from Matthew Dixon Cowles: -> ftp://ftp.visi.com/users/mdc/ping.py - + Rewrite by Jens Diemer: -> http://www.python-forum.de/post-69122.html#69122 - + Rewrite by George Notaras: -> http://www.g-loaded.eu/2009/10/30/python-ping/ - + + Enhancements by Martin Falatic: + -> http://www.falatic.com/index.php/39/pinging-with-python + Revision history ~~~~~~~~~~~~~~~~ - + + September 6, 2011 + -------------- + Cleanup by Martin Falatic. Restored lost comments and docs. Improved + functionality: constant time between pings, internal times consistently + use milliseconds. Clarified annotations (e.g., in the checksum routine). + Using unsigned data in IP & ICMP header pack/unpack unless otherwise + necessary. Signal handling. Ping-style output formatting and stats. + + August 3, 2011 + -------------- + Ported to py3k by Zach Ware. Mostly done by 2to3; also minor changes to + deal with bytes vs. string changes (no more ord() in checksum() because + >source_string< is actually bytes, added .encode() to data in + send_one_ping()). That's about it. + November 8, 2009 ---------------- Improved compatibility with GNU/Linux systems. - + Fixes by: * George Notaras -- http://www.g-loaded.eu Reported by: * Chris Hallman -- http://cdhallman.blogspot.com - + Changes in this release: - Re-use time.time() instead of time.clock(). The 2007 implementation worked only under Microsoft Windows. Failed on GNU/Linux. time.clock() behaves differently under the two OSes[1]. - + [1] http://docs.python.org/library/time.html#time.clock - + May 30, 2007 ------------ little rewrite by Jens Diemer: @@ -55,173 +71,366 @@ - replace time.time() with time.clock() - delete "return None" (or change to "return" only) - in checksum() rename "str" to "source_string" - + + December 4, 2000 + ---------------- + Changed the struct.pack() calls to pack the checksum and ID as + unsigned. My thanks to Jerome Poincheval for the fix. + November 22, 1997 ----------------- Initial hack. Doesn't do much, but rather than try to guess what features I (or others) will want in the future, I've only put in what I need now. - + December 16, 1997 ----------------- For some reason, the checksum bytes are in the wrong order when this is run under Solaris 2.X for SPARC but it works right under Linux x86. Since I don't know just what's wrong, I'll swap the bytes always and then do an htons(). - - December 4, 2000 - ---------------- - Changed the struct.pack() calls to pack the checksum and ID as - unsigned. My thanks to Jerome Poincheval for the fix. - - + Last commit info: ~~~~~~~~~~~~~~~~~ $LastChangedDate: $ $Rev: $ $Author: $ + + =========================================================================== + IP header info from RFC791 + -> http://tools.ietf.org/html/rfc791) + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + |Version| IHL |Type of Service| Total Length | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Identification |Flags| Fragment Offset | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Time to Live | Protocol | Header Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Source Address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Destination Address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Options | Padding | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + + =========================================================================== + ICMP Echo / Echo Reply Message header info from RFC792 + -> http://tools.ietf.org/html/rfc792 + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Type | Code | Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Identifier | Sequence Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Data ... + +-+-+-+-+- + + =========================================================================== + ICMP parameter info: + -> http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xml + + =========================================================================== + An example of ping's typical output: + + PING heise.de (193.99.144.80): 56 data bytes + 64 bytes from 193.99.144.80: icmp_seq=0 ttl=240 time=127 ms + 64 bytes from 193.99.144.80: icmp_seq=1 ttl=240 time=127 ms + 64 bytes from 193.99.144.80: icmp_seq=2 ttl=240 time=126 ms + 64 bytes from 193.99.144.80: icmp_seq=3 ttl=240 time=126 ms + 64 bytes from 193.99.144.80: icmp_seq=4 ttl=240 time=127 ms + + ----heise.de PING Statistics---- + 5 packets transmitted, 5 packets received, 0.0% packet loss + round-trip (ms) min/avg/max/med = 126/127/127/127 + + =========================================================================== """ +#=============================================================================# +import os, sys, socket, struct, select, time, signal + +#=============================================================================# +# ICMP parameters -import os, sys, socket, struct, select, time +ICMP_ECHOREPLY = 0 # Echo reply (per RFC792) +ICMP_ECHO = 8 # Echo request (per RFC792) +ICMP_MAX_RECV = 2048 # Max size of incoming buffer -# From /usr/include/linux/icmp.h; your milage may vary. -ICMP_ECHO_REQUEST = 8 # Seems to be the same on Solaris. +MAX_SLEEP = 1000 +class MyStats: + thisIP = "0.0.0.0" + pktsSent = 0 + pktsRcvd = 0 + minTime = 999999999 + maxTime = 0 + totTime = 0 + fracLoss = 1.0 +myStats = MyStats # Used globally + +#=============================================================================# def checksum(source_string): """ - I'm not too confident that this is right but testing seems - to suggest that it gives the same answers as in_cksum in ping.c + A port of the functionality of in_cksum() from ping.c + Ideally this would act on the string as a series of 16-bit ints (host + packed), but this works. + Network data is big-endian, hosts are typically little-endian """ + countTo = (int(len(source_string) / 2)) * 2 sum = 0 - countTo = (len(source_string) / 2) * 2 count = 0 + + # Handle bytes in pairs (decoding as short ints) + loByte = 0 + hiByte = 0 while count < countTo: - thisVal = ord(source_string[count + 1]) * 256 + ord(source_string[count]) - sum = sum + thisVal - sum = sum & 0xffffffff # Necessary? - count = count + 2 + if (sys.byteorder == "little"): + loByte = source_string[count] + hiByte = source_string[count + 1] + else: + loByte = source_string[count + 1] + hiByte = source_string[count] + sum = sum + (hiByte * 256 + loByte) + count += 2 - if countTo < len(source_string): - sum = sum + ord(source_string[len(source_string) - 1]) - sum = sum & 0xffffffff # Necessary? + # Handle last byte if applicable (odd-number of bytes) + # Endianness should be irrelevant in this case + if countTo < len(source_string): # Check for odd length + loByte = source_string[len(source_string) - 1] + sum += loByte - sum = (sum >> 16) + (sum & 0xffff) - sum = sum + (sum >> 16) - answer = ~sum - answer = answer & 0xffff + sum &= 0xffffffff # Truncate sum to 32 bits (a variance from ping.c, which + # uses signed ints, but overflow is unlikely in ping) - # Swap bytes. Bugger me if I know why. - answer = answer >> 8 | (answer << 8 & 0xff00) + sum = (sum >> 16) + (sum & 0xffff) # Add high 16 bits to low 16 bits + sum += (sum >> 16) # Add carry from above (if any) + answer = ~sum & 0xffff # Invert and truncate to 16 bits + answer = socket.htons(answer) return answer - -def receive_one_ping(my_socket, ID, timeout): +#=============================================================================# +def do_one(destIP, timeout, mySeqNumber, numDataBytes): """ - receive the ping from the socket. + Returns either the delay (in ms) or None on timeout. """ - timeLeft = timeout - while True: - startedSelect = time.time() - whatReady = select.select([my_socket], [], [], timeLeft) - howLongInSelect = (time.time() - startedSelect) - if whatReady[0] == []: # Timeout - return + global myStats - timeReceived = time.time() - recPacket, addr = my_socket.recvfrom(1024) - icmpHeader = recPacket[20:28] - type, code, checksum, packetID, sequence = struct.unpack( - "bbHHh", icmpHeader - ) - if packetID == ID: - bytesInDouble = struct.calcsize("d") - timeSent = struct.unpack("d", recPacket[28:28 + bytesInDouble])[0] - return timeReceived - timeSent + delay = None - timeLeft = timeLeft - howLongInSelect - if timeLeft <= 0: - return + try: # One could use UDP here, but it's obscure + mySocket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) + except socket.error as e: + print("failed. (socket error: '%s')" % e.args[1]) + raise # raise the original error + + my_ID = os.getpid() & 0xFFFF + + sentTime = send_one_ping(mySocket, destIP, my_ID, mySeqNumber, numDataBytes) + if sentTime == None: + mySocket.close() + return delay + + myStats.pktsSent += 1; + recvTime, dataSize, iphSrcIP, icmpSeqNumber, iphTTL = receive_one_ping(mySocket, my_ID, timeout) -def send_one_ping(my_socket, dest_addr, ID): + mySocket.close() + + if recvTime: + delay = (recvTime - sentTime) * 1000 + print("%d bytes from %s: icmp_seq=%d ttl=%d time=%d ms" % ( + dataSize, socket.inet_ntoa(struct.pack("!I", iphSrcIP)), icmpSeqNumber, iphTTL, delay) + ) + myStats.pktsRcvd += 1; + myStats.totTime += delay + if myStats.minTime > delay: + myStats.minTime = delay + if myStats.maxTime < delay: + myStats.maxTime = delay + else: + delay = None + print("Request timed out.") + + return delay + +#=============================================================================# +def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): """ - Send one ping to the given >dest_addr<. + Send one ping to the given >destIP<. """ - dest_addr = socket.gethostbyname(dest_addr) + destIP = socket.gethostbyname(destIP) # Header is type (8), code (8), checksum (16), id (16), sequence (16) - my_checksum = 0 + myChecksum = 0 # Make a dummy heder with a 0 checksum. - header = struct.pack("bbHHh", ICMP_ECHO_REQUEST, 0, my_checksum, ID, 1) - bytesInDouble = struct.calcsize("d") - data = (192 - bytesInDouble) * "Q" - data = struct.pack("d", time.time()) + data + header = struct.pack( + "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber + ) + + padBytes = [] + startVal = 0x42 + for i in range(startVal, startVal + (numDataBytes)): + padBytes += [(i & 0xff)] # Keep chars in the 0-255 range + data = bytes(padBytes) # Calculate the checksum on the data and the dummy header. - my_checksum = checksum(header + data) + myChecksum = checksum(header + data) # Checksum is in network order # Now that we have the right checksum, we put that in. It's just easier # to make up a new header than to stuff it into the dummy. header = struct.pack( - "bbHHh", ICMP_ECHO_REQUEST, 0, socket.htons(my_checksum), ID, 1 + "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber ) + packet = header + data - my_socket.sendto(packet, (dest_addr, 1)) # Don't know about the 1 + sendTime = time.time() + + try: + mySocket.sendto(packet, (destIP, 1)) # Port number is irrelevant for ICMP + except socket.error as e: + print("General failure (%s)" % (e.args[1])) + return -def do_one(dest_addr, timeout): + return sendTime + +#=============================================================================# +def receive_one_ping(mySocket, myID, timeout): """ - Returns either the delay (in seconds) or none on timeout. + Receive the ping from the socket. Timeout = in ms """ - icmp = socket.getprotobyname("icmp") - try: - my_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, icmp) - except socket.error, (errno, msg): - if errno == 1: - # Operation not permitted - msg = msg + ( - " - Note that ICMP messages can only be sent from processes" - " running as root." - ) - raise socket.error(msg) - raise # raise the original error + timeLeft = timeout / 1000 - my_ID = os.getpid() & 0xFFFF + while True: # Loop while waiting for packet or timeout + startedSelect = time.time() + whatReady = select.select([mySocket], [], [], timeLeft) + howLongInSelect = (time.time() - startedSelect) + if whatReady[0] == []: # Timeout + return None, 0, 0, 0, 0 - send_one_ping(my_socket, dest_addr, my_ID) - delay = receive_one_ping(my_socket, my_ID, timeout) + timeReceived = time.time() - my_socket.close() - return delay + recPacket, addr = mySocket.recvfrom(ICMP_MAX_RECV) + + ipHeader = recPacket[:20] + iphVersion, iphTypeOfSvc, iphLength, \ + iphID, iphFlags, iphTTL, iphProtocol, \ + iphChecksum, iphSrcIP, iphDestIP = struct.unpack( + "!BBHHHBBHII", ipHeader + ) + + icmpHeader = recPacket[20:28] + icmpType, icmpCode, icmpChecksum, \ + icmpPacketID, icmpSeqNumber = struct.unpack( + "!BBHHH", icmpHeader + ) + if icmpPacketID == myID: # Our packet + dataSize = len(recPacket) - 28 + return timeReceived, dataSize, iphSrcIP, icmpSeqNumber, iphTTL + + timeLeft = timeLeft - howLongInSelect + if timeLeft <= 0: + return None, 0, 0, 0, 0 -def verbose_ping(dest_addr, timeout=2, count=4): +#=============================================================================# +def dump_stats(): """ - Send >count< ping to >dest_addr< with the given >timeout< and display + Show stats when pings are done + """ + global myStats + + print("\n----%s MYPING Statistics----" % (myStats.thisIP)) + + if myStats.pktsSent > 0: + myStats.fracLoss = (myStats.pktsSent - myStats.pktsRcvd) / myStats.pktsSent + + print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( + myStats.pktsSent, myStats.pktsRcvd, 100.0 * myStats.fracLoss + )) + + if myStats.pktsRcvd > 0: + print("round-trip (ms) min/avg/max = %d/%0.1f/%d" % ( + myStats.minTime, myStats.totTime / myStats.pktsRcvd, myStats.maxTime + )) + + print() + return + +#=============================================================================# +def signal_handler(signum, frame): + """ + Handle exit via signals + """ + dump_stats() + print("\n(Terminated with signal %d)\n" % (signum)) + sys.exit(0) + +#=============================================================================# +def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): + """ + Send >count< ping to >destIP< with the given >timeout< and display the result. """ - for i in xrange(count): - print "ping %s..." % dest_addr, - try: - delay = do_one(dest_addr, timeout) - except socket.gaierror, e: - print "failed. (socket error: '%s')" % e[1] - break + global myStats + + signal.signal(signal.SIGINT, signal_handler) # Handle Ctrl-C + signal.signal(signal.SIGBREAK, signal_handler) # Handle Windows Ctrl-Break + + myStats = MyStats() # Reset the stats + + mySeqNumber = 0 # Starting value + + try: + destIP = socket.gethostbyname(hostname) + print("\nMYPING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) + except socket.gaierror as e: + print("\nMYPING: Unknown host: %s (%s)" % (hostname, e.args[1])) + print() + return + + myStats.thisIP = destIP + + for i in range(count): + delay = do_one(destIP, timeout, mySeqNumber, numDataBytes) if delay == None: - print "failed. (timeout within %ssec.)" % timeout - else: - delay = delay * 1000 - print "get ping in %0.4fms" % delay - print + delay = 0 + + mySeqNumber += 1 + + # Pause for the remainder of the MAX_SLEEP period (if applicable) + if (MAX_SLEEP > delay): + time.sleep((MAX_SLEEP - delay) / 1000) + dump_stats() +#=============================================================================# if __name__ == '__main__': + + # These should work: verbose_ping("heise.de") verbose_ping("google.com") - verbose_ping("a-test-url-taht-is-not-available.com") - verbose_ping("192.168.1.1") + + # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly + # to the local host, but 2.7 tries to resolve to the local *gateway*) + verbose_ping("localhost") + + # Should fail with 'getaddrinfo failed': + verbose_ping("foobar_url.foobar") + + # Should fail (timeout), but it depends on the local network: + verbose_ping("192.168.255.254") + + # Should fails with 'The requested address is not valid in its context': + verbose_ping("0.0.0.0") + +#=============================================================================# From 72883fbcf5018aa015b4e35a1661abc9fda97e16 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 12 Sep 2011 12:34:55 +0200 Subject: [PATCH 07/42] cleanup --- ping.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/ping.py b/ping.py index eea2097..039b158 100755 --- a/ping.py +++ b/ping.py @@ -1,4 +1,6 @@ #!/usr/bin/env python +# coding: utf-8 + """ A pure python ping implementation using raw sockets. @@ -90,12 +92,6 @@ Linux x86. Since I don't know just what's wrong, I'll swap the bytes always and then do an htons(). - Last commit info: - ~~~~~~~~~~~~~~~~~ - $LastChangedDate: $ - $Rev: $ - $Author: $ - =========================================================================== IP header info from RFC791 -> http://tools.ietf.org/html/rfc791) From f4225739226e520f64acda8c1bd83444185653a0 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 12 Sep 2011 12:52:50 +0200 Subject: [PATCH 08/42] Bugfixes + cleanup, tests with Ubuntu + Windows 7 --- ping.py | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/ping.py b/ping.py index 039b158..8b7ab91 100755 --- a/ping.py +++ b/ping.py @@ -35,6 +35,11 @@ Revision history ~~~~~~~~~~~~~~~~ + September 12, 2011 + -------------- + Bugfixes + cleanup by Jens Diemer + Tested with Ubuntu + Windows 7 + September 6, 2011 -------------- Cleanup by Martin Falatic. Restored lost comments and docs. Improved @@ -147,10 +152,10 @@ =========================================================================== """ -#=============================================================================# + import os, sys, socket, struct, select, time, signal -#=============================================================================# + # ICMP parameters ICMP_ECHOREPLY = 0 # Echo reply (per RFC792) @@ -170,7 +175,7 @@ class MyStats: myStats = MyStats # Used globally -#=============================================================================# + def checksum(source_string): """ A port of the functionality of in_cksum() from ping.c @@ -192,14 +197,14 @@ def checksum(source_string): else: loByte = source_string[count + 1] hiByte = source_string[count] - sum = sum + (hiByte * 256 + loByte) + sum = sum + (ord(hiByte) * 256 + ord(loByte)) count += 2 # Handle last byte if applicable (odd-number of bytes) # Endianness should be irrelevant in this case if countTo < len(source_string): # Check for odd length loByte = source_string[len(source_string) - 1] - sum += loByte + sum += ord(loByte) sum &= 0xffffffff # Truncate sum to 32 bits (a variance from ping.c, which # uses signed ints, but overflow is unlikely in ping) @@ -211,7 +216,7 @@ def checksum(source_string): return answer -#=============================================================================# + def do_one(destIP, timeout, mySeqNumber, numDataBytes): """ Returns either the delay (in ms) or None on timeout. @@ -222,8 +227,16 @@ def do_one(destIP, timeout, mySeqNumber, numDataBytes): try: # One could use UDP here, but it's obscure mySocket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) - except socket.error as e: - print("failed. (socket error: '%s')" % e.args[1]) + except socket.error, (errno, msg): + if errno == 1: + # Operation not permitted - Add more information to traceback + etype, evalue, etb = sys.exc_info() + evalue = etype( + "%s - Note that ICMP messages can only be sent from processes running as root." % evalue + ) + raise etype, evalue, etb + + print("failed. (socket error: '%s')" % msg) raise # raise the original error my_ID = os.getpid() & 0xFFFF @@ -256,7 +269,7 @@ def do_one(destIP, timeout, mySeqNumber, numDataBytes): return delay -#=============================================================================# + def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): """ Send one ping to the given >destIP<. @@ -298,7 +311,7 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): return sendTime -#=============================================================================# + def receive_one_ping(mySocket, myID, timeout): """ Receive the ping from the socket. Timeout = in ms @@ -337,14 +350,14 @@ def receive_one_ping(mySocket, myID, timeout): if timeLeft <= 0: return None, 0, 0, 0, 0 -#=============================================================================# + def dump_stats(): """ Show stats when pings are done """ global myStats - print("\n----%s MYPING Statistics----" % (myStats.thisIP)) + print("\n----%s PYTHON PING Statistics----" % (myStats.thisIP)) if myStats.pktsSent > 0: myStats.fracLoss = (myStats.pktsSent - myStats.pktsRcvd) / myStats.pktsSent @@ -361,7 +374,7 @@ def dump_stats(): print() return -#=============================================================================# + def signal_handler(signum, frame): """ Handle exit via signals @@ -370,7 +383,7 @@ def signal_handler(signum, frame): print("\n(Terminated with signal %d)\n" % (signum)) sys.exit(0) -#=============================================================================# + def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): """ Send >count< ping to >destIP< with the given >timeout< and display @@ -379,7 +392,9 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): global myStats signal.signal(signal.SIGINT, signal_handler) # Handle Ctrl-C - signal.signal(signal.SIGBREAK, signal_handler) # Handle Windows Ctrl-Break + if hasattr(signal, "SIGBREAK"): + # Handle Ctrl-Break e.g. under Windows + signal.signal(signal.SIGBREAK, signal_handler) myStats = MyStats() # Reset the stats @@ -387,9 +402,9 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): try: destIP = socket.gethostbyname(hostname) - print("\nMYPING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) + print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) except socket.gaierror as e: - print("\nMYPING: Unknown host: %s (%s)" % (hostname, e.args[1])) + print("\nPYTHON-PING: Unknown host: %s (%s)" % (hostname, e.args[1])) print() return @@ -409,9 +424,8 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): dump_stats() -#=============================================================================# -if __name__ == '__main__': +if __name__ == '__main__': # These should work: verbose_ping("heise.de") verbose_ping("google.com") @@ -429,4 +443,4 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): # Should fails with 'The requested address is not valid in its context': verbose_ping("0.0.0.0") -#=============================================================================# + From 1b596651e61cad83c1d8e06a93493e0cdde5a644 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 14:45:24 +0200 Subject: [PATCH 09/42] Add eclipse config --- .project | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 .project diff --git a/.project b/.project new file mode 100644 index 0000000..6695946 --- /dev/null +++ b/.project @@ -0,0 +1,17 @@ + + + python-ping + + + + + + org.python.pydev.PyDevBuilder + + + + + + org.python.pydev.pythonNature + + From 4c24a783616d6f2319e6f72288ae8ae1bd97563d Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 14:45:31 +0200 Subject: [PATCH 10/42] change README --- README | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README b/README index 1488af0..5ebe26a 100644 --- a/README +++ b/README @@ -1,2 +1,4 @@ -Originally from http://svn.pylucid.net/pylucid/CodeSnippets/ping.py -This version maintained at http://github.com/samuel/python-ping \ No newline at end of file +A pure python ping implementation using raw sockets. + +Note that ICMP messages can only be sent from processes running as root +(in Windows, you must run this script as 'Administrator'). \ No newline at end of file From c43597d88d89e5e32999cc82a3139ade99a65098 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 15:59:07 +0200 Subject: [PATCH 11/42] * move Stuff from DocString into seperate files * add a simple CLI - TODO: create a real one --- AUTHORS | 12 +++ HISTORY | 83 ++++++++++++++++++++ LICENSE | 11 +++ ping.py | 181 ++++++------------------------------------- ping_header_info.txt | 50 ++++++++++++ 5 files changed, 179 insertions(+), 158 deletions(-) create mode 100644 AUTHORS create mode 100644 HISTORY create mode 100644 LICENSE create mode 100644 ping_header_info.txt diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..fbaa2f6 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,12 @@ + +AUTHORS / CONTRIBUTORS (alphabetic order): + + * Cowles, Matthew Dixon -- ftp://ftp.visi.com/users/mdc/ping.py + * Diemer, Jens -- http://www.jensdiemer.de + * Falatic, Martin -- http://www.falatic.com + * Hallman, Chris -- http://cdhallman.blogspot.com + * Notaras, George -- http://www.g-loaded.eu + * Poincheval, Jerome + * Stauffer, Samuel + * Zach Ware + diff --git a/HISTORY b/HISTORY new file mode 100644 index 0000000..cfba9c4 --- /dev/null +++ b/HISTORY @@ -0,0 +1,83 @@ +Original Version from Matthew Dixon Cowles: + -> ftp://ftp.visi.com/users/mdc/ping.py + +Rewrite by Jens Diemer: + -> http://www.python-forum.de/post-69122.html#69122 + +Rewrite by George Notaras: + -> http://www.g-loaded.eu/2009/10/30/python-ping/ + +Enhancements by Martin Falatic: + -> http://www.falatic.com/index.php/39/pinging-with-python + + +Revision history +~~~~~~~~~~~~~~~~ + +September 12, 2011 +-------------- +Bugfixes + cleanup by Jens Diemer +Tested with Ubuntu + Windows 7 + +September 6, 2011 +-------------- +Cleanup by Martin Falatic. Restored lost comments and docs. Improved +functionality: constant time between pings, internal times consistently +use milliseconds. Clarified annotations (e.g., in the checksum routine). +Using unsigned data in IP & ICMP header pack/unpack unless otherwise +necessary. Signal handling. Ping-style output formatting and stats. + +August 3, 2011 +-------------- +Ported to py3k by Zach Ware. Mostly done by 2to3; also minor changes to +deal with bytes vs. string changes (no more ord() in checksum() because +>source_string< is actually bytes, added .encode() to data in +send_one_ping()). That's about it. + +March 11, 2010 +-------------- +changes by Samuel Stauffer: +- replaced time.clock with default_timer which is set to + time.clock on windows and time.time on other systems. + +November 8, 2009 +---------------- +Improved compatibility with GNU/Linux systems. + +Fixes by: + * George Notaras -- http://www.g-loaded.eu +Reported by: + * Chris Hallman -- http://cdhallman.blogspot.com + +Changes in this release: + - Re-use time.time() instead of time.clock(). The 2007 implementation + worked only under Microsoft Windows. Failed on GNU/Linux. + time.clock() behaves differently under the two OSes[1]. + +[1] http://docs.python.org/library/time.html#time.clock + +May 30, 2007 +------------ +little rewrite by Jens Diemer: + - change socket asterisk import to a normal import + - replace time.time() with time.clock() + - delete "return None" (or change to "return" only) + - in checksum() rename "str" to "source_string" + +December 4, 2000 +---------------- +Changed the struct.pack() calls to pack the checksum and ID as +unsigned. My thanks to Jerome Poincheval for the fix. + +November 22, 1997 +----------------- +Initial hack. Doesn't do much, but rather than try to guess +what features I (or others) will want in the future, I've only +put in what I need now. + +December 16, 1997 +----------------- +For some reason, the checksum bytes are in the wrong order when +this is run under Solaris 2.X for SPARC but it works right under +Linux x86. Since I don't know just what's wrong, I'll swap the +bytes always and then do an htons(). \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cc1267 --- /dev/null +++ b/LICENSE @@ -0,0 +1,11 @@ +The original code derived from ping.c distributed in Linux's netkit. +That code is copyright (c) 1989 by The Regents of the University of California. +That code is in turn derived from code written by Mike Muuss of the +US Army Ballistic Research Laboratory in December, 1983 and +placed in the public domain. They have my thanks. + +Copyright (c) Matthew Dixon Cowles, . +Distributable under the terms of the GNU General Public License +version 2. Provided with no warranties of any sort. + +See AUTHORS for complete list of authors and contributors. \ No newline at end of file diff --git a/ping.py b/ping.py index 19550a1..e9e05f1 100755 --- a/ping.py +++ b/ping.py @@ -7,155 +7,12 @@ Note that ICMP messages can only be sent from processes running as root (in Windows, you must run this script as 'Administrator'). - Derived from ping.c distributed in Linux's netkit. That code is - copyright (c) 1989 by The Regents of the University of California. - That code is in turn derived from code written by Mike Muuss of the - US Army Ballistic Research Laboratory in December, 1983 and - placed in the public domain. They have my thanks. - Bugs are naturally mine. I'd be glad to hear about them. There are certainly word - size dependencies here. - - Copyright (c) Matthew Dixon Cowles, . - Distributable under the terms of the GNU General Public License - version 2. Provided with no warranties of any sort. - - Original Version from Matthew Dixon Cowles: - -> ftp://ftp.visi.com/users/mdc/ping.py - - Rewrite by Jens Diemer: - -> http://www.python-forum.de/post-69122.html#69122 - - Rewrite by George Notaras: - -> http://www.g-loaded.eu/2009/10/30/python-ping/ - - Enhancements by Martin Falatic: - -> http://www.falatic.com/index.php/39/pinging-with-python - - Revision history - ~~~~~~~~~~~~~~~~ - - September 12, 2011 - -------------- - Bugfixes + cleanup by Jens Diemer - Tested with Ubuntu + Windows 7 - September 6, 2011 - -------------- - Cleanup by Martin Falatic. Restored lost comments and docs. Improved - functionality: constant time between pings, internal times consistently - use milliseconds. Clarified annotations (e.g., in the checksum routine). - Using unsigned data in IP & ICMP header pack/unpack unless otherwise - necessary. Signal handling. Ping-style output formatting and stats. - - August 3, 2011 - -------------- - Ported to py3k by Zach Ware. Mostly done by 2to3; also minor changes to - deal with bytes vs. string changes (no more ord() in checksum() because - >source_string< is actually bytes, added .encode() to data in - send_one_ping()). That's about it. - - March 11, 2010 - -------------- - changes by Samuel Stauffer: - - replaced time.clock with default_timer which is set to - time.clock on windows and time.time on other systems. - - November 8, 2009 - ---------------- - Improved compatibility with GNU/Linux systems. - - Fixes by: - * George Notaras -- http://www.g-loaded.eu - Reported by: - * Chris Hallman -- http://cdhallman.blogspot.com - - Changes in this release: - - Re-use time.time() instead of time.clock(). The 2007 implementation - worked only under Microsoft Windows. Failed on GNU/Linux. - time.clock() behaves differently under the two OSes[1]. - - [1] http://docs.python.org/library/time.html#time.clock - - May 30, 2007 - ------------ - little rewrite by Jens Diemer: - - change socket asterisk import to a normal import - - replace time.time() with time.clock() - - delete "return None" (or change to "return" only) - - in checksum() rename "str" to "source_string" - - December 4, 2000 - ---------------- - Changed the struct.pack() calls to pack the checksum and ID as - unsigned. My thanks to Jerome Poincheval for the fix. - - November 22, 1997 - ----------------- - Initial hack. Doesn't do much, but rather than try to guess - what features I (or others) will want in the future, I've only - put in what I need now. - - December 16, 1997 - ----------------- - For some reason, the checksum bytes are in the wrong order when - this is run under Solaris 2.X for SPARC but it works right under - Linux x86. Since I don't know just what's wrong, I'll swap the - bytes always and then do an htons(). - - =========================================================================== - IP header info from RFC791 - -> http://tools.ietf.org/html/rfc791) - - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - |Version| IHL |Type of Service| Total Length | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Identification |Flags| Fragment Offset | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Time to Live | Protocol | Header Checksum | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Source Address | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Destination Address | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Options | Padding | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - - =========================================================================== - ICMP Echo / Echo Reply Message header info from RFC792 - -> http://tools.ietf.org/html/rfc792 - - 0 1 2 3 - 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Type | Code | Checksum | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Identifier | Sequence Number | - +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ - | Data ... - +-+-+-+-+- - - =========================================================================== - ICMP parameter info: - -> http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xml - - =========================================================================== - An example of ping's typical output: - - PING heise.de (193.99.144.80): 56 data bytes - 64 bytes from 193.99.144.80: icmp_seq=0 ttl=240 time=127 ms - 64 bytes from 193.99.144.80: icmp_seq=1 ttl=240 time=127 ms - 64 bytes from 193.99.144.80: icmp_seq=2 ttl=240 time=126 ms - 64 bytes from 193.99.144.80: icmp_seq=3 ttl=240 time=126 ms - 64 bytes from 193.99.144.80: icmp_seq=4 ttl=240 time=127 ms - - ----heise.de PING Statistics---- - 5 packets transmitted, 5 packets received, 0.0% packet loss - round-trip (ms) min/avg/max/med = 126/127/127/127 - - =========================================================================== + :homepage: https://github.com/jedie/python-ping/ + :copyleft: 1989-2011 by the python-ping team, see AUTHORS for more details. + :license: GNU GPL v2, see LICENSE for more details. """ @@ -440,21 +297,29 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): if __name__ == '__main__': - # These should work: - verbose_ping("heise.de") - verbose_ping("google.com") + # FIXME: Add a real CLI + if len(sys.argv) == 0: + print "DEMO" - # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly - # to the local host, but 2.7 tries to resolve to the local *gateway*) - verbose_ping("localhost") + # These should work: + verbose_ping("heise.de") + verbose_ping("google.com") - # Should fail with 'getaddrinfo failed': - verbose_ping("foobar_url.foobar") + # Inconsistent on Windows w/ ActivePython (Python 3.2 resolves correctly + # to the local host, but 2.7 tries to resolve to the local *gateway*) + verbose_ping("localhost") - # Should fail (timeout), but it depends on the local network: - verbose_ping("192.168.255.254") + # Should fail with 'getaddrinfo failed': + verbose_ping("foobar_url.foobar") - # Should fails with 'The requested address is not valid in its context': - verbose_ping("0.0.0.0") + # Should fail (timeout), but it depends on the local network: + verbose_ping("192.168.255.254") + + # Should fails with 'The requested address is not valid in its context': + verbose_ping("0.0.0.0") + elif len(sys.argv) == 2: + verbose_ping(sys.argv[1]) + else: + print "Error: call ./ping.py domain.tld" diff --git a/ping_header_info.txt b/ping_header_info.txt new file mode 100644 index 0000000..371c729 --- /dev/null +++ b/ping_header_info.txt @@ -0,0 +1,50 @@ +IP header info from RFC791 + -> http://tools.ietf.org/html/rfc791) + +0 1 2 3 +0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +|Version| IHL |Type of Service| Total Length | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Identification |Flags| Fragment Offset | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Time to Live | Protocol | Header Checksum | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Source Address | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Destination Address | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +| Options | Padding | ++-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + +=========================================================================== +ICMP Echo / Echo Reply Message header info from RFC792 + -> http://tools.ietf.org/html/rfc792 + + 0 1 2 3 + 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Type | Code | Checksum | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Identifier | Sequence Number | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | Data ... + +-+-+-+-+- + +=========================================================================== +ICMP parameter info: + -> http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xml + +=========================================================================== +An example of ping's typical output: + +PING heise.de (193.99.144.80): 56 data bytes +64 bytes from 193.99.144.80: icmp_seq=0 ttl=240 time=127 ms +64 bytes from 193.99.144.80: icmp_seq=1 ttl=240 time=127 ms +64 bytes from 193.99.144.80: icmp_seq=2 ttl=240 time=126 ms +64 bytes from 193.99.144.80: icmp_seq=3 ttl=240 time=126 ms +64 bytes from 193.99.144.80: icmp_seq=4 ttl=240 time=127 ms + +----heise.de PING Statistics---- +5 packets transmitted, 5 packets received, 0.0% packet loss +round-trip (ms) min/avg/max/med = 126/127/127/127 \ No newline at end of file From 0485d31001617e173f52dd498e1fea01c7ecce39 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 15:59:21 +0200 Subject: [PATCH 12/42] add some information into README --- README | 4 ---- README.creole | 25 +++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 4 deletions(-) delete mode 100644 README create mode 100644 README.creole diff --git a/README b/README deleted file mode 100644 index 5ebe26a..0000000 --- a/README +++ /dev/null @@ -1,4 +0,0 @@ -A pure python ping implementation using raw sockets. - -Note that ICMP messages can only be sent from processes running as root -(in Windows, you must run this script as 'Administrator'). \ No newline at end of file diff --git a/README.creole b/README.creole new file mode 100644 index 0000000..aad53fb --- /dev/null +++ b/README.creole @@ -0,0 +1,25 @@ +A pure python ping implementation using raw sockets. + +Note that ICMP messages can only be sent from processes running as root +(in Windows, you must run this script as 'Administrator'). + +=== usage === + +{{{ +~/python-ping$ sudo ./ping.py google.com + +PYTHON-PING google.com (74.125.39.147): 55 data bytes +64 bytes from 74.125.39.147: icmp_seq=0 ttl=53 time=23 ms +64 bytes from 74.125.39.147: icmp_seq=1 ttl=52 time=20 ms +64 bytes from 74.125.39.147: icmp_seq=2 ttl=53 time=22 ms + +----74.125.39.147 PYTHON PING Statistics---- +3 packets transmitted, 3 packets received, 0.0% packet loss +round-trip (ms) min/avg/max = 20/22.4/23 +}}} + +=== TODOs === + +* refactor ping.py +* create a CLI interface +* add a "suprocess ping", with output parser \ No newline at end of file From a876bacd7a72490fd578bf340fce5c4fdab5b4b7 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 15:59:31 +0200 Subject: [PATCH 13/42] create a setup.py --- MANIFEST.in | 4 ++ setup.py | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 130 insertions(+) create mode 100644 MANIFEST.in create mode 100755 setup.py diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..cb46d09 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,4 @@ +include AUTHORS HISTORY LICENSE MANIFEST.in README.creole +recursive-include *.py +recursive-exclude * *.pyc +recursive-exclude * *.pyo \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..8dba88e --- /dev/null +++ b/setup.py @@ -0,0 +1,126 @@ +#!/usr/bin/env python +# coding: utf-8 + +""" + distutils setup + ~~~~~~~~~~~~~~~ + + :homepage: https://github.com/jedie/python-ping/ + :copyleft: 1989-2011 by the python-ping team, see AUTHORS for more details. + :license: GNU GPL v2, see LICENSE for more details. +""" + +import os +import subprocess +import sys +import time +import warnings + +from setuptools import setup, find_packages, Command + +PACKAGE_ROOT = os.path.dirname(os.path.abspath(__file__)) + + +#VERBOSE = True +VERBOSE = False + +def _error(msg): + if VERBOSE: + warnings.warn(msg) + return "" + +def get_version_from_git(): + try: + process = subprocess.Popen( + # %ct: committer date, UNIX timestamp + ["/usr/bin/git", "log", "--pretty=format:%ct-%h", "-1", "HEAD"], + shell=False, cwd=PACKAGE_ROOT, + stdout=subprocess.PIPE, stderr=subprocess.PIPE, + ) + except Exception, err: + return _error("Can't get git hash: %s" % err) + + process.wait() + returncode = process.returncode + if returncode != 0: + return _error( + "Can't get git hash, returncode was: %r" + " - git stdout: %r" + " - git stderr: %r" + % (returncode, process.stdout.readline(), process.stderr.readline()) + ) + + output = process.stdout.readline().strip() + try: + raw_timestamp, hash = output.split("-", 1) + timestamp = int(raw_timestamp) + except Exception, err: + return _error("Error in git log output! Output was: %r" % output) + + try: + timestamp_formatted = time.strftime("%Y.%m.%d", time.gmtime(timestamp)) + except Exception, err: + return _error("can't convert %r to time string: %s" % (timestamp, err)) + + return "%s.%s" % (timestamp_formatted, hash) + + +# convert creole to ReSt on-the-fly, see also: +# https://code.google.com/p/python-creole/wiki/UseInSetup +try: + from creole.setup_utils import get_long_description +except ImportError: + if "register" in sys.argv or "sdist" in sys.argv or "--long-description" in sys.argv: + etype, evalue, etb = sys.exc_info() + evalue = etype("%s - Please install python-creole >= v0.8 - e.g.: pip install python-creole" % evalue) + raise etype, evalue, etb + long_description = None +else: + long_description = get_long_description(PACKAGE_ROOT) + + +def get_authors(): + authors = [] + try: + f = file(os.path.join(PACKAGE_ROOT, "AUTHORS"), "r") + for line in f: + if not line.strip().startswith("*"): + continue + if "--" in line: + line = line.split("--", 1)[0] + authors.append(line.strip(" *\r\n")) + f.close() + authors.sort() + except Exception, err: + authors = "[Error: %s]" % err + return authors + + +setup( + name='python-ping', + version=get_version_from_git(), + description='A pure python ICMP ping implementation using raw sockets.', + long_description=long_description, + author=get_authors(), + maintainer="Jens Diemer", + maintainer_email="python-ping@jensdiemer.de", + url='https://github.com/jedie/python-ping/', + packages=find_packages(), + include_package_data=True, # include package data under svn source control + zip_safe=False, + classifiers=[ + # http://pypi.python.org/pypi?%3Aaction=list_classifiers +# "Development Status :: 4 - Beta", + "Development Status :: 5 - Production/Stable", + "Environment :: Web Environment", + "Intended Audience :: Developers", + "Intended Audience :: Education", + "Intended Audience :: End Users/Desktop", + "License :: OSI Approved :: GNU General Public License (GPL)", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Topic :: Internet", + "Topic :: Software Development :: Libraries :: Python Modules", + "Topic :: System :: Networking :: Monitoring", + ], +) From cf3c716605a80c4e70567abbabeb80b23244b103 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 16:11:41 +0200 Subject: [PATCH 14/42] put HISTORY into README --- HISTORY | 83 --------------------------------------------------- README.creole | 76 ++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 74 insertions(+), 85 deletions(-) delete mode 100644 HISTORY diff --git a/HISTORY b/HISTORY deleted file mode 100644 index cfba9c4..0000000 --- a/HISTORY +++ /dev/null @@ -1,83 +0,0 @@ -Original Version from Matthew Dixon Cowles: - -> ftp://ftp.visi.com/users/mdc/ping.py - -Rewrite by Jens Diemer: - -> http://www.python-forum.de/post-69122.html#69122 - -Rewrite by George Notaras: - -> http://www.g-loaded.eu/2009/10/30/python-ping/ - -Enhancements by Martin Falatic: - -> http://www.falatic.com/index.php/39/pinging-with-python - - -Revision history -~~~~~~~~~~~~~~~~ - -September 12, 2011 --------------- -Bugfixes + cleanup by Jens Diemer -Tested with Ubuntu + Windows 7 - -September 6, 2011 --------------- -Cleanup by Martin Falatic. Restored lost comments and docs. Improved -functionality: constant time between pings, internal times consistently -use milliseconds. Clarified annotations (e.g., in the checksum routine). -Using unsigned data in IP & ICMP header pack/unpack unless otherwise -necessary. Signal handling. Ping-style output formatting and stats. - -August 3, 2011 --------------- -Ported to py3k by Zach Ware. Mostly done by 2to3; also minor changes to -deal with bytes vs. string changes (no more ord() in checksum() because ->source_string< is actually bytes, added .encode() to data in -send_one_ping()). That's about it. - -March 11, 2010 --------------- -changes by Samuel Stauffer: -- replaced time.clock with default_timer which is set to - time.clock on windows and time.time on other systems. - -November 8, 2009 ----------------- -Improved compatibility with GNU/Linux systems. - -Fixes by: - * George Notaras -- http://www.g-loaded.eu -Reported by: - * Chris Hallman -- http://cdhallman.blogspot.com - -Changes in this release: - - Re-use time.time() instead of time.clock(). The 2007 implementation - worked only under Microsoft Windows. Failed on GNU/Linux. - time.clock() behaves differently under the two OSes[1]. - -[1] http://docs.python.org/library/time.html#time.clock - -May 30, 2007 ------------- -little rewrite by Jens Diemer: - - change socket asterisk import to a normal import - - replace time.time() with time.clock() - - delete "return None" (or change to "return" only) - - in checksum() rename "str" to "source_string" - -December 4, 2000 ----------------- -Changed the struct.pack() calls to pack the checksum and ID as -unsigned. My thanks to Jerome Poincheval for the fix. - -November 22, 1997 ------------------ -Initial hack. Doesn't do much, but rather than try to guess -what features I (or others) will want in the future, I've only -put in what I need now. - -December 16, 1997 ------------------ -For some reason, the checksum bytes are in the wrong order when -this is run under Solaris 2.X for SPARC but it works right under -Linux x86. Since I don't know just what's wrong, I'll swap the -bytes always and then do an htons(). \ No newline at end of file diff --git a/README.creole b/README.creole index aad53fb..3c4a2bf 100644 --- a/README.creole +++ b/README.creole @@ -3,6 +3,12 @@ A pure python ping implementation using raw sockets. Note that ICMP messages can only be sent from processes running as root (in Windows, you must run this script as 'Administrator'). +Original Version from [[ftp://ftp.visi.com/users/mdc/ping.py|Matthew Dixon Cowles]] + +* copyleft 1989-2011 by the python-ping team, see [[https://github.com/jedie/python-ping/blob/master/AUTHORS|AUTHORS]] for more details. +* license: GNU GPL v2, see [[https://github.com/jedie/python-ping/blob/master/LICENSE|LICENSE]] for more details. + + === usage === {{{ @@ -18,8 +24,74 @@ PYTHON-PING google.com (74.125.39.147): 55 data bytes round-trip (ms) min/avg/max = 20/22.4/23 }}} -=== TODOs === + +== TODOs == * refactor ping.py * create a CLI interface -* add a "suprocess ping", with output parser \ No newline at end of file +* add a "suprocess ping", with output parser + +== Revision history == + +==== Oct. 12, 2011 ==== +Merge sources and create a seperate github repository: +* https://github.com/jedie/python-ping + +Add a simple CLI interface. + +==== September 12, 2011 ==== +Bugfixes + cleanup by Jens Diemer +Tested with Ubuntu + Windows 7 + +==== September 6, 2011 ==== +[[http://www.falatic.com/index.php/39/pinging-with-python|Cleanup by Martin Falatic.]] +Restored lost comments and docs. Improved functionality: constant time between +pings, internal times consistently use milliseconds. Clarified annotations +(e.g., in the checksum routine). Using unsigned data in IP & ICMP header +pack/unpack unless otherwise necessary. Signal handling. Ping-style output +formatting and stats. + +==== August 3, 2011 ==== +Ported to py3k by Zach Ware. Mostly done by 2to3; also minor changes to +deal with bytes vs. string changes (no more ord() in checksum() because +>source_string< is actually bytes, added .encode() to data in +send_one_ping()). That's about it. + +==== March 11, 2010 ==== +changes by Samuel Stauffer: +replaced time.clock with default_timer which is set to +time.clock on windows and time.time on other systems. + +==== November 8, 2009 ==== +Fixes by [[http://www.g-loaded.eu/2009/10/30/python-ping/|George Notaras]], +reported by [[http://cdhallman.blogspot.com|Chris Hallman]]: + +Improved compatibility with GNU/Linux systems. + +Changes in this release: + +Re-use time.time() instead of time.clock(). The 2007 implementation +worked only under Microsoft Windows. Failed on GNU/Linux. +time.clock() behaves differently under [[http://docs.python.org/library/time.html#time.clock|the two OSes]]. + +==== May 30, 2007 ==== +little [[http://www.python-forum.de/post-69122.html#69122|rewrite by Jens Diemer]]: + * change socket asterisk import to a normal import + * replace time.time() with time.clock() + * delete "return None" (or change to "return" only) + * in checksum() rename "str" to "source_string" + +==== December 4, 2000 ==== +Changed the struct.pack() calls to pack the checksum and ID as +unsigned. My thanks to Jerome Poincheval for the fix. + +==== November 22, 1997 ==== +Initial hack. Doesn't do much, but rather than try to guess +what features I (or others) will want in the future, I've only +put in what I need now. + +==== December 16, 1997 ==== +For some reason, the checksum bytes are in the wrong order when +this is run under Solaris 2.X for SPARC but it works right under +Linux x86. Since I don't know just what's wrong, I'll swap the +bytes always and then do an htons(). From 11fc9f7c7f3b6ce07092060c3d2cf3f2a8783ea4 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 16:11:55 +0200 Subject: [PATCH 15/42] remove --- MANIFEST.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MANIFEST.in b/MANIFEST.in index cb46d09..244d0be 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include AUTHORS HISTORY LICENSE MANIFEST.in README.creole +include AUTHORS LICENSE MANIFEST.in README.creole recursive-include *.py recursive-exclude * *.pyc recursive-exclude * *.pyo \ No newline at end of file From 40a509efb7a865528022c29a4cee3aff34453b83 Mon Sep 17 00:00:00 2001 From: zed Date: Wed, 12 Oct 2011 18:11:58 +0400 Subject: [PATCH 16/42] actually use defined default_timer() instead of time.time() --- ping.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/ping.py b/ping.py index e9e05f1..739cdf1 100755 --- a/ping.py +++ b/ping.py @@ -172,7 +172,7 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): packet = header + data - sendTime = time.time() + sendTime = default_timer() try: mySocket.sendto(packet, (destIP, 1)) # Port number is irrelevant for ICMP @@ -190,13 +190,13 @@ def receive_one_ping(mySocket, myID, timeout): timeLeft = timeout / 1000 while True: # Loop while waiting for packet or timeout - startedSelect = time.time() + startedSelect = default_timer() whatReady = select.select([mySocket], [], [], timeLeft) - howLongInSelect = (time.time() - startedSelect) + howLongInSelect = (default_timer() - startedSelect) if whatReady[0] == []: # Timeout return None, 0, 0, 0, 0 - timeReceived = time.time() + timeReceived = default_timer() recPacket, addr = mySocket.recvfrom(ICMP_MAX_RECV) @@ -321,5 +321,3 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): verbose_ping(sys.argv[1]) else: print "Error: call ./ping.py domain.tld" - - From a100a2dfa3425061196069192a0cc590563be9bd Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 16:19:45 +0200 Subject: [PATCH 17/42] add \"zed\" see: https://github.com/jedie/python-ping/pull/2 --- AUTHORS | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORS b/AUTHORS index fbaa2f6..1418452 100644 --- a/AUTHORS +++ b/AUTHORS @@ -9,4 +9,5 @@ AUTHORS / CONTRIBUTORS (alphabetic order): * Poincheval, Jerome * Stauffer, Samuel * Zach Ware + * zed -- https://github.com/zed From 4d170546a7aefd46cd3ec64006bb9c0101dcb9b2 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Wed, 12 Oct 2011 19:04:37 +0300 Subject: [PATCH 18/42] add FIXME: Don't use global --- ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 739cdf1..380653b 100755 --- a/ping.py +++ b/ping.py @@ -44,7 +44,7 @@ class MyStats: totTime = 0 fracLoss = 1.0 -myStats = MyStats # Used globally +myStats = MyStats # Used globally FIXME: Don't use global def checksum(source_string): From 51f5b32d549d6ab664a7417ec432ea5c7bd055ea Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Wed, 12 Oct 2011 19:13:24 +0300 Subject: [PATCH 19/42] IMHO not needed. --- ping.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/ping.py b/ping.py index 380653b..bd42911 100755 --- a/ping.py +++ b/ping.py @@ -145,8 +145,6 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): """ Send one ping to the given >destIP<. """ - destIP = socket.gethostbyname(destIP) - # Header is type (8), code (8), checksum (16), id (16), sequence (16) myChecksum = 0 @@ -273,6 +271,7 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): try: destIP = socket.gethostbyname(hostname) + # FIXME: Use destIP only for display this line here? see: https://github.com/jedie/python-ping/issues/3 print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) except socket.gaierror as e: print("\nPYTHON-PING: Unknown host: %s (%s)" % (hostname, e.args[1])) From dbf7d09da288626f202da6f22f2a8eaab0336e17 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Wed, 12 Oct 2011 19:14:53 +0300 Subject: [PATCH 20/42] print() -> print("") --- ping.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ping.py b/ping.py index bd42911..7a8b028 100755 --- a/ping.py +++ b/ping.py @@ -240,8 +240,7 @@ def dump_stats(): myStats.minTime, myStats.totTime / myStats.pktsRcvd, myStats.maxTime )) - print() - return + print("") def signal_handler(signum, frame): @@ -275,7 +274,7 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) except socket.gaierror as e: print("\nPYTHON-PING: Unknown host: %s (%s)" % (hostname, e.args[1])) - print() + print("") return myStats.thisIP = destIP From 5fae12da02d0ccee33d6dbe6724f1fd804661add Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Wed, 12 Oct 2011 19:19:15 +0300 Subject: [PATCH 21/42] Bugfix in stupid CLI solution. -> https://github.com/jedie/python-ping/issues/5 --- ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 7a8b028..ddab858 100755 --- a/ping.py +++ b/ping.py @@ -296,7 +296,7 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): if __name__ == '__main__': # FIXME: Add a real CLI - if len(sys.argv) == 0: + if len(sys.argv) == 1: print "DEMO" # These should work: From 7aa3e9cda7d4351c92618509683518582fab2646 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 18:21:54 +0200 Subject: [PATCH 22/42] add .gitignore --- .gitignore | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..611e05b --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +*.py[co] +*~ +*.egg-info +/dist +/build +.pydevproject +/.settings \ No newline at end of file From 1db163ba81ed49b2d924fd92072ed183bcc271f9 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Wed, 12 Oct 2011 19:26:24 +0300 Subject: [PATCH 23/42] add contribute --- README.creole | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.creole b/README.creole index 3c4a2bf..964e6a1 100644 --- a/README.creole +++ b/README.creole @@ -31,6 +31,12 @@ round-trip (ms) min/avg/max = 20/22.4/23 * create a CLI interface * add a "suprocess ping", with output parser + +== contribute == + +[[http://help.github.com/fork-a-repo/|Fork this repo]] on [[https://github.com/jedie/python-ping/|GitHub]] and [[http://help.github.com/send-pull-requests/|send pull requests]]. Thank you. + + == Revision history == ==== Oct. 12, 2011 ==== From bf82e931ba78693e1c97ac878b6386e9ea3a60a1 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 20:41:33 +0200 Subject: [PATCH 24/42] * refactor variable names * display some stats as float --- ping.py | 168 +++++++++++++++++++++++++++++--------------------------- 1 file changed, 86 insertions(+), 82 deletions(-) diff --git a/ping.py b/ping.py index ddab858..621ba60 100755 --- a/ping.py +++ b/ping.py @@ -4,7 +4,7 @@ """ A pure python ping implementation using raw sockets. - Note that ICMP messages can only be sent from processes running as root + Note that ICMP messages can only be send from processes running as root (in Windows, you must run this script as 'Administrator'). Bugs are naturally mine. I'd be glad to hear about them. There are @@ -35,16 +35,16 @@ MAX_SLEEP = 1000 -class MyStats: - thisIP = "0.0.0.0" - pktsSent = 0 - pktsRcvd = 0 - minTime = 999999999 - maxTime = 0 - totTime = 0 - fracLoss = 1.0 +class PingStats: + dest_ip = "0.0.0.0" + send_count = 0 + receive_count = 0 + min_time = 999999999 + max_time = 0 + total_time = 0 + lost_count = 1.0 -myStats = MyStats # Used globally FIXME: Don't use global +current_stats = PingStats # Used globally FIXME: Don't use global def checksum(source_string): @@ -87,53 +87,57 @@ def checksum(source_string): return answer +class PingBase(object): + def __init__(self, dest_ip): + self.dest_ip = dest_ip -def do_one(destIP, timeout, mySeqNumber, numDataBytes): + +def do_one(dest_ip, deadline, seq_number, packet_size): """ - Returns either the delay (in ms) or None on timeout. + Returns either the delay (in ms) or None on deadline. """ - global myStats + global current_stats delay = None try: # One could use UDP here, but it's obscure - mySocket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) + current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) except socket.error, (errno, msg): if errno == 1: # Operation not permitted - Add more information to traceback etype, evalue, etb = sys.exc_info() evalue = etype( - "%s - Note that ICMP messages can only be sent from processes running as root." % evalue + "%s - Note that ICMP messages can only be send from processes running as root." % evalue ) raise etype, evalue, etb print("failed. (socket error: '%s')" % msg) raise # raise the original error - my_ID = os.getpid() & 0xFFFF + own_id = os.getpid() & 0xFFFF - sentTime = send_one_ping(mySocket, destIP, my_ID, mySeqNumber, numDataBytes) - if sentTime == None: - mySocket.close() + send_time = send_one_ping(current_socket, dest_ip, own_id, seq_number, packet_size) + if send_time == None: + current_socket.close() return delay - myStats.pktsSent += 1; + current_stats.send_count += 1; - recvTime, dataSize, iphSrcIP, icmpSeqNumber, iphTTL = receive_one_ping(mySocket, my_ID, timeout) + receive_time, dataSize, ip_src_ip, icmp_seq_number, ip_ttl = receive_one_ping(current_socket, own_id, deadline) - mySocket.close() + current_socket.close() - if recvTime: - delay = (recvTime - sentTime) * 1000 - print("%d bytes from %s: icmp_seq=%d ttl=%d time=%d ms" % ( - dataSize, socket.inet_ntoa(struct.pack("!I", iphSrcIP)), icmpSeqNumber, iphTTL, delay) + if receive_time: + delay = (receive_time - send_time) * 1000.0 + print("%d bytes from %s: icmp_seq=%d ttl=%d time=%.1f ms" % ( + dataSize, socket.inet_ntoa(struct.pack("!I", ip_src_ip)), icmp_seq_number, ip_ttl, delay) ) - myStats.pktsRcvd += 1; - myStats.totTime += delay - if myStats.minTime > delay: - myStats.minTime = delay - if myStats.maxTime < delay: - myStats.maxTime = delay + current_stats.receive_count += 1; + current_stats.total_time += delay + if current_stats.min_time > delay: + current_stats.min_time = delay + if current_stats.max_time < delay: + current_stats.max_time = delay else: delay = None print("Request timed out.") @@ -141,21 +145,21 @@ def do_one(destIP, timeout, mySeqNumber, numDataBytes): return delay -def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): +def send_one_ping(current_socket, dest_ip, own_id, seq_number, packet_size): """ - Send one ping to the given >destIP<. + Send one ping to the given >dest_ip<. """ # Header is type (8), code (8), checksum (16), id (16), sequence (16) myChecksum = 0 # Make a dummy heder with a 0 checksum. header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber + "!BBHHH", ICMP_ECHO, 0, myChecksum, own_id, seq_number ) padBytes = [] startVal = 0x42 - for i in range(startVal, startVal + (numDataBytes)): + for i in range(startVal, startVal + (packet_size)): padBytes += [(i & 0xff)] # Keep chars in the 0-255 range data = bytes(padBytes) @@ -165,7 +169,7 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): # Now that we have the right checksum, we put that in. It's just easier # to make up a new header than to stuff it into the dummy. header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, myID, mySeqNumber + "!BBHHH", ICMP_ECHO, 0, myChecksum, own_id, seq_number ) packet = header + data @@ -173,7 +177,7 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): sendTime = default_timer() try: - mySocket.sendto(packet, (destIP, 1)) # Port number is irrelevant for ICMP + current_socket.sendto(packet, (dest_ip, 1)) # Port number is irrelevant for ICMP except socket.error as e: print("General failure (%s)" % (e.args[1])) return @@ -181,42 +185,42 @@ def send_one_ping(mySocket, destIP, myID, mySeqNumber, numDataBytes): return sendTime -def receive_one_ping(mySocket, myID, timeout): +def receive_one_ping(current_socket, own_id, deadline): """ - Receive the ping from the socket. Timeout = in ms + Receive the ping from the socket. deadline = in ms """ - timeLeft = timeout / 1000 + timeout = deadline / 1000 - while True: # Loop while waiting for packet or timeout - startedSelect = default_timer() - whatReady = select.select([mySocket], [], [], timeLeft) - howLongInSelect = (default_timer() - startedSelect) - if whatReady[0] == []: # Timeout + while True: # Loop while waiting for packet or deadline + select_start = default_timer() + inputready, outputready, exceptready = select.select([current_socket], [], [], timeout) + select_duration = (default_timer() - select_start) + if inputready == []: # deadline return None, 0, 0, 0, 0 - timeReceived = default_timer() + receive_time = default_timer() - recPacket, addr = mySocket.recvfrom(ICMP_MAX_RECV) + packet_data, address = current_socket.recvfrom(ICMP_MAX_RECV) - ipHeader = recPacket[:20] - iphVersion, iphTypeOfSvc, iphLength, \ - iphID, iphFlags, iphTTL, iphProtocol, \ - iphChecksum, iphSrcIP, iphDestIP = struct.unpack( - "!BBHHHBBHII", ipHeader + ip_header = packet_data[:20] + ip_version, ip_type, ip_length, \ + ip_id, ip_flags, ip_ttl, ip_protocol, \ + ip_checksum, ip_src_ip, ip_dest_ip = struct.unpack( + "!BBHHHBBHII", ip_header ) - icmpHeader = recPacket[20:28] - icmpType, icmpCode, icmpChecksum, \ - icmpPacketID, icmpSeqNumber = struct.unpack( - "!BBHHH", icmpHeader + icmp_header = packet_data[20:28] + icmp_type, icmp_code, icmp_checksum, \ + icmp_packet_id, icmp_seq_number = struct.unpack( + "!BBHHH", icmp_header ) - if icmpPacketID == myID: # Our packet - dataSize = len(recPacket) - 28 - return timeReceived, dataSize, iphSrcIP, icmpSeqNumber, iphTTL + if icmp_packet_id == own_id: # Our packet + dataSize = len(packet_data) - 28 + return receive_time, dataSize, ip_src_ip, icmp_seq_number, ip_ttl - timeLeft = timeLeft - howLongInSelect - if timeLeft <= 0: + timeout = timeout - select_duration + if timeout <= 0: return None, 0, 0, 0, 0 @@ -224,20 +228,20 @@ def dump_stats(): """ Show stats when pings are done """ - global myStats + global current_stats - print("\n----%s PYTHON PING Statistics----" % (myStats.thisIP)) + print("\n----%s PYTHON PING Statistics----" % (current_stats.dest_ip)) - if myStats.pktsSent > 0: - myStats.fracLoss = (myStats.pktsSent - myStats.pktsRcvd) / myStats.pktsSent + if current_stats.send_count > 0: + current_stats.lost_count = (current_stats.send_count - current_stats.receive_count) / current_stats.send_count print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( - myStats.pktsSent, myStats.pktsRcvd, 100.0 * myStats.fracLoss + current_stats.send_count, current_stats.receive_count, 100.0 * current_stats.lost_count )) - if myStats.pktsRcvd > 0: - print("round-trip (ms) min/avg/max = %d/%0.1f/%d" % ( - myStats.minTime, myStats.totTime / myStats.pktsRcvd, myStats.maxTime + if current_stats.receive_count > 0: + print("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f" % ( + current_stats.min_time, current_stats.total_time / current_stats.receive_count, current_stats.max_time )) print("") @@ -252,40 +256,40 @@ def signal_handler(signum, frame): sys.exit(0) -def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): +def verbose_ping(hostname, deadline=1000, count=3, packet_size=55): """ - Send >count< ping to >destIP< with the given >timeout< and display + Send >count< ping to >dest_ip< with the given >deadline< and display the result. """ - global myStats + global current_stats signal.signal(signal.SIGINT, signal_handler) # Handle Ctrl-C if hasattr(signal, "SIGBREAK"): # Handle Ctrl-Break e.g. under Windows signal.signal(signal.SIGBREAK, signal_handler) - myStats = MyStats() # Reset the stats + current_stats = PingStats() # Reset the stats - mySeqNumber = 0 # Starting value + seq_number = 0 # Starting value try: - destIP = socket.gethostbyname(hostname) - # FIXME: Use destIP only for display this line here? see: https://github.com/jedie/python-ping/issues/3 - print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, destIP, numDataBytes)) + dest_ip = socket.gethostbyname(hostname) + # FIXME: Use dest_ip only for display this line here? see: https://github.com/jedie/python-ping/issues/3 + print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, dest_ip, packet_size)) except socket.gaierror as e: print("\nPYTHON-PING: Unknown host: %s (%s)" % (hostname, e.args[1])) print("") return - myStats.thisIP = destIP + current_stats.dest_ip = dest_ip for i in range(count): - delay = do_one(destIP, timeout, mySeqNumber, numDataBytes) + delay = do_one(dest_ip, deadline, seq_number, packet_size) if delay == None: delay = 0 - mySeqNumber += 1 + seq_number += 1 # Pause for the remainder of the MAX_SLEEP period (if applicable) if (MAX_SLEEP > delay): @@ -310,7 +314,7 @@ def verbose_ping(hostname, timeout=1000, count=3, numDataBytes=55): # Should fail with 'getaddrinfo failed': verbose_ping("foobar_url.foobar") - # Should fail (timeout), but it depends on the local network: + # Should fail (deadline), but it depends on the local network: verbose_ping("192.168.255.254") # Should fails with 'The requested address is not valid in its context': From 55833fdee59c7fb4e9dc1ad29337941c3b7fcf86 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 21:53:36 +0200 Subject: [PATCH 25/42] move into a class --- ping.py | 375 +++++++++++++++++++++++++++++--------------------------- 1 file changed, 194 insertions(+), 181 deletions(-) diff --git a/ping.py b/ping.py index 621ba60..db59aa8 100755 --- a/ping.py +++ b/ping.py @@ -47,7 +47,7 @@ class PingStats: current_stats = PingStats # Used globally FIXME: Don't use global -def checksum(source_string): +def calculate_checksum(source_string): """ A port of the functionality of in_cksum() from ping.c Ideally this would act on the string as a series of 16-bit ints (host @@ -87,215 +87,228 @@ def checksum(source_string): return answer -class PingBase(object): - def __init__(self, dest_ip): - self.dest_ip = dest_ip - - -def do_one(dest_ip, deadline, seq_number, packet_size): - """ - Returns either the delay (in ms) or None on deadline. - """ - global current_stats - - delay = None - - try: # One could use UDP here, but it's obscure - current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) - except socket.error, (errno, msg): - if errno == 1: - # Operation not permitted - Add more information to traceback - etype, evalue, etb = sys.exc_info() - evalue = etype( - "%s - Note that ICMP messages can only be send from processes running as root." % evalue - ) - raise etype, evalue, etb - - print("failed. (socket error: '%s')" % msg) - raise # raise the original error - own_id = os.getpid() & 0xFFFF - send_time = send_one_ping(current_socket, dest_ip, own_id, seq_number, packet_size) - if send_time == None: - current_socket.close() - return delay - - current_stats.send_count += 1; - - receive_time, dataSize, ip_src_ip, icmp_seq_number, ip_ttl = receive_one_ping(current_socket, own_id, deadline) - - current_socket.close() - - if receive_time: - delay = (receive_time - send_time) * 1000.0 +class Ping(object): + def __init__(self, dest_ip, timeout=1000, packet_size=55, own_id=None): + self.dest_ip = dest_ip + self.timeout = timeout + self.packet_size = packet_size + if own_id is None: + self.own_id = os.getpid() & 0xFFFF + else: + self.own_id = own_id + + self.seq_number = 0 + self.send_count = 0 + self.receive_count = 0 + self.min_time = 999999999 + self.max_time = 0.0 + self.total_time = 0.0 + + #-------------------------------------------------------------------------- + + def start(self): + try: + ip = socket.gethostbyname(self.dest_ip) + # FIXME: Use dest_ip only for display this line here? see: https://github.com/jedie/python-ping/issues/3 + print("\nPYTHON-PING %s (%s): %d data bytes" % (self.dest_ip, ip, self.packet_size)) + except socket.gaierror as e: + print("\nPYTHON-PING: Unknown host: %s (%s)" % (self.dest_ip, e.args[1])) + print("") + sys.exit(-1) + + def success(self, delay, from_info, packet_size, ip_src_ip, icmp_seq_number, ip_ttl): print("%d bytes from %s: icmp_seq=%d ttl=%d time=%.1f ms" % ( - dataSize, socket.inet_ntoa(struct.pack("!I", ip_src_ip)), icmp_seq_number, ip_ttl, delay) + packet_size, from_info, icmp_seq_number, ip_ttl, delay) ) - current_stats.receive_count += 1; - current_stats.total_time += delay - if current_stats.min_time > delay: - current_stats.min_time = delay - if current_stats.max_time < delay: - current_stats.max_time = delay - else: - delay = None - print("Request timed out.") - - return delay - - -def send_one_ping(current_socket, dest_ip, own_id, seq_number, packet_size): - """ - Send one ping to the given >dest_ip<. - """ - # Header is type (8), code (8), checksum (16), id (16), sequence (16) - myChecksum = 0 - - # Make a dummy heder with a 0 checksum. - header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, own_id, seq_number - ) - - padBytes = [] - startVal = 0x42 - for i in range(startVal, startVal + (packet_size)): - padBytes += [(i & 0xff)] # Keep chars in the 0-255 range - data = bytes(padBytes) - - # Calculate the checksum on the data and the dummy header. - myChecksum = checksum(header + data) # Checksum is in network order - - # Now that we have the right checksum, we put that in. It's just easier - # to make up a new header than to stuff it into the dummy. - header = struct.pack( - "!BBHHH", ICMP_ECHO, 0, myChecksum, own_id, seq_number - ) - - packet = header + data - - sendTime = default_timer() - try: - current_socket.sendto(packet, (dest_ip, 1)) # Port number is irrelevant for ICMP - except socket.error as e: - print("General failure (%s)" % (e.args[1])) - return - - return sendTime + def failed(self): + print("Request timed out.") + def exit(self): + print("\n----%s PYTHON PING Statistics----" % (self.dest_ip)) -def receive_one_ping(current_socket, own_id, deadline): - """ - Receive the ping from the socket. deadline = in ms - """ - timeout = deadline / 1000 + if self.send_count > 0: + lost_rate = (self.send_count - self.receive_count) / self.send_count * 100.0 - while True: # Loop while waiting for packet or deadline - select_start = default_timer() - inputready, outputready, exceptready = select.select([current_socket], [], [], timeout) - select_duration = (default_timer() - select_start) - if inputready == []: # deadline - return None, 0, 0, 0, 0 + print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( + self.send_count, self.receive_count, lost_rate + )) - receive_time = default_timer() + if self.receive_count > 0: + print("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f" % ( + self.min_time, self.total_time / self.receive_count, self.max_time + )) - packet_data, address = current_socket.recvfrom(ICMP_MAX_RECV) + print("") - ip_header = packet_data[:20] - ip_version, ip_type, ip_length, \ - ip_id, ip_flags, ip_ttl, ip_protocol, \ - ip_checksum, ip_src_ip, ip_dest_ip = struct.unpack( - "!BBHHHBBHII", ip_header - ) + #-------------------------------------------------------------------------- + + def signal_handler(self, signum, frame): + """ + Handle exit via signals + """ + self.exit() + print("\n(Terminated with signal %d)\n" % (signum)) + sys.exit(0) + + def setup_signal_handler(self): + signal.signal(signal.SIGINT, self.signal_handler) # Handle Ctrl-C + if hasattr(signal, "SIGBREAK"): + # Handle Ctrl-Break e.g. under Windows + signal.signal(signal.SIGBREAK, self.signal_handler) + + #-------------------------------------------------------------------------- + + def run(self, count=None, deadline=None): + """ + send and receive pings in a loop. Stop if count or until deadline. + """ + self.setup_signal_handler() + + while True: + delay = self.do() + + self.seq_number += 1 + if count and self.seq_number >= count: + break + if deadline and self.total_time >= deadline: + break + + if delay == None: + delay = 0 + + # Pause for the remainder of the MAX_SLEEP period (if applicable) + if (MAX_SLEEP > delay): + time.sleep((MAX_SLEEP - delay) / 1000.0) + + self.exit() + + def do(self): + """ + Send one ICMP ECHO_REQUEST and receive the response until self.timeout + """ + if self.seq_number == 0: + self.start() + + try: # One could use UDP here, but it's obscure + current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) + except socket.error, (errno, msg): + if errno == 1: + # Operation not permitted - Add more information to traceback + etype, evalue, etb = sys.exc_info() + evalue = etype( + "%s - Note that ICMP messages can only be send from processes running as root." % evalue + ) + raise etype, evalue, etb + raise # raise the original error + + send_time = self.send_one_ping(current_socket) + if send_time == None: + return + self.send_count += 1 + + receive_time, packet_size, ip_src_ip, icmp_seq_number, ip_ttl = self.receive_one_ping(current_socket) + current_socket.close() - icmp_header = packet_data[20:28] - icmp_type, icmp_code, icmp_checksum, \ - icmp_packet_id, icmp_seq_number = struct.unpack( - "!BBHHH", icmp_header + if receive_time: + self.receive_count += 1 + delay = (receive_time - send_time) * 1000.0 + self.total_time += delay + if self.min_time > delay: + self.min_time = delay + if self.max_time < delay: + self.max_time = delay + + from_info = socket.inet_ntoa(struct.pack("!I", ip_src_ip)) + self.success(delay, from_info, packet_size, ip_src_ip, icmp_seq_number, ip_ttl) + return delay + else: + self.failed() + + def send_one_ping(self, current_socket): + """ + Send one ICMP ECHO_REQUEST + """ + # Header is type (8), code (8), checksum (16), id (16), sequence (16) + checksum = 0 + + # Make a dummy header with a 0 checksum. + header = struct.pack( + "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.seq_number ) - if icmp_packet_id == own_id: # Our packet - dataSize = len(packet_data) - 28 - return receive_time, dataSize, ip_src_ip, icmp_seq_number, ip_ttl - - timeout = timeout - select_duration - if timeout <= 0: - return None, 0, 0, 0, 0 - - -def dump_stats(): - """ - Show stats when pings are done - """ - global current_stats - - print("\n----%s PYTHON PING Statistics----" % (current_stats.dest_ip)) + padBytes = [] + startVal = 0x42 + for i in range(startVal, startVal + (self.packet_size)): + padBytes += [(i & 0xff)] # Keep chars in the 0-255 range + data = bytes(padBytes) - if current_stats.send_count > 0: - current_stats.lost_count = (current_stats.send_count - current_stats.receive_count) / current_stats.send_count + # Calculate the checksum on the data and the dummy header. + checksum = calculate_checksum(header + data) # Checksum is in network order - print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( - current_stats.send_count, current_stats.receive_count, 100.0 * current_stats.lost_count - )) + # Now that we have the right checksum, we put that in. It's just easier + # to make up a new header than to stuff it into the dummy. + header = struct.pack( + "!BBHHH", ICMP_ECHO, 0, checksum, self.own_id, self.seq_number + ) - if current_stats.receive_count > 0: - print("round-trip (ms) min/avg/max = %0.3f/%0.3f/%0.3f" % ( - current_stats.min_time, current_stats.total_time / current_stats.receive_count, current_stats.max_time - )) + packet = header + data - print("") + send_time = default_timer() + try: + current_socket.sendto(packet, (self.dest_ip, 1)) # Port number is irrelevant for ICMP + except socket.error as e: + print("General failure (%s)" % (e.args[1])) + current_socket.close() + return -def signal_handler(signum, frame): - """ - Handle exit via signals - """ - dump_stats() - print("\n(Terminated with signal %d)\n" % (signum)) - sys.exit(0) + return send_time + def receive_one_ping(self, current_socket): + """ + Receive the ping from the socket. timeout = in ms + """ + timeout = self.timeout / 1000.0 -def verbose_ping(hostname, deadline=1000, count=3, packet_size=55): - """ - Send >count< ping to >dest_ip< with the given >deadline< and display - the result. - """ - global current_stats - - signal.signal(signal.SIGINT, signal_handler) # Handle Ctrl-C - if hasattr(signal, "SIGBREAK"): - # Handle Ctrl-Break e.g. under Windows - signal.signal(signal.SIGBREAK, signal_handler) - - current_stats = PingStats() # Reset the stats + while True: # Loop while waiting for packet or timeout + select_start = default_timer() + inputready, outputready, exceptready = select.select([current_socket], [], [], timeout) + select_duration = (default_timer() - select_start) + if inputready == []: # timeout + return None, 0, 0, 0, 0 - seq_number = 0 # Starting value + receive_time = default_timer() - try: - dest_ip = socket.gethostbyname(hostname) - # FIXME: Use dest_ip only for display this line here? see: https://github.com/jedie/python-ping/issues/3 - print("\nPYTHON-PING %s (%s): %d data bytes" % (hostname, dest_ip, packet_size)) - except socket.gaierror as e: - print("\nPYTHON-PING: Unknown host: %s (%s)" % (hostname, e.args[1])) - print("") - return + packet_data, address = current_socket.recvfrom(ICMP_MAX_RECV) - current_stats.dest_ip = dest_ip + ip_header = packet_data[:20] + ip_version, ip_type, ip_length, \ + ip_id, ip_flags, ip_ttl, ip_protocol, \ + ip_checksum, ip_src_ip, ip_dest_ip = struct.unpack( + "!BBHHHBBHII", ip_header + ) - for i in range(count): - delay = do_one(dest_ip, deadline, seq_number, packet_size) + icmp_header = packet_data[20:28] + icmp_type, icmp_code, icmp_checksum, \ + icmp_packet_id, icmp_seq_number = struct.unpack( + "!BBHHH", icmp_header + ) - if delay == None: - delay = 0 + if icmp_packet_id == self.own_id: # Our packet + packet_size = len(packet_data) - 28 + return receive_time, packet_size, ip_src_ip, icmp_seq_number, ip_ttl - seq_number += 1 + timeout = timeout - select_duration + if timeout <= 0: + return None, 0, 0, 0, 0 - # Pause for the remainder of the MAX_SLEEP period (if applicable) - if (MAX_SLEEP > delay): - time.sleep((MAX_SLEEP - delay) / 1000) - dump_stats() +def verbose_ping(hostname, timeout=1000, count=3, packet_size=55): + p = Ping(hostname, timeout, packet_size) + p.run(count) if __name__ == '__main__': @@ -314,7 +327,7 @@ def verbose_ping(hostname, deadline=1000, count=3, packet_size=55): # Should fail with 'getaddrinfo failed': verbose_ping("foobar_url.foobar") - # Should fail (deadline), but it depends on the local network: + # Should fail (timeout), but it depends on the local network: verbose_ping("192.168.255.254") # Should fails with 'The requested address is not valid in its context': From 6e9cf379008cfd2b39c1e3fc58d946ae4565fc4a Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 22:18:22 +0200 Subject: [PATCH 26/42] * rename print callback methods * use hostname and ip for display information --- ping.py | 76 ++++++++++++++++++++++++++------------------------------- 1 file changed, 35 insertions(+), 41 deletions(-) diff --git a/ping.py b/ping.py index db59aa8..8ea011f 100755 --- a/ping.py +++ b/ping.py @@ -28,24 +28,12 @@ # ICMP parameters - ICMP_ECHOREPLY = 0 # Echo reply (per RFC792) ICMP_ECHO = 8 # Echo request (per RFC792) ICMP_MAX_RECV = 2048 # Max size of incoming buffer MAX_SLEEP = 1000 -class PingStats: - dest_ip = "0.0.0.0" - send_count = 0 - receive_count = 0 - min_time = 999999999 - max_time = 0 - total_time = 0 - lost_count = 1.0 - -current_stats = PingStats # Used globally FIXME: Don't use global - def calculate_checksum(source_string): """ @@ -88,10 +76,9 @@ def calculate_checksum(source_string): return answer - class Ping(object): - def __init__(self, dest_ip, timeout=1000, packet_size=55, own_id=None): - self.dest_ip = dest_ip + def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): + self.destination = destination self.timeout = timeout self.packet_size = packet_size if own_id is None: @@ -99,6 +86,15 @@ def __init__(self, dest_ip, timeout=1000, packet_size=55, own_id=None): else: self.own_id = own_id + try: + # FIXME: Use destination only for display this line here? see: https://github.com/jedie/python-ping/issues/3 + self.dest_ip = socket.gethostbyname(self.destination) + except socket.gaierror as e: + self.print_unknown_host(e) + sys.exit(-1) + else: + self.print_start() + self.seq_number = 0 self.send_count = 0 self.receive_count = 0 @@ -108,26 +104,27 @@ def __init__(self, dest_ip, timeout=1000, packet_size=55, own_id=None): #-------------------------------------------------------------------------- - def start(self): - try: - ip = socket.gethostbyname(self.dest_ip) - # FIXME: Use dest_ip only for display this line here? see: https://github.com/jedie/python-ping/issues/3 - print("\nPYTHON-PING %s (%s): %d data bytes" % (self.dest_ip, ip, self.packet_size)) - except socket.gaierror as e: - print("\nPYTHON-PING: Unknown host: %s (%s)" % (self.dest_ip, e.args[1])) - print("") - sys.exit(-1) + def print_start(self): + print("\nPYTHON-PING %s (%s): %d data bytes" % (self.destination, self.dest_ip, self.packet_size)) + + def print_unknwon_host(self, e): + print("\nPYTHON-PING: Unknown host: %s (%s)\n" % (self.destination, e.args[1])) + + def print_success(self, delay, ip, packet_size, icmp_seq_number, ip_ttl): + if ip == self.destination: + from_info = ip + else: + from_info = "%s (%s)" % (self.destination, ip) - def success(self, delay, from_info, packet_size, ip_src_ip, icmp_seq_number, ip_ttl): print("%d bytes from %s: icmp_seq=%d ttl=%d time=%.1f ms" % ( packet_size, from_info, icmp_seq_number, ip_ttl, delay) ) - def failed(self): + def print_failed(self): print("Request timed out.") - def exit(self): - print("\n----%s PYTHON PING Statistics----" % (self.dest_ip)) + def print_exit(self): + print("\n----%s PYTHON PING Statistics----" % (self.destination)) if self.send_count > 0: lost_rate = (self.send_count - self.receive_count) / self.send_count * 100.0 @@ -147,9 +144,9 @@ def exit(self): def signal_handler(self, signum, frame): """ - Handle exit via signals + Handle print_exit via signals """ - self.exit() + self.print_exit() print("\n(Terminated with signal %d)\n" % (signum)) sys.exit(0) @@ -183,15 +180,12 @@ def run(self, count=None, deadline=None): if (MAX_SLEEP > delay): time.sleep((MAX_SLEEP - delay) / 1000.0) - self.exit() + self.print_exit() def do(self): """ Send one ICMP ECHO_REQUEST and receive the response until self.timeout """ - if self.seq_number == 0: - self.start() - try: # One could use UDP here, but it's obscure current_socket = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.getprotobyname("icmp")) except socket.error, (errno, msg): @@ -209,7 +203,7 @@ def do(self): return self.send_count += 1 - receive_time, packet_size, ip_src_ip, icmp_seq_number, ip_ttl = self.receive_one_ping(current_socket) + receive_time, packet_size, ip, icmp_seq_number, ip_ttl = self.receive_one_ping(current_socket) current_socket.close() if receive_time: @@ -221,11 +215,10 @@ def do(self): if self.max_time < delay: self.max_time = delay - from_info = socket.inet_ntoa(struct.pack("!I", ip_src_ip)) - self.success(delay, from_info, packet_size, ip_src_ip, icmp_seq_number, ip_ttl) + self.print_success(delay, ip, packet_size, icmp_seq_number, ip_ttl) return delay else: - self.failed() + self.print_failed() def send_one_ping(self, current_socket): """ @@ -259,7 +252,7 @@ def send_one_ping(self, current_socket): send_time = default_timer() try: - current_socket.sendto(packet, (self.dest_ip, 1)) # Port number is irrelevant for ICMP + current_socket.sendto(packet, (self.destination, 1)) # Port number is irrelevant for ICMP except socket.error as e: print("General failure (%s)" % (e.args[1])) current_socket.close() @@ -299,7 +292,8 @@ def receive_one_ping(self, current_socket): if icmp_packet_id == self.own_id: # Our packet packet_size = len(packet_data) - 28 - return receive_time, packet_size, ip_src_ip, icmp_seq_number, ip_ttl + ip = socket.inet_ntoa(struct.pack("!I", ip_src_ip)) + return receive_time, packet_size, ip, icmp_seq_number, ip_ttl timeout = timeout - select_duration if timeout <= 0: @@ -324,7 +318,7 @@ def verbose_ping(hostname, timeout=1000, count=3, packet_size=55): # to the local host, but 2.7 tries to resolve to the local *gateway*) verbose_ping("localhost") - # Should fail with 'getaddrinfo failed': + # Should fail with 'getaddrinfo print_failed': verbose_ping("foobar_url.foobar") # Should fail (timeout), but it depends on the local network: From f4e191f21b0fc5425f8fbcd17f939040029ee57e Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 22:49:53 +0200 Subject: [PATCH 27/42] * Bugfix: calculate packet lost count * Put received IP and ICMP header into a dict, so we can display different information in print_success() --- ping.py | 56 ++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 20 deletions(-) diff --git a/ping.py b/ping.py index 8ea011f..9e08417 100755 --- a/ping.py +++ b/ping.py @@ -76,6 +76,13 @@ def calculate_checksum(source_string): return answer +class HeaderInformation(dict): + """ Simple storage received IP and ICMP header informations """ + def __init__(self, names, struct_format, data): + unpacked_data = struct.unpack(struct_format, data) + dict.__init__(self, dict(zip(names, unpacked_data))) + + class Ping(object): def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): self.destination = destination @@ -110,15 +117,17 @@ def print_start(self): def print_unknwon_host(self, e): print("\nPYTHON-PING: Unknown host: %s (%s)\n" % (self.destination, e.args[1])) - def print_success(self, delay, ip, packet_size, icmp_seq_number, ip_ttl): + def print_success(self, delay, ip, packet_size, ip_header, icmp_header): if ip == self.destination: from_info = ip else: from_info = "%s (%s)" % (self.destination, ip) print("%d bytes from %s: icmp_seq=%d ttl=%d time=%.1f ms" % ( - packet_size, from_info, icmp_seq_number, ip_ttl, delay) + packet_size, from_info, icmp_header["seq_number"], ip_header["ttl"], delay) ) + #print("IP header: %r" % ip_header) + #print("ICMP header: %r" % icmp_header) def print_failed(self): print("Request timed out.") @@ -126,8 +135,9 @@ def print_failed(self): def print_exit(self): print("\n----%s PYTHON PING Statistics----" % (self.destination)) - if self.send_count > 0: - lost_rate = (self.send_count - self.receive_count) / self.send_count * 100.0 + lost_count = self.send_count - self.receive_count + #print("%i packets lost" % lost_count) + lost_rate = float(lost_count) / self.send_count * 100.0 print("%d packets transmitted, %d packets received, %0.1f%% packet loss" % ( self.send_count, self.receive_count, lost_rate @@ -203,7 +213,7 @@ def do(self): return self.send_count += 1 - receive_time, packet_size, ip, icmp_seq_number, ip_ttl = self.receive_one_ping(current_socket) + receive_time, packet_size, ip, ip_header, icmp_header = self.receive_one_ping(current_socket) current_socket.close() if receive_time: @@ -215,7 +225,7 @@ def do(self): if self.max_time < delay: self.max_time = delay - self.print_success(delay, ip, packet_size, icmp_seq_number, ip_ttl) + self.print_success(delay, ip, packet_size, ip_header, icmp_header) return delay else: self.print_failed() @@ -277,23 +287,29 @@ def receive_one_ping(self, current_socket): packet_data, address = current_socket.recvfrom(ICMP_MAX_RECV) - ip_header = packet_data[:20] - ip_version, ip_type, ip_length, \ - ip_id, ip_flags, ip_ttl, ip_protocol, \ - ip_checksum, ip_src_ip, ip_dest_ip = struct.unpack( - "!BBHHHBBHII", ip_header + icmp_header = HeaderInformation( + names=[ + "type", "code", "checksum", + "packet_id", "seq_number" + ], + struct_format="!BBHHH", + data=packet_data[20:28] ) - icmp_header = packet_data[20:28] - icmp_type, icmp_code, icmp_checksum, \ - icmp_packet_id, icmp_seq_number = struct.unpack( - "!BBHHH", icmp_header - ) - - if icmp_packet_id == self.own_id: # Our packet + if icmp_header["packet_id"] == self.own_id: # Our packet + ip_header = HeaderInformation( + names=[ + "version", "type", "length", + "id", "flags", "ttl", "protocol", + "checksum", "src_ip", "dest_ip" + ], + struct_format="!BBHHHBBHII", + data=packet_data[:20] + ) packet_size = len(packet_data) - 28 - ip = socket.inet_ntoa(struct.pack("!I", ip_src_ip)) - return receive_time, packet_size, ip, icmp_seq_number, ip_ttl + ip = socket.inet_ntoa(struct.pack("!I", ip_header["src_ip"])) + # XXX: Why not ip = address[0] ??? + return receive_time, packet_size, ip, ip_header, icmp_header timeout = timeout - select_duration if timeout <= 0: From 1d8e6004c839a1797fa1984365b819a299b3d86e Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Wed, 12 Oct 2011 22:51:18 +0200 Subject: [PATCH 28/42] Update example output --- README.creole | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.creole b/README.creole index 964e6a1..8bd93ce 100644 --- a/README.creole +++ b/README.creole @@ -14,14 +14,14 @@ Original Version from [[ftp://ftp.visi.com/users/mdc/ping.py|Matthew Dixon Cowle {{{ ~/python-ping$ sudo ./ping.py google.com -PYTHON-PING google.com (74.125.39.147): 55 data bytes -64 bytes from 74.125.39.147: icmp_seq=0 ttl=53 time=23 ms -64 bytes from 74.125.39.147: icmp_seq=1 ttl=52 time=20 ms -64 bytes from 74.125.39.147: icmp_seq=2 ttl=53 time=22 ms +PYTHON-PING google.com (209.85.148.99): 55 data bytes +64 bytes from google.com (209.85.148.99): icmp_seq=0 ttl=54 time=56.2 ms +64 bytes from google.com (209.85.148.99): icmp_seq=1 ttl=54 time=55.7 ms +64 bytes from google.com (209.85.148.99): icmp_seq=2 ttl=54 time=55.5 ms -----74.125.39.147 PYTHON PING Statistics---- +----google.com PYTHON PING Statistics---- 3 packets transmitted, 3 packets received, 0.0% packet loss -round-trip (ms) min/avg/max = 20/22.4/23 +round-trip (ms) min/avg/max = 55.468/55.795/56.232 }}} From 12050a533166444234f8dc841ef82e6415d68d79 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Thu, 13 Oct 2011 10:17:13 +0200 Subject: [PATCH 29/42] install \"ping.py\" as script --- MANIFEST.in | 1 - setup.py | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/MANIFEST.in b/MANIFEST.in index 244d0be..2cf163c 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,3 @@ include AUTHORS LICENSE MANIFEST.in README.creole -recursive-include *.py recursive-exclude * *.pyc recursive-exclude * *.pyo \ No newline at end of file diff --git a/setup.py b/setup.py index 8dba88e..5e117a6 100755 --- a/setup.py +++ b/setup.py @@ -108,6 +108,7 @@ def get_authors(): packages=find_packages(), include_package_data=True, # include package data under svn source control zip_safe=False, + scripts=["ping.py"], classifiers=[ # http://pypi.python.org/pypi?%3Aaction=list_classifiers # "Development Status :: 4 - Beta", From e8036e13cbc420cf830437adc9dc6085b7c9f0ab Mon Sep 17 00:00:00 2001 From: incidence Date: Sun, 16 Oct 2011 00:39:07 +0300 Subject: [PATCH 30/42] Fixed a typo in a method name threw a "Has no Attribute exception" --- ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 9e08417..490458b 100755 --- a/ping.py +++ b/ping.py @@ -114,7 +114,7 @@ def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): def print_start(self): print("\nPYTHON-PING %s (%s): %d data bytes" % (self.destination, self.dest_ip, self.packet_size)) - def print_unknwon_host(self, e): + def print_unknown_host(self, e): print("\nPYTHON-PING: Unknown host: %s (%s)\n" % (self.destination, e.args[1])) def print_success(self, delay, ip, packet_size, ip_header, icmp_header): From 9e1ca0f0fc7aafc612b2cc602dc6eb5bc4c91842 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Mon, 17 Oct 2011 09:56:04 +0300 Subject: [PATCH 31/42] Update AUTHORS --- AUTHORS | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AUTHORS b/AUTHORS index 1418452..8c3b4b3 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,13 +1,14 @@ - AUTHORS / CONTRIBUTORS (alphabetic order): * Cowles, Matthew Dixon -- ftp://ftp.visi.com/users/mdc/ping.py * Diemer, Jens -- http://www.jensdiemer.de * Falatic, Martin -- http://www.falatic.com * Hallman, Chris -- http://cdhallman.blogspot.com + * incidence -- https://github.com/incidence * Notaras, George -- http://www.g-loaded.eu * Poincheval, Jerome * Stauffer, Samuel * Zach Ware * zed -- https://github.com/zed + From 376a01930ed943a73b316208515d7351f6846c6d Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 17 Oct 2011 09:06:31 +0200 Subject: [PATCH 32/42] Update history --- README.creole | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.creole b/README.creole index 8bd93ce..a605156 100644 --- a/README.creole +++ b/README.creole @@ -39,6 +39,9 @@ round-trip (ms) min/avg/max = 55.468/55.795/56.232 == Revision history == +==== Oct. 17, 2011 ==== +* [[https://github.com/jedie/python-ping/pull/6|Bugfix if host is unknown]] + ==== Oct. 12, 2011 ==== Merge sources and create a seperate github repository: * https://github.com/jedie/python-ping From a6015128a1dbaa1f18ce136aab890801f32bd4fa Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Mon, 17 Oct 2011 10:10:36 +0300 Subject: [PATCH 33/42] Update README.creole --- README.creole | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.creole b/README.creole index a605156..b86e961 100644 --- a/README.creole +++ b/README.creole @@ -104,3 +104,9 @@ For some reason, the checksum bytes are in the wrong order when this is run under Solaris 2.X for SPARC but it works right under Linux x86. Since I don't know just what's wrong, I'll swap the bytes always and then do an htons(). + +== Links == + +| Sourcecode at GitHub | https://github.com/jedie/python-ping | +| Python Package Index | http://pypi.python.org/pypi/python-ping/ | +| IRC | [[http://www.pylucid.org/permalink/304/irc-channel|#pylucid on freenode.net]] From bca063c152eeaad34dc405e2118da005229000ef Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Mon, 17 Oct 2011 09:14:09 +0200 Subject: [PATCH 34/42] fix indent --- setup.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/setup.py b/setup.py index 5e117a6..91730ea 100755 --- a/setup.py +++ b/setup.py @@ -84,11 +84,11 @@ def get_authors(): try: f = file(os.path.join(PACKAGE_ROOT, "AUTHORS"), "r") for line in f: - if not line.strip().startswith("*"): - continue - if "--" in line: - line = line.split("--", 1)[0] - authors.append(line.strip(" *\r\n")) + if not line.strip().startswith("*"): + continue + if "--" in line: + line = line.split("--", 1)[0] + authors.append(line.strip(" *\r\n")) f.close() authors.sort() except Exception, err: From bd9d558e735fc1d6f4aea1d0c041d87277ac1463 Mon Sep 17 00:00:00 2001 From: Kunal Sarkhel Date: Thu, 27 Oct 2011 19:20:32 -0300 Subject: [PATCH 35/42] Changed platform checking code to use the startswith idiom http://docs.python.org/library/sys.html#sys.platform recommends using startswith() instead of == --- ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 490458b..4adfb42 100755 --- a/ping.py +++ b/ping.py @@ -19,7 +19,7 @@ import os, sys, socket, struct, select, time, signal -if sys.platform == "win32": +if sys.platform.startswith("win32"): # On Windows, the best timer is time.clock() default_timer = time.clock else: From 58d7cad47c97e914eb248158631cd4aa03e48363 Mon Sep 17 00:00:00 2001 From: Jens Diemer Date: Fri, 28 Oct 2011 10:10:28 +0300 Subject: [PATCH 36/42] add Sarkhel, Kunal -- https://github.com/techwizrd -- https://github.com/jedie/python-ping/pull/7 --- AUTHORS | 2 ++ 1 file changed, 2 insertions(+) diff --git a/AUTHORS b/AUTHORS index 8c3b4b3..34be436 100644 --- a/AUTHORS +++ b/AUTHORS @@ -7,8 +7,10 @@ AUTHORS / CONTRIBUTORS (alphabetic order): * incidence -- https://github.com/incidence * Notaras, George -- http://www.g-loaded.eu * Poincheval, Jerome + * Sarkhel, Kunal -- https://github.com/techwizrd * Stauffer, Samuel * Zach Ware * zed -- https://github.com/zed + From 05a434bac75ec4e64124e765c28cf9839583b68b Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 10:49:06 +0100 Subject: [PATCH 37/42] add setup.py keywords --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index 91730ea..3736335 100755 --- a/setup.py +++ b/setup.py @@ -105,6 +105,7 @@ def get_authors(): maintainer="Jens Diemer", maintainer_email="python-ping@jensdiemer.de", url='https://github.com/jedie/python-ping/', + keywords="ping icmp network latency", packages=find_packages(), include_package_data=True, # include package data under svn source control zip_safe=False, From 3f01bf82aff00dce91a74c97d87ae46b573f7456 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 10:50:17 +0100 Subject: [PATCH 38/42] refactor imports --- ping.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/ping.py b/ping.py index 4adfb42..65c74ff 100755 --- a/ping.py +++ b/ping.py @@ -16,7 +16,13 @@ """ -import os, sys, socket, struct, select, time, signal +import os +import select +import signal +import socket +import struct +import sys +import time if sys.platform.startswith("win32"): From 120d46d9ccb6624c963bf04ac8bbdadad3105c3a Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 10:51:20 +0100 Subject: [PATCH 39/42] change HeaderInformation from class to a function. (Thanks jcborras for the idea: https://github.com/jcborras/python-ping/commit/2cac6f3c8f0d59f1c771809296587aa0c9aff6e2 ) --- ping.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/ping.py b/ping.py index 65c74ff..234a6b2 100755 --- a/ping.py +++ b/ping.py @@ -82,13 +82,6 @@ def calculate_checksum(source_string): return answer -class HeaderInformation(dict): - """ Simple storage received IP and ICMP header informations """ - def __init__(self, names, struct_format, data): - unpacked_data = struct.unpack(struct_format, data) - dict.__init__(self, dict(zip(names, unpacked_data))) - - class Ping(object): def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): self.destination = destination @@ -174,6 +167,13 @@ def setup_signal_handler(self): #-------------------------------------------------------------------------- + def header2dict(self, names, struct_format, data): + """ unpack the raw received IP and ICMP header informations to a dict """ + unpacked_data = struct.unpack(struct_format, data) + return dict(zip(names, unpacked_data)) + + #-------------------------------------------------------------------------- + def run(self, count=None, deadline=None): """ send and receive pings in a loop. Stop if count or until deadline. @@ -293,7 +293,7 @@ def receive_one_ping(self, current_socket): packet_data, address = current_socket.recvfrom(ICMP_MAX_RECV) - icmp_header = HeaderInformation( + icmp_header = self.header2dict( names=[ "type", "code", "checksum", "packet_id", "seq_number" @@ -303,7 +303,7 @@ def receive_one_ping(self, current_socket): ) if icmp_header["packet_id"] == self.own_id: # Our packet - ip_header = HeaderInformation( + ip_header = self.header2dict( names=[ "version", "type", "length", "id", "flags", "ttl", "protocol", From ba987c96f1c04f089faf44cd6bd5432775d5cf65 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 11:59:34 +0100 Subject: [PATCH 40/42] add: jcborras -- https://github.com/jcborras --- AUTHORS | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/AUTHORS b/AUTHORS index 34be436..c0b9980 100644 --- a/AUTHORS +++ b/AUTHORS @@ -5,12 +5,10 @@ AUTHORS / CONTRIBUTORS (alphabetic order): * Falatic, Martin -- http://www.falatic.com * Hallman, Chris -- http://cdhallman.blogspot.com * incidence -- https://github.com/incidence + * jcborras -- https://github.com/jcborras * Notaras, George -- http://www.g-loaded.eu * Poincheval, Jerome * Sarkhel, Kunal -- https://github.com/techwizrd * Stauffer, Samuel * Zach Ware * zed -- https://github.com/zed - - - From 32bed5da87c2098a34e5f30ce4935149f2797178 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 12:01:01 +0100 Subject: [PATCH 41/42] add the idea from https://github.com/jedie/python-ping/pull/8/files#L1R81 : Use socket.gethostbyname() only, if given address is not a valid IPv4 Address --- ping.py | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/ping.py b/ping.py index 234a6b2..89cff36 100755 --- a/ping.py +++ b/ping.py @@ -82,6 +82,25 @@ def calculate_checksum(source_string): return answer +def is_valid_ip4_address(addr): + parts = addr.split(".") + if not len(parts) == 4: + return False + for part in parts: + try: + number = int(part) + except ValueError: + return False + if number > 255: + return False + return True + +def to_ip(addr): + if is_valid_ip4_address(addr): + return addr + return socket.gethostbyname(addr) + + class Ping(object): def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): self.destination = destination @@ -94,10 +113,9 @@ def __init__(self, destination, timeout=1000, packet_size=55, own_id=None): try: # FIXME: Use destination only for display this line here? see: https://github.com/jedie/python-ping/issues/3 - self.dest_ip = socket.gethostbyname(self.destination) + self.dest_ip = to_ip(self.destination) except socket.gaierror as e: self.print_unknown_host(e) - sys.exit(-1) else: self.print_start() @@ -115,6 +133,7 @@ def print_start(self): def print_unknown_host(self, e): print("\nPYTHON-PING: Unknown host: %s (%s)\n" % (self.destination, e.args[1])) + sys.exit(-1) def print_success(self, delay, ip, packet_size, ip_header, icmp_header): if ip == self.destination: From 24a6a03418762e51613446ba313bfeeeef4c67d0 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Tue, 15 Nov 2011 12:03:21 +0100 Subject: [PATCH 42/42] Add unittests with some ideas from https://github.com/jedie/python-ping/pull/8/ --- setup.py | 1 + tests.py | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 131 insertions(+) create mode 100644 tests.py diff --git a/setup.py b/setup.py index 3736335..a5ecc8c 100755 --- a/setup.py +++ b/setup.py @@ -125,4 +125,5 @@ def get_authors(): "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: System :: Networking :: Monitoring", ], + test_suite="tests", ) diff --git a/tests.py b/tests.py new file mode 100644 index 0000000..74d6431 --- /dev/null +++ b/tests.py @@ -0,0 +1,130 @@ +#!/usr/bin/env python +# coding: utf-8 + +""" + python-ping unittests + ~~~~~~~~~~~~~~~~~~~~~ + + Note that ICMP messages can only be send from processes running as root. + So you must run this tests also as root, e.g.: + + .../python-ping$ sudo python tests.py + + :homepage: https://github.com/jedie/python-ping/ + :copyleft: 1989-2011 by the python-ping team, see AUTHORS for more details. + :license: GNU GPL v2, see LICENSE for more details. +""" + +import socket +import unittest + +from ping import Ping, is_valid_ip4_address, to_ip + + +class PingTest(Ping): + """ + Used in TestPythonPing for check if print methods are called. + This is also a way how to subclass Ping ;) + """ + def __init__(self, *args, **kwargs): + self.start_call_count = 0 + self.unknown_host_call_count = 0 + self.success_call_count = 0 + self.failed_call_count = 0 + self.exit_call_count = 0 + super(PingTest, self).__init__(*args, **kwargs) + + def print_start(self): + self.start_call_count += 1 + + def print_unknown_host(self, e): + self.unknown_host_call_count += 1 + + def print_success(self, delay, ip, packet_size, ip_header, icmp_header): + self.success_call_count += 1 + + def print_failed(self): + self.failed_call_count += 1 + + def print_exit(self): + self.exit_call_count += 1 + + +class TestPythonPing(unittest.TestCase): + def testIp4AddrPositives(self): + self.assertTrue(is_valid_ip4_address('0.0.0.0')) + self.assertTrue(is_valid_ip4_address('1.2.3.4')) + self.assertTrue(is_valid_ip4_address('12.34.56.78')) + self.assertTrue(is_valid_ip4_address('255.255.255.255')) + + def testIp4AddrNegatives(self): + self.assertFalse(is_valid_ip4_address('0.0.0.0.0')) + self.assertFalse(is_valid_ip4_address('1.2.3')) + self.assertFalse(is_valid_ip4_address('a2.34.56.78')) + self.assertFalse(is_valid_ip4_address('255.255.255.256')) + + def testDestAddr1(self): + self.assertTrue(is_valid_ip4_address(to_ip('www.wikipedia.org'))) + self.assertRaises(socket.gaierror, to_ip, ('www.doesntexist.tld')) + + def testDestAddr2(self): + self.assertTrue(to_ip('10.10.10.1')) + self.assertTrue(to_ip('10.10.010.01')) + self.assertTrue(to_ip('10.010.10.1')) + + def test_init_only(self): + p = PingTest("www.google.com") + self.assertEqual(p.start_call_count, 1) + self.assertEqual(p.unknown_host_call_count, 0) + self.assertEqual(p.success_call_count, 0) + self.assertEqual(p.failed_call_count, 0) + self.assertEqual(p.exit_call_count, 0) + + def test_do_one_ping(self): + p = PingTest("www.google.com") + p.do() + self.assertEqual(p.send_count, 1) + self.assertEqual(p.receive_count, 1) + + self.assertEqual(p.start_call_count, 1) + self.assertEqual(p.unknown_host_call_count, 0) + self.assertEqual(p.success_call_count, 1) + self.assertEqual(p.failed_call_count, 0) + self.assertEqual(p.exit_call_count, 0) + + def test_do_one_failed_ping(self): + p = PingTest("www.doesntexist.tld") + self.assertEqual(p.start_call_count, 0) + self.assertEqual(p.unknown_host_call_count, 1) + self.assertEqual(p.success_call_count, 0) + self.assertEqual(p.failed_call_count, 0) + self.assertEqual(p.exit_call_count, 0) + + def test_run_ping(self): + p = PingTest("www.google.com") + p.run(count=2) + self.assertEqual(p.send_count, 2) + self.assertEqual(p.receive_count, 2) + + self.assertEqual(p.start_call_count, 1) + self.assertEqual(p.unknown_host_call_count, 0) + self.assertEqual(p.success_call_count, 2) + self.assertEqual(p.failed_call_count, 0) + self.assertEqual(p.exit_call_count, 1) + + def test_run_failed_pings(self): + p = PingTest("www.google.com", timeout=0.01) + p.run(count=2) + self.assertEqual(p.send_count, 2) + self.assertEqual(p.receive_count, 0) + + self.assertEqual(p.start_call_count, 1) + self.assertEqual(p.unknown_host_call_count, 0) + self.assertEqual(p.success_call_count, 0) + self.assertEqual(p.failed_call_count, 2) + self.assertEqual(p.exit_call_count, 1) + + +if __name__ == '__main__': + unittest.main() +