broadcast_ping.py

'''
    icmplib
    ~~~~~~~

    Easily forge ICMP packets and make your own ping and traceroute.

        https://github.com/ValentinBELYN/icmplib

    :copyright: Copyright 2017-2023 Valentin BELYN.
    :license: GNU LGPLv3, see the LICENSE for details.

    ~~~~~~~

    Example: broadcast ping (advanced)

    PING 255.255.255.255: 56 data bytes

        64 bytes from 10.0.0.17: icmp_seq=0 time=1.065 ms
        64 bytes from 10.0.0.40: icmp_seq=0 time=1.595 ms
        64 bytes from 10.0.0.41: icmp_seq=0 time=9.471 ms
        64 bytes from 10.0.0.17: icmp_seq=1 time=0.983 ms
        64 bytes from 10.0.0.40: icmp_seq=1 time=1.579 ms
        64 bytes from 10.0.0.41: icmp_seq=1 time=9.345 ms
        64 bytes from 10.0.0.17: icmp_seq=2 time=0.916 ms
        64 bytes from 10.0.0.40: icmp_seq=2 time=2.031 ms
        64 bytes from 10.0.0.41: icmp_seq=2 time=9.554 ms
        64 bytes from 10.0.0.17: icmp_seq=3 time=1.112 ms
        64 bytes from 10.0.0.40: icmp_seq=3 time=1.384 ms
        64 bytes from 10.0.0.41: icmp_seq=3 time=9.565 ms

    Completed.
'''

from icmplib import ICMPv4Socket, ICMPRequest
from icmplib import ICMPLibError, TimeoutExceeded, PID


def broadcast_ping(address, count=4, timeout=1, id=PID):
    # A payload of 56 bytes is used by default. You can modify it using
    # the 'payload_size' parameter of your ICMP request.
    print(f'PING {address}: 56 data bytes\n')

    # Broadcast is only possible in IPv4
    sock = ICMPv4Socket()

    # We allow the socket to send broadcast packets
    sock.broadcast = True

    for sequence in range(count):
        # We create an ICMP request
        request = ICMPRequest(
            destination=address,
            id=id,
            sequence=sequence)

        try:
            # We send the request
            sock.send(request)

            while 'we receive replies':
                # We are awaiting receipt of an ICMP reply. If there is
                # no more responses, the 'TimeoutExceeded' exception is
                # thrown and the loop is stopped.
                reply = sock.receive(request, timeout)

                # We calculate the round-trip time
                round_trip_time = (reply.time - request.time) * 1000

                # We display some information
                print(f'  {reply.bytes_received} bytes from '
                      f'{reply.source}: icmp_seq={sequence} '
                      f'time={round(round_trip_time, 3)} ms')

        except TimeoutExceeded:
            # The timeout has been reached
            # We use this exception to break the while loop
            pass

        except ICMPLibError:
            # All other errors
            print('  An error has occurred.')

    print('\nCompleted.')


# Limited broadcast
broadcast_ping('255.255.255.255')

# Directed broadcast
# broadcast_ping('192.168.0.255')