mirror of
https://github.com/JoelBender/bacpypes
synced 2025-10-27 00:57:47 +08:00
merge in NAT stuff from #178
This commit is contained in:
Joel Bender
@@ -1007,6 +1007,309 @@ class BIPBBMD(BIPSAP, Client, Server, RecurringTask, DebugContents):
|
||||
|
||||
bacpypes_debugging(BIPBBMD)
|
||||
|
||||
#
|
||||
# BIPNAT
|
||||
#
|
||||
|
||||
class BIPNAT(BIPSAP, Client, Server, RecurringTask, DebugContents):
|
||||
|
||||
_debug_contents = ('bbmdAddress', 'bbmdBDT+', 'bbmdFDT+')
|
||||
|
||||
def __init__(self, addr, sapID=None, cid=None, sid=None):
|
||||
"""A BBMD node that is the destination for NATed traffic."""
|
||||
if _debug: BIPNAT._debug("__init__ %r sapID=%r cid=%r sid=%r", addr, sapID, cid, sid)
|
||||
BIPSAP.__init__(self, sapID)
|
||||
Client.__init__(self, cid)
|
||||
Server.__init__(self, sid)
|
||||
RecurringTask.__init__(self, 1000.0)
|
||||
|
||||
self.bbmdAddress = addr
|
||||
self.bbmdBDT = []
|
||||
self.bbmdFDT = []
|
||||
|
||||
# install so process_task runs
|
||||
self.install_task()
|
||||
|
||||
def indication(self, pdu):
|
||||
if _debug: BIPNAT._debug("indication %r", pdu)
|
||||
|
||||
# check for local stations
|
||||
if pdu.pduDestination.addrType == Address.localStationAddr:
|
||||
###TODO the destination should be a peer or a registered foreign device
|
||||
|
||||
# make an original unicast PDU
|
||||
xpdu = OriginalUnicastNPDU(pdu, user_data=pdu.pduUserData)
|
||||
xpdu.pduDestination = pdu.pduDestination
|
||||
if _debug: BIPNAT._debug(" - xpdu: %r", xpdu)
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
# check for broadcasts
|
||||
elif pdu.pduDestination.addrType == Address.localBroadcastAddr:
|
||||
# make a forwarded PDU
|
||||
xpdu = ForwardedNPDU(self.bbmdAddress, pdu, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - forwarded xpdu: %r", xpdu)
|
||||
|
||||
# send it to the peers, all of them have all F's mask
|
||||
for bdte in self.bbmdBDT:
|
||||
if bdte != self.bbmdAddress:
|
||||
xpdu.pduDestination = Address((bdte.addrIP, bdte.addrPort))
|
||||
BIPNAT._debug(" - sending to peer: %r", xpdu.pduDestination)
|
||||
self.request(xpdu)
|
||||
|
||||
# send it to the registered foreign devices
|
||||
for fdte in self.bbmdFDT:
|
||||
xpdu.pduDestination = fdte.fdAddress
|
||||
if _debug: BIPNAT._debug(" - sending to foreign device: %r", xpdu.pduDestination)
|
||||
self.request(xpdu)
|
||||
|
||||
else:
|
||||
BIPNAT._warning("invalid destination address: %r", pdu.pduDestination)
|
||||
|
||||
def confirmation(self, pdu):
|
||||
if _debug: BIPNAT._debug("confirmation %r", pdu)
|
||||
|
||||
# some kind of response to a request
|
||||
if isinstance(pdu, Result):
|
||||
# send this to the service access point
|
||||
self.sap_response(pdu)
|
||||
|
||||
elif isinstance(pdu, WriteBroadcastDistributionTable):
|
||||
###TODO verify this is from a management network/address
|
||||
|
||||
# build a response
|
||||
xpdu = Result(code=99, user_data=pdu.pduUserData)
|
||||
xpdu.pduDestination = pdu.pduSource
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, ReadBroadcastDistributionTable):
|
||||
###TODO verify this is from a management network/address
|
||||
|
||||
# build a response
|
||||
xpdu = ReadBroadcastDistributionTableAck(self.bbmdBDT, user_data=pdu.pduUserData)
|
||||
xpdu.pduDestination = pdu.pduSource
|
||||
if _debug: BIPNAT._debug(" - xpdu: %r", xpdu)
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, ReadBroadcastDistributionTableAck):
|
||||
# send this to the service access point
|
||||
self.sap_response(pdu)
|
||||
|
||||
elif isinstance(pdu, ForwardedNPDU):
|
||||
###TODO verify this is from a peer
|
||||
|
||||
# build a PDU with the source from the real source
|
||||
xpdu = PDU(pdu.pduData, source=pdu.bvlciAddress, destination=LocalBroadcast(), user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - upstream xpdu: %r", xpdu)
|
||||
|
||||
# send it upstream
|
||||
self.response(xpdu)
|
||||
|
||||
# build a forwarded NPDU to send out
|
||||
xpdu = ForwardedNPDU(pdu.bvlciAddress, pdu, destination=None, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - forwarded xpdu: %r", xpdu)
|
||||
|
||||
# send it to the registered foreign devices
|
||||
for fdte in self.bbmdFDT:
|
||||
xpdu.pduDestination = fdte.fdAddress
|
||||
if _debug: BIPNAT._debug(" - sending to foreign device: %r", xpdu.pduDestination)
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, RegisterForeignDevice):
|
||||
###TODO verify this is from an acceptable address
|
||||
|
||||
# process the request
|
||||
stat = self.register_foreign_device(pdu.pduSource, pdu.bvlciTimeToLive)
|
||||
|
||||
# build a response
|
||||
xpdu = Result(code=stat, destination=pdu.pduSource, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - xpdu: %r", xpdu)
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, ReadForeignDeviceTable):
|
||||
###TODO verify this is from a management network/address
|
||||
|
||||
# build a response
|
||||
xpdu = ReadForeignDeviceTableAck(self.bbmdFDT, destination=pdu.pduSource, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - xpdu: %r", xpdu)
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, ReadForeignDeviceTableAck):
|
||||
# send this to the service access point
|
||||
self.sap_response(pdu)
|
||||
|
||||
elif isinstance(pdu, DeleteForeignDeviceTableEntry):
|
||||
###TODO verify this is from a management network/address
|
||||
|
||||
# process the request
|
||||
stat = self.delete_foreign_device_table_entry(pdu.bvlciAddress)
|
||||
|
||||
# build a response
|
||||
xpdu = Result(code=stat, user_data=pdu.pduUserData)
|
||||
xpdu.pduDestination = pdu.pduSource
|
||||
if _debug: BIPNAT._debug(" - xpdu: %r", xpdu)
|
||||
|
||||
# send it downstream
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, DistributeBroadcastToNetwork):
|
||||
###TODO verify this is from a registered foreign device
|
||||
|
||||
# build a PDU with a local broadcast address
|
||||
xpdu = PDU(pdu.pduData, source=pdu.pduSource, destination=LocalBroadcast(), user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - upstream xpdu: %r", xpdu)
|
||||
|
||||
# send it upstream
|
||||
self.response(xpdu)
|
||||
|
||||
# build a forwarded NPDU to send out
|
||||
xpdu = ForwardedNPDU(pdu.pduSource, pdu, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - forwarded xpdu: %r", xpdu)
|
||||
|
||||
# send it to the peers
|
||||
for bdte in self.bbmdBDT:
|
||||
if bdte == self.bbmdAddress:
|
||||
if _debug: BIPNAT._debug(" - no local broadcast")
|
||||
else:
|
||||
xpdu.pduDestination = Address((bdte.addrIP, bdte.addrPort))
|
||||
if _debug: BIPNAT._debug(" - sending to peer: %r", xpdu.pduDestination)
|
||||
self.request(xpdu)
|
||||
|
||||
# send it to the other registered foreign devices
|
||||
for fdte in self.bbmdFDT:
|
||||
if fdte.fdAddress != pdu.pduSource:
|
||||
xpdu.pduDestination = fdte.fdAddress
|
||||
if _debug: BIPNAT._debug(" - sending to foreign device: %r", xpdu.pduDestination)
|
||||
self.request(xpdu)
|
||||
|
||||
elif isinstance(pdu, OriginalUnicastNPDU):
|
||||
###TODO verify this is from a peer
|
||||
|
||||
# build a vanilla PDU
|
||||
xpdu = PDU(pdu.pduData, source=pdu.pduSource, destination=pdu.pduDestination, user_data=pdu.pduUserData)
|
||||
if _debug: BIPNAT._debug(" - upstream xpdu: %r", xpdu)
|
||||
|
||||
# send it upstream
|
||||
self.response(xpdu)
|
||||
|
||||
elif isinstance(pdu, OriginalBroadcastNPDU):
|
||||
if _debug: BIPNAT._debug(" - original broadcast dropped")
|
||||
|
||||
else:
|
||||
BIPNAT._warning("invalid pdu type: %s", type(pdu))
|
||||
|
||||
def register_foreign_device(self, addr, ttl):
|
||||
"""Add a foreign device to the FDT."""
|
||||
if _debug: BIPNAT._debug("register_foreign_device %r %r", addr, ttl)
|
||||
|
||||
# see if it is an address or make it one
|
||||
if isinstance(addr, Address):
|
||||
pass
|
||||
elif isinstance(addr, str):
|
||||
addr = LocalStation( addr )
|
||||
else:
|
||||
raise TypeError("addr must be a string or an Address")
|
||||
|
||||
for fdte in self.bbmdFDT:
|
||||
if addr == fdte.fdAddress:
|
||||
break
|
||||
else:
|
||||
fdte = FDTEntry()
|
||||
fdte.fdAddress = addr
|
||||
self.bbmdFDT.append( fdte )
|
||||
|
||||
fdte.fdTTL = ttl
|
||||
fdte.fdRemain = ttl + 5
|
||||
|
||||
# return success
|
||||
return 0
|
||||
|
||||
def delete_foreign_device_table_entry(self, addr):
|
||||
if _debug: BIPNAT._debug("delete_foreign_device_table_entry %r", addr)
|
||||
|
||||
# see if it is an address or make it one
|
||||
if isinstance(addr, Address):
|
||||
pass
|
||||
elif isinstance(addr, str):
|
||||
addr = LocalStation( addr )
|
||||
else:
|
||||
raise TypeError("addr must be a string or an Address")
|
||||
|
||||
# find it and delete it
|
||||
stat = 0
|
||||
for i in range(len(self.bbmdFDT)-1, -1, -1):
|
||||
if addr == self.bbmdFDT[i].fdAddress:
|
||||
del self.bbmdFDT[i]
|
||||
break
|
||||
else:
|
||||
stat = 99 ### entry not found
|
||||
|
||||
# return status
|
||||
return stat
|
||||
|
||||
def process_task(self):
|
||||
# look for foreign device registrations that have expired
|
||||
for i in range(len(self.bbmdFDT)-1, -1, -1):
|
||||
fdte = self.bbmdFDT[i]
|
||||
fdte.fdRemain -= 1
|
||||
|
||||
# delete it if it expired
|
||||
if fdte.fdRemain <= 0:
|
||||
if _debug: BIPNAT._debug("foreign device expired: %r", fdte.fdAddress)
|
||||
del self.bbmdFDT[i]
|
||||
|
||||
def add_peer(self, addr):
|
||||
if _debug: BIPNAT._debug("add_peer %r", addr)
|
||||
|
||||
# see if it is an address or make it one
|
||||
if isinstance(addr, Address):
|
||||
pass
|
||||
elif isinstance(addr, str):
|
||||
addr = LocalStation(addr)
|
||||
else:
|
||||
raise TypeError("addr must be a string or an Address")
|
||||
|
||||
# if it's this BBMD, make it the first one
|
||||
if self.bbmdBDT and (addr == self.bbmdAddress):
|
||||
raise RuntimeError("add self to BDT as first address")
|
||||
|
||||
# see if it's already there
|
||||
for bdte in self.bbmdBDT:
|
||||
if addr == bdte:
|
||||
break
|
||||
else:
|
||||
self.bbmdBDT.append(addr)
|
||||
|
||||
def delete_peer(self, addr):
|
||||
if _debug: BIPNAT._debug("delete_peer %r", addr)
|
||||
|
||||
# see if it is an address or make it one
|
||||
if isinstance(addr, Address):
|
||||
pass
|
||||
elif isinstance(addr, str):
|
||||
addr = LocalStation(addr)
|
||||
else:
|
||||
raise TypeError("addr must be a string or an Address")
|
||||
|
||||
# look for the peer address
|
||||
for i in range(len(self.bbmdBDT)-1, -1, -1):
|
||||
if addr == self.bbmdBDT[i]:
|
||||
del self.bbmdBDT[i]
|
||||
break
|
||||
else:
|
||||
pass
|
||||
|
||||
bacpypes_debugging(BIPNAT)
|
||||
|
||||
#
|
||||
# BVLLServiceElement
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user