2011-10-12 update: Brought in more changes from Jens Diemer’s new repository for the Python 2 version of this project.
2011-09-12 update: The version here is for Python 3.x as described below. Jens Diemer posted an updated version of this to GitHub with corrections. It’s mainly a backport of this script to Python 2.x along with some cosmetic changes (and yes, I do like delimiting functions and such with comment lines – it makes code blocks far easier to distinguish, even in indentation-intensive Python). He added a bugfix to handle SIGBREAK better, which I’ve pulled into the code below.
A while back, when I decided to learn Python, I looked into writing my own sort of ping utility with it. Then I learned just how ridiculously arduous it is to perform this seemingly-simple function (essentially, you have to be running as root in Unix (or Administrator in Windows) to accomplish this, and generally speaking running scripts like this as root is considered bad form). But it can be done…
This intrigued me as a pet project but I moved on to other things, eventually picking up Python along the way (I’ve focused on Python 3.x since the Unicode handling is FAR better than it is in 2.7, not to mention its other improvements).
Recently, I decided to revisit the “ping with Python” idea, and searched around to see if anyone else had tackled it. Sure enough, I found George Notaras’ site which has a very nice implementation in 2.x as well as a recent commenter who created a 3.x port. Only problem was, the HTML is mangled there so neither script worked. As I delved into it, I managed to get the scripts working, and then decided to go the extra mile and make some enhancements and improvements. Along the way I ended up getting the source for ping (via Cygwin) and building it from scratch as well (particularly to understand the checksum routine, and for other hints in general).
It was rather pleasing to not only get this working but to make it work far better in terms of functionality and robustness, all the while reinforcing and extending my understanding of Python.
#!/usr/bin/env python # -*- coding: utf-8 -*- """ A pure python ping implementation using raw sockets. (This is Python 3 port of https://github.com/jedie/python-ping) 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, <http://www.visi.com/~mdc/>. 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 ~~~~~~~~~~~~~~~~ October 12, 2011 -------------- Merged updates from the main project -> https://github.com/jedie/python-ping 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.  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 (188.8.131.52): 56 data bytes 64 bytes from 184.108.40.206: icmp_seq=0 ttl=240 time=127 ms 64 bytes from 220.127.116.11: icmp_seq=1 ttl=240 time=127 ms 64 bytes from 18.104.22.168: icmp_seq=2 ttl=240 time=126 ms 64 bytes from 22.214.171.124: icmp_seq=3 ttl=240 time=126 ms 64 bytes from 126.96.36.199: 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 if sys.platform == "win32": # On Windows, the best timer is time.clock() default_timer = time.clock else: # On most other platforms the best timer is time.time() default_timer = time.time #=============================================================================# # 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 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): """ 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 count = 0 # Handle bytes in pairs (decoding as short ints) loByte = 0 hiByte = 0 while count < countTo: 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 # 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 &= 0xffffffff # Truncate sum to 32 bits (a variance from ping.c, which # uses signed ints, but overflow is unlikely in ping) 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 do_one(destIP, timeout, mySeqNumber, numDataBytes): """ Returns either the delay (in ms) or None on timeout. """ global myStats delay = None 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) 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) 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 >destIP<. """ destIP = socket.gethostbyname(destIP) # 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 ) 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. 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, myID, mySeqNumber ) packet = header + data 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)) return return sendTime #=============================================================================# def receive_one_ping(mySocket, myID, timeout): """ Receive the ping from the socket. Timeout = in ms """ timeLeft = timeout/1000 while True: # Loop while waiting for packet or timeout startedSelect = time.time() whatReady = select.select([mySocket], , , timeLeft) howLongInSelect = (time.time() - startedSelect) if whatReady == : # Timeout return None, 0, 0, 0, 0 timeReceived = time.time() 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 dump_stats(): """ Show stats when pings are done """ global myStats print("\n----%s PYTHON PING 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. """ global myStats 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 mySeqNumber = 0 # Starting value try: destIP = socket.gethostbyname(hostname) 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)) print() return myStats.thisIP = destIP for i in range(count): delay = do_one(destIP, timeout, mySeqNumber, numDataBytes) if delay == None: 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") # 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") #=============================================================================#