Initial commit

Author: AlexisTM

README.md

@@ -0,0 +1,89 @@
+# RawSocketPy
+
+Raw socket is a layer 2 python library for communication using the MAC addresses only. 
+
+This allows you to create a custom made Ethernet/WiFi communication system which is **not** using IP nor TCP/UDP or to debug custom frames such as SERCOS III, Profibus, ARP, PTP, ...
+
+**Pros:**
+
+- Low level
+- Not using TCP-UDP/IP
+- Dead simple
+- Can broadcast
+- MTU of 1500
+
+**Cons:**
+
+- Low level
+- Not using TCP-UDP/IP
+- No encryption
+- No fragmentation
+- **Requires root**
+- MTU of 1500
+
+## Installation
+
+```bash
+# Soon
+sudo -H pip install rawsocketpy
+
+# for now:
+git clone https://github.com/AlexisTM/rawsocket_python
+cd rawsocket_python
+sudo python setup.py install
+```
+
+## Usage
+
+### Sending
+
+```python
+from rawsocketpy import RawSocket
+
+# 0xEEFA is the ethertype
+# The most common are available here: https://en.wikipedia.org/wiki/EtherType
+# The full official list is available here: https://regauth.standards.ieee.org/standards-ra-web/pub/view.html#registries 
+# Direct link: https://standards.ieee.org/develop/regauth/ethertype/eth.csv
+# You can use whatever you want but using a already use type can have unexpected behaviour.
+sock = RawSocket("wlp2s0", 0xEEFA)
+sock.send("some data") # Broadcast "some data" with an ethertype of 0xEEFA
+sock.send("personal data", dest="\xAA\xBB\xCC\xDD\xEE\xFF") # Send "personal data to \xAA\xBB\xCC\xDD\xEE\xFF with an ether type of 0xEEFA
+sock.send("other data", ethertype="\xEE\xFF") # Broadcast "other data" with an ether type of 0xEEFF
+
+# On capable hardware, you can spoof your MAC address:
+sock.mac = "\x12\x13\x14\x15\x16\x17"
+sock.send("some data")
+```
+
+### Receiving
+
+On another machine, you can run the following:
+
+```python
+from rawsocketpy import RawSocket, u_to_str
+
+sock = RawSocket("wlp2s0", 0xEEFA)
+packet = sock.recv()
+
+print(packet) # Pretty print
+packet.dest   # unicode string "\xFF\xFF\xFF\xFF\xFF\xFF"
+packet.src    # unicode string "\x12\x12\x12\x12\x12\x13"
+packet.type   # unicode string "\xEE\xFA"
+packegt.data  # unicode string "some data"
+
+print u_to_str(packet.dest)     # Human readable MAC:  FF:FF:FF:FF:FF:FF
+print u_to_str(packet.type, "") # Human readable type: EEFA
+```
+
+
+## I want to contribue!!
+
+You are free to contribue, the following capabilities are welcome:
+
+- Windows compatibility
+- Python 3.x compatibility
+- Server implementation (callbacks on new data)
+
+## Credits
+
+- Alexis PAQUES - [@AlexisTM](https://github.com/AlexisTM/)

rawsocketpy/__init__.py

@@ -0,0 +1,4 @@
+# Package init
+
+from get_hw import get_hw, u_to_str
+from main import RawPacket, RawSocket

rawsocketpy/get_hw.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import socket
+import fcntl
+import struct
+import sys
+
+if sys.version_info >= (3,0):
+    import binascii
+    def get_hw(ifname):
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        info = fcntl.ioctl(s.fileno(), 0x8927,  struct.pack('256s',  bytes(ifname[:15], 'utf-8')))
+        return info[18:24]
+
+    def u_to_str(data, separator=":"):
+        return separator.join("{:02x}".format(ord(c)) for c in data).upper()
+else:
+
+    def get_hw(ifname):
+        s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+        info = fcntl.ioctl(s.fileno(), 0x8927,  struct.pack('256s', ifname[:15]))
+        return info[18:24]
+
+    def u_to_str(data, separator=":"):
+        return separator.join("{:02x}".format(ord(c)) for c in data).upper()
+
+def main():
+    print u_to_str(get_hw("wlp2s0"))
+
+if __name__ == '__main__':
+    main()

rawsocketpy/main.py

@@ -0,0 +1,73 @@
+import socket, select, struct, time
+from get_hw import get_hw, u_to_str
+
+class RawPacket():
+    def __init__(self, data):
+        self.dest = ""
+        self.src = ""
+        self.type = ""
+        self.data = ""
+        self.success = False
+        try:
+            self.dest, self.src, self.type = data[0:6], data[6:12], data[12:14]
+            self.data = data[14:]
+            self.success = True
+        except:
+            self.success = False
+
+    def __repr__(self):
+        return "".join([u_to_str(self.src), " == 0x", u_to_str(self.type, separator=""), " => ", u_to_str(self.dest), " - ", "OK" if self.success else "FAILED"])
+
+    def __str__(self):
+        return "".join([self.__repr__(), ":\n", self.data])
+
+class RawSocket(object):
+    BROADCAST = "\xff\xff\xff\xff\xff\xff"
+    def __init__(self, interface, protocol, sock=None, no_recv_protocol=False):
+        if  not 0x0000 < protocol < 0xFFFF:
+            raise ValueError("Protocol has to be in the range 0 to 65535")
+        self.protocol = socket.htons(protocol)
+        self.ethertype = self.protocol_to_ethertype(protocol)
+        self.interface = interface
+        self.mac = get_hw(self.interface)
+        if no_recv_protocol:
+            self.sock = self.sock_create(self.interface, 0, sock)
+        else: 
+            self.sock = self.sock_create(self.interface, self.protocol, sock)
+
+    @staticmethod
+    def sock_create(interface, protocol, sock=None):
+        if sock is None:
+            sock = socket.socket(socket.AF_PACKET, socket.SOCK_RAW, protocol)
+            sock.bind((interface, 0))
+        return sock
+
+    @staticmethod
+    def protocol_to_ethertype(protocol):
+        return chr((protocol & 0xFF00) >> 8) + chr(protocol & 0x00FF)
+
+    def send(self, msg, dest=None, ethertype=None):
+        if ethertype is None: ethertype = self.ethertype
+        if dest is None: dest = self.BROADCAST
+        self.sock.send(dest + self.mac + ethertype + msg)
+
+    def recv(self):
+        data = self.sock.recv(1500)
+        return RawPacket(data)
+    
+    def __str__(self):
+        return self.interface
+
+def main():
+    na = NetworkAdapter("wlp2s0", 0xAA42)
+    i = 0
+    while True:
+        try:
+            na.send(str(i))
+            time.sleep(0.1)
+            i += 1
+        except:
+            break
+
+if __name__ == '__main__':
+    main()

setup.py

@@ -0,0 +1,11 @@
+from setuptools import setup
+
+setup(name='rawsocketpy',
+      version='0.1',
+      description='This library allows you to implemnet a custom layer 2 communication using raw sockets in Python',
+      url='https://github.com/AlexisTM/rawsocket_python',
+      author='AlexisTM',
+      author_email='alexis.paques@gmail.com',
+      license='MIT',
+      packages=['rawsocketpy'],
+      zip_safe=False)