Reticulum/RNS/Interfaces/UDPInterface.py

125 lines
4.7 KiB
Python
Raw Normal View History

2022-04-01 15:18:18 +00:00
# MIT License
#
# Copyright (c) 2016-2022 Mark Qvist / unsigned.io
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
2020-04-22 10:07:13 +00:00
from .Interface import Interface
import socketserver
2016-06-03 17:02:02 +00:00
import threading
import socket
import time
2016-06-03 17:02:02 +00:00
import sys
import RNS
2016-06-03 17:02:02 +00:00
2020-08-13 10:37:54 +00:00
class UDPInterface(Interface):
BITRATE_GUESS = 10*1000*1000
2016-06-03 17:02:02 +00:00
@staticmethod
def get_address_for_if(name):
2021-12-01 10:39:40 +00:00
import importlib
2021-12-01 10:46:19 +00:00
if importlib.util.find_spec('netifaces') != None:
2021-12-01 10:39:40 +00:00
import netifaces
return netifaces.ifaddresses(name)[netifaces.AF_INET][0]['addr']
else:
RNS.log("Getting interface addresses from device names requires the netifaces module.", RNS.LOG_CRITICAL)
RNS.log("You can install it with the command: python3 -m pip install netifaces", RNS.LOG_CRITICAL)
RNS.panic()
2021-12-01 10:39:40 +00:00
@staticmethod
def get_broadcast_for_if(name):
2021-12-01 10:39:40 +00:00
import importlib
2021-12-01 10:46:19 +00:00
if importlib.util.find_spec('netifaces') != None:
2021-12-01 10:39:40 +00:00
import netifaces
return netifaces.ifaddresses(name)[netifaces.AF_INET][0]['broadcast']
else:
RNS.log("Getting interface addresses from device names requires the netifaces module.", RNS.LOG_CRITICAL)
RNS.log("You can install it with the command: python3 -m pip install netifaces", RNS.LOG_CRITICAL)
RNS.panic()
def __init__(self, owner, name, device=None, bindip=None, bindport=None, forwardip=None, forwardport=None):
2021-09-24 18:10:04 +00:00
self.rxb = 0
self.txb = 0
2016-06-03 17:02:02 +00:00
self.IN = True
self.OUT = False
2018-04-05 17:12:21 +00:00
self.name = name
2021-09-24 18:10:04 +00:00
self.online = False
self.bitrate = UDPInterface.BITRATE_GUESS
2018-04-05 17:12:21 +00:00
if device != None:
if bindip == None:
bindip = UDPInterface.get_broadcast_for_if(device)
if forwardip == None:
forwardip = UDPInterface.get_broadcast_for_if(device)
2016-06-03 17:02:02 +00:00
if (bindip != None and bindport != None):
self.receives = True
self.bind_ip = bindip
self.bind_port = bindport
2020-03-01 15:56:49 +00:00
def handlerFactory(callback):
def createHandler(*args, **keys):
2020-08-13 10:37:54 +00:00
return UDPInterfaceHandler(callback, *args, **keys)
2020-03-01 15:56:49 +00:00
return createHandler
2016-06-03 17:02:02 +00:00
self.owner = owner
address = (self.bind_ip, self.bind_port)
socketserver.UDPServer.address_family = socket.AF_INET
2020-04-22 10:07:13 +00:00
self.server = socketserver.UDPServer(address, handlerFactory(self.processIncoming))
2016-06-03 17:02:02 +00:00
thread = threading.Thread(target=self.server.serve_forever)
thread.setDaemon(True)
thread.start()
2021-09-24 18:10:04 +00:00
self.online = True
2016-06-03 17:02:02 +00:00
if (forwardip != None and forwardport != None):
self.forwards = True
self.forward_ip = forwardip
self.forward_port = forwardport
def processIncoming(self, data):
2021-09-24 18:10:04 +00:00
self.rxb += len(data)
self.owner.inbound(data, self)
2016-06-03 17:02:02 +00:00
def processOutgoing(self,data):
try:
udp_socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
udp_socket.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
udp_socket.sendto(data, (self.forward_ip, self.forward_port))
2021-09-24 18:10:04 +00:00
self.txb += len(data)
except Exception as e:
RNS.log("Could not transmit on "+str(self)+". The contained exception was: "+str(e), RNS.LOG_ERROR)
2016-06-03 17:02:02 +00:00
def __str__(self):
2020-08-13 10:37:54 +00:00
return "UDPInterface["+self.name+"/"+self.bind_ip+":"+str(self.bind_port)+"]"
2016-06-03 17:02:02 +00:00
2020-08-13 10:37:54 +00:00
class UDPInterfaceHandler(socketserver.BaseRequestHandler):
2020-03-01 15:56:49 +00:00
def __init__(self, callback, *args, **keys):
self.callback = callback
2020-04-22 10:07:13 +00:00
socketserver.BaseRequestHandler.__init__(self, *args, **keys)
2016-06-03 17:02:02 +00:00
def handle(self):
2020-03-01 15:56:49 +00:00
data = self.request[0]
self.callback(data)