6aef3febc6
Figured out several of the flags previously unknown, and corrected an error: the bits for data call or voice call were transposed.
291 lines
12 KiB
Python
291 lines
12 KiB
Python
from __future__ import print_function
|
|
from twisted.internet.protocol import DatagramProtocol
|
|
from twisted.internet import reactor
|
|
from twisted.internet import task
|
|
import argparse
|
|
import binascii
|
|
import hmac
|
|
import hashlib
|
|
import logging
|
|
from logging.config import dictConfig
|
|
|
|
dictConfig({
|
|
'version': 1,
|
|
'disable_existing_loggers': False,
|
|
'filters': {
|
|
},
|
|
'formatters': {
|
|
'verbose': {
|
|
'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
|
|
},
|
|
'timed': {
|
|
'format': '%(levelname)s %(asctime)s %(message)s'
|
|
},
|
|
'simple': {
|
|
'format': '%(levelname)s %(message)s'
|
|
},
|
|
},
|
|
'handlers': {
|
|
'console': {
|
|
'level': 'DEBUG',
|
|
'class': 'logging.StreamHandler',
|
|
'formatter': 'simple'
|
|
},
|
|
'file': {
|
|
'level': 'DEBUG',
|
|
'class': 'logging.FileHandler',
|
|
'formatter': 'simple',
|
|
'filename': '/tmp/ipsc.log',
|
|
},
|
|
'console-timed': {
|
|
'level': 'DEBUG',
|
|
'class': 'logging.StreamHandler',
|
|
'formatter': 'timed'
|
|
},
|
|
'file-timed': {
|
|
'level': 'DEBUG',
|
|
'class': 'logging.FileHandler',
|
|
'formatter': 'timed',
|
|
'filename': '/tmp/ipsc.log',
|
|
},
|
|
},
|
|
'loggers': {
|
|
'ipsc': {
|
|
# 'handlers': ['file-timed', 'console-timed'],
|
|
'handlers': ['file', 'console'],
|
|
'level': 'DEBUG',
|
|
'propagate': True,
|
|
}
|
|
}
|
|
})
|
|
logger = logging.getLogger('ipsc')
|
|
|
|
|
|
# Data structure for holding IPSC information
|
|
try:
|
|
from my_ipsc_config import NETWORK
|
|
except ImportError:
|
|
NETWORK = {
|
|
'IPSC1': {
|
|
'LOCAL': {
|
|
'DESCRIPTION': 'IPSC Network #1',
|
|
'MODE': b'\x65',
|
|
'FLAGS': b'\x00\x00\x80\xDC',
|
|
'PORT': 50001,
|
|
'ALIVE_TIMER': 10, # Seconds between keep-alives and registration attempts
|
|
'RADIO_ID': binascii.unhexlify('0000000A'),
|
|
'AUTH_KEY': binascii.unhexlify('0000000000000000000000000000000000000001')
|
|
},
|
|
'MASTER': {
|
|
'IP': '1.2.3.4',
|
|
'PORT': 50000,
|
|
'STATUS': {
|
|
'RADIO_ID': '',
|
|
'CONNECTED': 0,
|
|
'KEEP_ALIVES_MISSED': 0,
|
|
'MODE': b'\x00',
|
|
'FLAGS': b'\x00\x00\x00\x00',
|
|
}
|
|
},
|
|
'PEERS': []
|
|
}
|
|
}
|
|
# each list item contains {
|
|
# 'IP': '100.200.1.1',
|
|
# 'PORT': 50000,
|
|
# 'RADIO_ID': b'\x00\x00\x00\xFF',
|
|
# 'STATUS': {
|
|
# 'CONNECTED': 0,
|
|
# 'KEEP_ALIVES_MISSED': 0
|
|
# }
|
|
# },
|
|
#
|
|
# IPSC2.... etc... repeat as many times as you have resources for
|
|
|
|
|
|
# Known IPSC Message Types
|
|
CALL_CTL_1 = b'\x61' # |
|
|
CALL_CTL_2 = b'\x62' # | Exact meaning unknown
|
|
CALL_CTL_3 = b'\x63' # |
|
|
XCMP_XNL = b'\x70' # XCMP/XNL control message
|
|
GROUP_VOICE = b'\x80'
|
|
GROUP_DATA = b'\x83'
|
|
PVT_DATA = b'\x84'
|
|
RPT_WAKE_UP = b'\x85' # Similar to OTA DMR "wake up"
|
|
MASTER_REG_REQ = b'\x90' # FROM peer TO master
|
|
MASTER_REG_REPLY = b'\x91' # FROM master TO peer
|
|
PEER_LIST_REQ = b'\x92'
|
|
PEER_LIST_REPLY = b'\x93'
|
|
PEER_REG_REQUEST = b'\x94' # Peer registration request
|
|
PEER_REG_REPLY = b'\x95' # Peer registration reply
|
|
MASTER_ALIVE_REQ = b'\x96' # FROM peer TO master
|
|
MASTER_ALIVE_REPLY = b'\x97' # FROM master TO peer
|
|
PEER_ALIVE_REQ = b'\x98' # Peer keep alive request
|
|
PEER_ALIVE_REPLY = b'\x99' # Peer keep alive reply
|
|
DE_REG_REQ = b'\x9A' # Request de-registration from system
|
|
DE_REG_REPLY = b'\x9B' # De-registration reply
|
|
|
|
# IPSC Version Information
|
|
IPSC_OP_VER = b'\x04\x03' # 0x04, 0x03 -- seems to be current version of IPSC
|
|
IPSC_OLD_VER = b'\x04\x00' # 0x04, 0x02 -- oldest version of IPSC suppoerted
|
|
IPSC_VER = IPSC_OP_VER + IPSC_OLD_VER
|
|
|
|
|
|
def hashed_packet(key, data):
|
|
hash = binascii.unhexlify((hmac.new(key,data,hashlib.sha1)).hexdigest()[:20])
|
|
return (data + hash)
|
|
|
|
def print_peer_list(_ipsc_network):
|
|
logger.info('%s', _ipsc_network['LOCAL']['DESCRIPTION'])
|
|
for dictionary in _ipsc_network['PEERS']:
|
|
hex_address = dictionary['IP']
|
|
hex_port = dictionary['PORT']
|
|
hex_radio_id = dictionary['RADIO_ID']
|
|
hex_mode = dictionary['MODE']
|
|
|
|
address = [int(hex_address[0:2], 16), int(hex_address[2:4], 16), int(hex_address[4:6], 16), int(hex_address[6:8], 16)]
|
|
port = int(hex_port, 16)
|
|
radio_id = int(hex_radio_id, 16)
|
|
|
|
logger.info('\tIP Address: %s.%s.%s.%s:%s', address[0], address[1], address[2], address[3], port)
|
|
logger.info('\tRADIO ID: %s ', radio_id)
|
|
logger.info("\tIPSC Mode: %s", hex_mode)
|
|
logger.info("")
|
|
|
|
class IPSC(DatagramProtocol):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
if len(args) == 1:
|
|
self._config = args[0]
|
|
args = ()
|
|
self.TS_FLAGS = (self._config['LOCAL']['MODE'] + self._config['LOCAL']['FLAGS'])
|
|
self.MASTER_REG_REQ_PKT = (MASTER_REG_REQ + self._config['LOCAL']['RADIO_ID'] + self.TS_FLAGS + IPSC_VER)
|
|
self.MASTER_ALIVE_PKT = (MASTER_ALIVE_REQ + self._config['LOCAL']['RADIO_ID'] + self.TS_FLAGS + IPSC_VER)
|
|
self.PEER_LIST_REQ_PKT = (PEER_LIST_REQ + self._config['LOCAL']['RADIO_ID'])
|
|
self.PEER_REG_REPLY_PKT = (PEER_REG_REPLY + self._config['LOCAL']['RADIO_ID'] + IPSC_VER)
|
|
self.PEER_ALIVE_REQ_PKT = (PEER_ALIVE_REQ + self._config['LOCAL']['RADIO_ID'] + self.TS_FLAGS)
|
|
self.PEER_ALIVE_REPLY_PKT = (PEER_ALIVE_REPLY + self._config['LOCAL']['RADIO_ID'] + self.TS_FLAGS)
|
|
else:
|
|
logger.error("Unexpected arguments found.")
|
|
|
|
def keepAlive(self):
|
|
_master_connected = self._config['MASTER']['STATUS']['CONNECTED']
|
|
# logger.debug("keepAlive Routine Running in Condition %s", _master_connected)
|
|
|
|
if (_master_connected == 0):
|
|
logger.info("*** Starting up IPSC Client and Registering to the Master ***")
|
|
reg_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.MASTER_REG_REQ_PKT)
|
|
self.transport.write(reg_packet, (self._config['MASTER']['IP'], self._config['MASTER']['PORT']))
|
|
logger.info("->> Sending Registration to Master:%s:%sFrom:%s\n", self._config['MASTER']['IP'], self._config['MASTER']['PORT'], binascii.b2a_hex(self._config['LOCAL']['RADIO_ID']))
|
|
|
|
elif (_master_connected in (1,2)):
|
|
if (_master_connected == 1):
|
|
peer_list_req_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.PEER_LIST_REQ_PKT)
|
|
self.transport.write(peer_list_req_packet, (self._config['MASTER']['IP'], self._config['MASTER']['PORT']))
|
|
logger.info("->> Peer List Reqested from Master:%s:%s\n", self._config['MASTER']['IP'], self._config['MASTER']['PORT'])
|
|
|
|
master_alive_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.MASTER_ALIVE_PKT)
|
|
self.transport.write(master_alive_packet, (self._config['MASTER']['IP'], self._config['MASTER']['PORT']))
|
|
logger.info("->> Master Keep Alive Sent To:%s:%s\n", self._config['MASTER']['IP'], self._config['MASTER']['PORT'])
|
|
|
|
elif (_master_connected == 2):
|
|
master_alive_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.MASTER_ALIVE_PKT)
|
|
self.transport.write(master_alive_packet, (self._config['MASTER']['IP'], self._config['MASTER']['PORT']))
|
|
logger.info("->> Master Keep Alive Sent To:%s:%s\n", self._config['MASTER']['IP'], self._config['MASTER']['PORT'])
|
|
|
|
else:
|
|
logger.error("->> Resetting Masteter in UNKOWN STATE:%s:%s\n", self._config['MASTER']['IP'], self._config['MASTER']['PORT'])
|
|
|
|
|
|
# logger.debug("keepAlive Routine ending at Condition %s", _master_connected)
|
|
|
|
def startProtocol(self):
|
|
logger.debug("*** config: %s", self._config)
|
|
logger.info("")
|
|
|
|
self._call = task.LoopingCall(self.keepAlive)
|
|
self._loop = self._call.start(self._config['LOCAL']['ALIVE_TIMER'])
|
|
|
|
def datagramReceived(self, data, (host, port)):
|
|
dest_ip = self._config['MASTER']['IP']
|
|
dest_port = self._config['MASTER']['PORT']
|
|
#logger.info("received %r from %s:%d", binascii.b2a_hex(data), host, port)
|
|
|
|
_packettype = (data[0:1])
|
|
|
|
if (_packettype == MASTER_REG_REQ):
|
|
logger.info("<<- Registration Packet Recieved\n")
|
|
|
|
elif (_packettype == MASTER_REG_REPLY):
|
|
self._config['MASTER']['STATUS']['CONNECTED'] = 1
|
|
logger.info("<<- Master Registration Reply From:%s:%s Setting Condition %s", host, port,self._config['MASTER']['STATUS']['CONNECTED'])
|
|
|
|
elif (_packettype == PEER_REG_REQUEST):
|
|
logger.info("<<- Peer Registration Request From:%s:%s", host, port)
|
|
peer_reg_reply_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.PEER_REG_REPLY_PKT)
|
|
self.transport.write(peer_reg_reply_packet, (host, port))
|
|
logger.info("->> Peer Registration Reply Sent To:%s:%s\n", host, port)
|
|
#logger.info("%s:%s", host, port)
|
|
#logger.info(binascii.b2a_hex(peer_reg_reply_packet))
|
|
|
|
elif (_packettype == PEER_ALIVE_REQ):
|
|
logger.info("<<- Received Peer Keep Alive From:%s:%s", host, port)
|
|
peer_alive_req_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.PEER_ALIVE_REQ_PKT)
|
|
peer_alive_reply_packet = hashed_packet(self._config['LOCAL']['AUTH_KEY'], self.PEER_ALIVE_REPLY_PKT)
|
|
self.transport.write(peer_alive_reply_packet, (host, port))
|
|
logger.info("->> Sent Peer Keep Alive Reply To:%s:%s", host, port)
|
|
self.transport.write(peer_alive_req_packet, (host, port))
|
|
logger.info("->> Sent Peer Keep Alive Request To:%s:%s\n", host, port)
|
|
#logger.info(binascii.b2a_hex(peer_alive_req_packet))
|
|
|
|
elif (_packettype == MASTER_ALIVE_REPLY):
|
|
logger.info("<<- Keep Alive Received from Master:%s:%s\n", host, port)
|
|
|
|
elif (_packettype == PEER_ALIVE_REPLY):
|
|
logger.info("<<- Keep Alive Received from Peer:%s:%s\n", host, port)
|
|
|
|
elif (_packettype == XCMP_XNL):
|
|
logger.info("<<- XCMP_XNL and/or Control Packet From:%s:%s\n", host, port)
|
|
|
|
elif (_packettype == PEER_LIST_REPLY):
|
|
logger.info("<<- The Peer List has been Received from Master:%s:%s Setting Condition 2", host, port)
|
|
self._config['MASTER']['STATUS']['CONNECTED'] = 2
|
|
_num_peers = int(str(int(binascii.b2a_hex(data[5:7]), 16))[1:])
|
|
logger.info(' There are %s peers in this IPSC Network', _num_peers)
|
|
del self._config['PEERS'][:]
|
|
for i in range(7, (_num_peers*11)+7, 11):
|
|
self._config['PEERS'].append({
|
|
'RADIO_ID': binascii.b2a_hex(data[i:i+4]),
|
|
'IP': binascii.b2a_hex(data[i+4:i+8]),
|
|
'PORT': binascii.b2a_hex(data[i+8:i+10]),
|
|
'MODE': binascii.b2a_hex(data[i+10:i+11])
|
|
})
|
|
print_peer_list(self._config)
|
|
logger.info("")
|
|
|
|
|
|
else:
|
|
packet_type = binascii.b2a_hex(_packettype)
|
|
# logger.error("<<- Received Unprocessed Type %s From:%s:%s\n", packet_type, host, port)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
parser = argparse.ArgumentParser(description="Start an IPSC client.")
|
|
parser.add_argument('-n', '--network', required=False)
|
|
args = parser.parse_args()
|
|
|
|
if args.network is not None:
|
|
if args.network in NETWORK:
|
|
logger.info("Connecting to %s", args.network)
|
|
reactor.listenUDP(NETWORK[args.network]['LOCAL']['PORT'], IPSC(NETWORK[args.network]))
|
|
else:
|
|
logger.info("%s is not a configured ISPC network.", args.network)
|
|
exit()
|
|
|
|
else: # connect to all
|
|
logger.info("No network supplied, connecting to all networks.")
|
|
for ipsc_network in NETWORK:
|
|
reactor.listenUDP(NETWORK[ipsc_network]['LOCAL']['PORT'], IPSC(NETWORK[ipsc_network]))
|
|
|
|
reactor.run()
|