From 3f784185abee093f5bcdd34bd39bccc174aca96b Mon Sep 17 00:00:00 2001 From: Simon Date: Mon, 27 Dec 2021 01:47:58 +0000 Subject: [PATCH] tidy up FreeDMR module and class structure and dirs --- FreeDMR/Const/const.py | 78 ++++ FreeDMR/Const/reporting_const.py | 30 ++ FreeDMR/Protocol/HomeBrewProtocol.py | 629 ++++++++++++++++++++++++++ FreeDMR/Protocol/OpenBridge.py | 254 +++++++++++ FreeDMR/Utilities/.report.py.kate-swp | Bin 0 -> 89 bytes FreeDMR/Utilities/mysql_config.py | 107 +++++ FreeDMR/Utilities/read_ambe.py | 175 +++++++ FreeDMR/Utilities/report.py | 47 ++ FreeDMR/Utilities/reportFactory.py | 69 +++ FreeDMR/freedmr.py | 206 +++++++++ FreeDMR/i8n/i8n_voice_map.py | 348 ++++++++++++++ 11 files changed, 1943 insertions(+) create mode 100755 FreeDMR/Const/const.py create mode 100755 FreeDMR/Const/reporting_const.py create mode 100644 FreeDMR/Protocol/HomeBrewProtocol.py create mode 100644 FreeDMR/Protocol/OpenBridge.py create mode 100644 FreeDMR/Utilities/.report.py.kate-swp create mode 100644 FreeDMR/Utilities/mysql_config.py create mode 100644 FreeDMR/Utilities/read_ambe.py create mode 100644 FreeDMR/Utilities/report.py create mode 100644 FreeDMR/Utilities/reportFactory.py create mode 100644 FreeDMR/freedmr.py create mode 100644 FreeDMR/i8n/i8n_voice_map.py diff --git a/FreeDMR/Const/const.py b/FreeDMR/Const/const.py new file mode 100755 index 0000000..c491223 --- /dev/null +++ b/FreeDMR/Const/const.py @@ -0,0 +1,78 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +''' +These are contants used by HBlink. Rather than stuff them into the main program +file, any new constants should be placed here. It makes them easier to keep track +of and keeps hblink.py shorter. +''' + +__author__ = 'Cortney T. Buffington, N0MJS' +__copyright__ = 'Copyright (c) 2016 Cortney T. Buffington, N0MJS and the K0USY Group' +__credits__ = '' +__license__ = 'GNU GPLv3' +__maintainer__ = 'Cort Buffington, N0MJS' +__email__ = 'n0mjs@me.com' + + +# DMR Related constants +ID_MIN = 1 +ID_MAX = 16776415 + +# Timers +STREAM_TO = .360 + +# Options from the LC - used for late entry +LC_OPT = b'\x00\x00\x20' + +# HomeBrew Protocol Frame Types +HBPF_VOICE = 0x0 +HBPF_VOICE_SYNC = 0x1 +HBPF_DATA_SYNC = 0x2 +HBPF_SLT_VHEAD = 0x1 +HBPF_SLT_VTERM = 0x2 + +# HomeBrew Protocol Commands +DMRD = b'DMRD' +MSTCL = b'MSTCL' +MSTNAK = b'MSTNAK' +MSTPONG = b'MSTPONG' +MSTN = b'MSTN' +MSTP = b'MSTP' +MSTC = b'MSTC' +RPTL = b'RPTL' +RPTPING = b'RPTPING' +RPTCL = b'RPTCL' +RPTL = b'RPTL' +RPTACK = b'RPTACK' +RPTK = b'RPTK' +RPTC = b'RPTC' +RPTP = b'RPTP' +RPTA = b'RPTA' +RPTO = b'RPTO' +DMRA = b'DMRA' + +#Bridge Control commands +BC = b'BC' +BCKA = b'BCKA' +BCSQ = b'BCSQ' + +# Higheset peer ID permitted by HBP +PEER_MAX = 4294967295 diff --git a/FreeDMR/Const/reporting_const.py b/FreeDMR/Const/reporting_const.py new file mode 100755 index 0000000..332e515 --- /dev/null +++ b/FreeDMR/Const/reporting_const.py @@ -0,0 +1,30 @@ +############################################################################### +# Copyright (C) 2018 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +# Opcodes for the network-based reporting protocol + +REPORT_OPCODES = { + 'CONFIG_REQ': b'\x00', + 'CONFIG_SND': b'\x01', + 'BRIDGE_REQ': b'\x02', + 'BRIDGE_SND': b'\x03', + 'CONFIG_UPD': b'\x04', + 'BRIDGE_UPD': b'\x05', + 'LINK_EVENT': b'\x06', + 'BRDG_EVENT': b'\x07', + } diff --git a/FreeDMR/Protocol/HomeBrewProtocol.py b/FreeDMR/Protocol/HomeBrewProtocol.py new file mode 100644 index 0000000..bef5868 --- /dev/null +++ b/FreeDMR/Protocol/HomeBrewProtocol.py @@ -0,0 +1,629 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +''' +This program does very little on its own. It is intended to be used as a module +to build applications on top of the HomeBrew Repeater Protocol. By itself, it +will only act as a peer or master for the systems specified in its configuration +file (usually freedmr.cfg). It is ALWAYS best practice to ensure that this program +works stand-alone before troubleshooting any applications that use it. It has +sufficient logging to be used standalone as a troubleshooting application. +''' + +# Specifig functions from modules we need +from binascii import b2a_hex as ahex +from binascii import a2b_hex as bhex +from random import randint +from hashlib import sha256, sha1 +from hmac import new as hmac_new, compare_digest +from time import time +from collections import deque + +# Twisted is pretty important, so I keep it separate +from twisted.internet.protocol import DatagramProtocol, Factory, Protocol +from twisted.protocols.basic import NetstringReceiver +from twisted.internet import reactor, task + +# Other files we pull from -- this is mostly for readability and segmentation +import log +import config +from FreeDMR.Const.const import * +from dmr_utils3.utils import int_id, bytes_4, try_download, mk_id_dict + +# Imports for the reporting server +import pickle +from FreeDMR.Const.reporting_const import * + + +# The module needs logging logging, but handlers, etc. are controlled by the parent +import logging +logger = logging.getLogger(__name__) + +# Does anybody read this stuff? There's a PEP somewhere that says I should do this. +__author__ = 'Cortney T. Buffington, N0MJS, Forked by Simon Adlem - G7RZU' +__copyright__ = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group, Simon Adlem, G7RZU 2020,2021' +__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT; Jon Lee, G4TSN; Norman Williams, M6NBP' +__license__ = 'GNU GPLv3' +__maintainer__ = 'Simon Adlem G7RZU' +__email__ = 'simon@gb7fr.org.uk' + +#************************************************ +# HB MASTER CLASS +#************************************************ + +class HBSYSTEM(DatagramProtocol): + def __init__(self, _name, _config, _report): + # Define a few shortcuts to make the rest of the class more readable + self._CONFIG = _config + self._system = _name + self._report = _report + self._config = self._CONFIG['SYSTEMS'][self._system] + self._laststrid = {1: b'', 2: b''} + + + # Define shortcuts and generic function names based on the type of system we are + if self._config['MODE'] == 'MASTER': + self._peers = self._CONFIG['SYSTEMS'][self._system]['PEERS'] + self.send_system = self.send_peers + self.maintenance_loop = self.master_maintenance_loop + self.datagramReceived = self.master_datagramReceived + self.dereg = self.master_dereg + + elif self._config['MODE'] == 'PEER': + self._stats = self._config['STATS'] + self._stats['DNS_TIME'] = time() + self.send_system = self.send_master + self.maintenance_loop = self.peer_maintenance_loop + self.datagramReceived = self.peer_datagramReceived + self.dereg = self.peer_dereg + + elif self._config['MODE'] == 'XLXPEER': + self._stats = self._config['XLXSTATS'] + self._stats['DNS_TIME'] = time() + self.send_system = self.send_master + self.maintenance_loop = self.peer_maintenance_loop + self.datagramReceived = self.peer_datagramReceived + self.dereg = self.peer_dereg + + def loopingErrHandle(self,failure): + logger.error('(GLOBAL - freedmr.py) Unhandled error in timed loop.\n %s', failure) + + def startProtocol(self): + # Set up periodic loop for tracking pings from peers. Run every 'PING_TIME' seconds + self._system_maintenance = task.LoopingCall(self.maintenance_loop) + self._system_maintenance_loop = self._system_maintenance.start(self._CONFIG['GLOBAL']['PING_TIME']) + self._system_maintenance_loop.addErrback(self.loopingErrHandle) + + # Aliased in __init__ to maintenance_loop if system is a master + def master_maintenance_loop(self): + logger.debug('(%s) Master maintenance loop started', self._system) + remove_list = [] + for peer in self._peers: + _this_peer = self._peers[peer] + # Check to see if any of the peers have been quiet (no ping) longer than allowed + if _this_peer['LAST_PING']+(self._CONFIG['GLOBAL']['PING_TIME']*self._CONFIG['GLOBAL']['MAX_MISSED']) < time(): + remove_list.append(peer) + for peer in remove_list: + logger.info('(%s) Peer %s (%s) has timed out and is being removed', self._system, self._peers[peer]['CALLSIGN'], self._peers[peer]['RADIO_ID']) + # Remove any timed out peers from the configuration + del self._CONFIG['SYSTEMS'][self._system]['PEERS'][peer] + if 'PEERS' not in self._CONFIG['SYSTEMS'][self._system] and 'OPTIONS' in self._CONFIG['SYSTEMS'][self._system]: + + if '_default_options' in self._CONFIG['SYSTEMS'][self._system]: + logger.info('(%s) Setting default Options: %s',self._system, self._CONFIG['SYSTEMS'][self._system]['_default_options']) + self._CONFIG['SYSTEMS'][self._system]['OPTIONS'] = self._CONFIG['SYSTEMS'][self._system]['_default_options'] + else: + del self._CONFIG['SYSTEMS'][self._system]['OPTIONS'] + logger.info('(%s) Deleting HBP Options',self._system) + + # Aliased in __init__ to maintenance_loop if system is a peer + def peer_maintenance_loop(self): + logger.debug('(%s) Peer maintenance loop started', self._system) + if self._stats['PING_OUTSTANDING']: + self._stats['NUM_OUTSTANDING'] += 1 + # If we're not connected, zero out the stats and send a login request RPTL + if self._stats['CONNECTION'] != 'YES' or self._stats['NUM_OUTSTANDING'] >= self._CONFIG['GLOBAL']['MAX_MISSED']: + self._stats['PINGS_SENT'] = 0 + self._stats['PINGS_ACKD'] = 0 + self._stats['NUM_OUTSTANDING'] = 0 + self._stats['PING_OUTSTANDING'] = False + self._stats['CONNECTION'] = 'RPTL_SENT' + if self._stats['DNS_TIME'] < (time() - 600): + self._stats['DNS_TIME'] = time() + _d = reactor.resolve(self._config['_MASTER_IP']) + _d.addCallback(self.updateSockaddr) + _d.addErrback(self.updateSockaddr_errback) + self.send_master(b''.join([RPTL, self._config['RADIO_ID']])) + logger.info('(%s) Sending login request to master %s:%s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT']) + # If we are connected, sent a ping to the master and increment the counter + if self._stats['CONNECTION'] == 'YES': + self.send_master(b''.join([RPTPING, self._config['RADIO_ID']])) + logger.debug('(%s) RPTPING Sent to Master. Total Sent: %s, Total Missed: %s, Currently Outstanding: %s', self._system, self._stats['PINGS_SENT'], self._stats['PINGS_SENT'] - self._stats['PINGS_ACKD'], self._stats['NUM_OUTSTANDING']) + self._stats['PINGS_SENT'] += 1 + self._stats['PING_OUTSTANDING'] = True + + def updateSockaddr(self,ip): + self._config['MASTER_IP'] = ip + self._config['MASTER_SOCKADDR'] = (ip, self._config['MASTER_PORT']) + logger.debug('(%s) hostname resolution performed: %s',self._system,ip) + + def updateSockaddr_errback(self,failure): + logger.debug('(%s) hostname resolution error: %s',self._system,failure) + + def send_peers(self, _packet): + for _peer in self._peers: + self.send_peer(_peer, _packet) + #logger.debug('(%s) Packet sent to peer %s', self._system, self._peers[_peer]['RADIO_ID']) + + def send_peer(self, _peer, _packet): + if _packet[:4] == DMRD: + _packet = b''.join([_packet[:11], _peer, _packet[15:]]) + self.transport.write(_packet, self._peers[_peer]['SOCKADDR']) + # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!! + #logger.debug('(%s) TX Packet to %s on port %s: %s', self._peers[_peer]['RADIO_ID'], self._peers[_peer]['IP'], self._peers[_peer]['PORT'], ahex(_packet)) + + def send_master(self, _packet): + if _packet[:4] == DMRD: + _packet = b''.join([_packet[:11], self._config['RADIO_ID'], _packet[15:]]) + self.transport.write(_packet, self._config['MASTER_SOCKADDR']) + # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!! + #logger.debug('(%s) TX Packet to %s:%s -- %s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'], ahex(_packet)) + + def send_xlxmaster(self, radio, xlx, mastersock): + radio3 = int.from_bytes(radio, 'big').to_bytes(3, 'big') + radio4 = int.from_bytes(radio, 'big').to_bytes(4, 'big') + xlx3 = xlx.to_bytes(3, 'big') + streamid = randint(0,255).to_bytes(1, 'big')+randint(0,255).to_bytes(1, 'big')+randint(0,255).to_bytes(1, 'big')+randint(0,255).to_bytes(1, 'big') + # Wait for .5 secs for the XLX to log us in + for packetnr in range(5): + if packetnr < 3: + # First 3 packets, voice start, stream type e1 + strmtype = 225 + payload = bytearray.fromhex('4f2e00b501ae3a001c40a0c1cc7dff57d75df5d5065026f82880bd616f13f185890000') + else: + # Last 2 packets, voice end, stream type e2 + strmtype = 226 + payload = bytearray.fromhex('4f410061011e3a781c30a061ccbdff57d75df5d2534425c02fe0b1216713e885ba0000') + packetnr1 = packetnr.to_bytes(1, 'big') + strmtype1 = strmtype.to_bytes(1, 'big') + _packet = b''.join([DMRD, packetnr1, radio3, xlx3, radio4, strmtype1, streamid, payload]) + self.transport.write(_packet, mastersock) + # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!! + #logger.debug('(%s) XLX Module Change Packet: %s', self._system, ahex(_packet)) + return + + def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data): + pass + + def master_dereg(self): + for _peer in self._peers: + self.send_peer(_peer, MSTCL + _peer) + logger.info('(%s) De-Registration sent to Peer: %s (%s)', self._system, self._peers[_peer]['CALLSIGN'], self._peers[_peer]['RADIO_ID']) + + def peer_dereg(self): + self.send_master(RPTCL + self._config['RADIO_ID']) + logger.info('(%s) De-Registration sent to Master: %s:%s', self._system, self._config['MASTER_SOCKADDR'][0], self._config['MASTER_SOCKADDR'][1]) + + # Aliased in __init__ to datagramReceived if system is a master + def master_datagramReceived(self, _data, _sockaddr): + # Keep This Line Commented Unless HEAVILY Debugging! + # logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_data)) + + # Extract the command, which is various length, all but one 4 significant characters -- RPTCL + _command = _data[:4] + + if _command == DMRD: # DMRData -- encapsulated DMR data frame + _peer_id = _data[11:15] + if _peer_id in self._peers \ + and self._peers[_peer_id]['CONNECTION'] == 'YES' \ + and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + _seq = _data[4] + _rf_src = _data[5:8] + _dst_id = _data[8:11] + _bits = _data[15] + _slot = 2 if (_bits & 0x80) else 1 + #_call_type = 'unit' if (_bits & 0x40) else 'group' + if _bits & 0x40: + _call_type = 'unit' + elif (_bits & 0x23) == 0x23: + _call_type = 'vcsbk' + else: + _call_type = 'group' + _frame_type = (_bits & 0x30) >> 4 + _dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F + _stream_id = _data[16:20] + if not int_id(_stream_id): + logger.warning('(%s) CALL DROPPED AS STREAM ID IS NULL FROM SUBSCRIBER %s', self._system, int_id(_rf_src)) + return + #logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, _seq, int_id(_rf_src), int_id(_dst_id)) + # ACL Processing + if self._CONFIG['GLOBAL']['USE_ACL']: + if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self._laststrid[_slot] = _stream_id + return + if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if _slot == 2 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG2_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if self._config['USE_ACL']: + if not acl_check(_rf_src, self._config['SUB_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self._laststrid[_slot] = _stream_id + return + if _slot == 1 and not acl_check(_dst_id, self._config['TG1_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if _slot == 2 and not acl_check(_dst_id, self._config['TG2_ACL']): + if self._laststrid[_slot]!= _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + + # The basic purpose of a master is to repeat to the peers + if self._config['REPEAT'] == True: + pkt = [_data[:11], '', _data[15:]] + for _peer in self._peers: + if _peer != _peer_id: + pkt[1] = _peer + self.transport.write(b''.join(pkt), self._peers[_peer]['SOCKADDR']) + #logger.debug('(%s) Packet on TS%s from %s (%s) for destination ID %s repeated to peer: %s (%s) [Stream ID: %s]', self._system, _slot, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id), int_id(_dst_id), self._peers[_peer]['CALLSIGN'], int_id(_peer), int_id(_stream_id)) + + + # Userland actions -- typically this is the function you subclass for an application + self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data) + + elif _command == RPTL: # RPTLogin -- a repeater wants to login + _peer_id = _data[4:8] + # Check to see if we've reached the maximum number of allowed peers + if len(self._peers) < self._config['MAX_PEERS'] or _peer_id in self._peers: + # Check for valid Radio ID + if acl_check(_peer_id, self._CONFIG['GLOBAL']['REG_ACL']) and acl_check(_peer_id, self._config['REG_ACL']): + # Build the configuration data strcuture for the peer + self._peers.update({_peer_id: { + 'CONNECTION': 'RPTL-RECEIVED', + 'CONNECTED': time(), + 'PINGS_RECEIVED': 0, + 'LAST_PING': time(), + 'SOCKADDR': _sockaddr, + 'IP': _sockaddr[0], + 'PORT': _sockaddr[1], + 'SALT': randint(0,0xFFFFFFFF), + 'RADIO_ID': str(int(ahex(_peer_id), 16)), + 'CALLSIGN': '', + 'RX_FREQ': '', + 'TX_FREQ': '', + 'TX_POWER': '', + 'COLORCODE': '', + 'LATITUDE': '', + 'LONGITUDE': '', + 'HEIGHT': '', + 'LOCATION': '', + 'DESCRIPTION': '', + 'SLOTS': '', + 'URL': '', + 'SOFTWARE_ID': '', + 'PACKAGE_ID': '', + }}) + if _peer_id == b'\xff\xff\xff\xff': + logger.info('(%s) Server Status Probe Logging in with Radio ID: %s, %s:%s', self._system, int_id(_peer_id), _sockaddr[0], _sockaddr[1]) + else: + logger.info('(%s) Repeater Logging in with Radio ID: %s, %s:%s', self._system, int_id(_peer_id), _sockaddr[0], _sockaddr[1]) + _salt_str = bytes_4(self._peers[_peer_id]['SALT']) + self.send_peer(_peer_id, b''.join([RPTACK, _salt_str])) + self._peers[_peer_id]['CONNECTION'] = 'CHALLENGE_SENT' + logger.info('(%s) Sent Challenge Response to %s for login: %s', self._system, int_id(_peer_id), self._peers[_peer_id]['SALT']) + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Invalid Login from %s Radio ID: %s Denied by Registation ACL', self._system, _sockaddr[0], int_id(_peer_id)) + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Registration denied from Radio ID: %s Maximum number of peers exceeded', self._system, int_id(_peer_id)) + + elif _command == RPTK: # Repeater has answered our login challenge + _peer_id = _data[4:8] + if _peer_id in self._peers \ + and self._peers[_peer_id]['CONNECTION'] == 'CHALLENGE_SENT' \ + and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + _this_peer = self._peers[_peer_id] + _this_peer['LAST_PING'] = time() + _sent_hash = _data[8:] + _salt_str = bytes_4(_this_peer['SALT']) + if self._CONFIG['GLOBAL']['ALLOW_NULL_PASSPHRASE'] and len(self._config['PASSPHRASE']) == 0: + _this_peer['CONNECTION'] = 'WAITING_CONFIG' + self.send_peer(_peer_id, b''.join([RPTACK, _peer_id])) + logger.info('(%s) Peer %s has completed the login exchange successfully', self._system, _this_peer['RADIO_ID']) + else: + _calc_hash = bhex(sha256(_salt_str+self._config['PASSPHRASE']).hexdigest()) + if _sent_hash == _calc_hash: + _this_peer['CONNECTION'] = 'WAITING_CONFIG' + self.send_peer(_peer_id, b''.join([RPTACK, _peer_id])) + logger.info('(%s) Peer %s has completed the login exchange successfully', self._system, _this_peer['RADIO_ID']) + else: + logger.info('(%s) Peer %s has FAILED the login exchange successfully', self._system, _this_peer['RADIO_ID']) + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + del self._peers[_peer_id] + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Login challenge from Radio ID that has not logged in: %s', self._system, int_id(_peer_id)) + + elif _command == RPTC: # Repeater is sending it's configuraiton OR disconnecting + if _data[:5] == RPTCL: # Disconnect command + _peer_id = _data[5:9] + if _peer_id in self._peers \ + and self._peers[_peer_id]['CONNECTION'] == 'YES' \ + and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + logger.info('(%s) Peer is closing down: %s (%s)', self._system, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id)) + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + del self._peers[_peer_id] + if 'OPTIONS' in self._CONFIG['SYSTEMS'][self._system]: + if '_default_options' in self._CONFIG['SYSTEMS'][self._system]: + self._CONFIG['SYSTEMS'][self._system]['OPTIONS'] = self._CONFIG['SYSTEMS'][self._system]['_default_options'] + logger.info('(%s) Setting default Options: %s',self._system, self._CONFIG['SYSTEMS'][self._system]['_default_options']) + else: + logger.info('(%s) Deleting HBP Options',self._system) + del self._CONFIG['SYSTEMS'][self._system]['OPTIONS'] + + else: + _peer_id = _data[4:8] # Configure Command + if _peer_id in self._peers \ + and self._peers[_peer_id]['CONNECTION'] == 'WAITING_CONFIG' \ + and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + _this_peer = self._peers[_peer_id] + _this_peer['CONNECTION'] = 'YES' + _this_peer['CONNECTED'] = time() + _this_peer['LAST_PING'] = time() + _this_peer['CALLSIGN'] = _data[8:16] + _this_peer['RX_FREQ'] = _data[16:25] + _this_peer['TX_FREQ'] = _data[25:34] + _this_peer['TX_POWER'] = _data[34:36] + _this_peer['COLORCODE'] = _data[36:38] + _this_peer['LATITUDE'] = _data[38:46] + _this_peer['LONGITUDE'] = _data[46:55] + _this_peer['HEIGHT'] = _data[55:58] + _this_peer['LOCATION'] = _data[58:78] + _this_peer['DESCRIPTION'] = _data[78:97] + _this_peer['SLOTS'] = _data[97:98] + _this_peer['URL'] = _data[98:222] + _this_peer['SOFTWARE_ID'] = _data[222:262] + _this_peer['PACKAGE_ID'] = _data[262:302] + + self.send_peer(_peer_id, b''.join([RPTACK, _peer_id])) + logger.info('(%s) Peer %s (%s) has sent repeater configuration, Package ID: %s, Software ID: %s, Desc: %s', self._system, _this_peer['CALLSIGN'], _this_peer['RADIO_ID'],self._peers[_peer_id]['PACKAGE_ID'].decode().rstrip(),self._peers[_peer_id]['SOFTWARE_ID'].decode().rstrip(),self._peers[_peer_id]['DESCRIPTION'].decode().rstrip()) + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Peer info from Radio ID that has not logged in: %s', self._system, int_id(_peer_id)) + + elif _command == RPTO: + _peer_id = _data[4:8] + if _peer_id in self._peers and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + _this_peer = self._peers[_peer_id] + _this_peer['OPTIONS'] = _data[8:] + self.send_peer(_peer_id, b''.join([RPTACK, _peer_id])) + logger.info('(%s) Peer %s has sent options %s', self._system, _this_peer['CALLSIGN'], _this_peer['OPTIONS']) + self._CONFIG['SYSTEMS'][self._system]['OPTIONS'] = _this_peer['OPTIONS'].decode() + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Options from Radio ID that is not logged: %s', self._system, int_id(_peer_id)) + + + elif _command == RPTP: # RPTPing -- peer is pinging us + _peer_id = _data[7:11] + if _peer_id in self._peers \ + and self._peers[_peer_id]['CONNECTION'] == "YES" \ + and self._peers[_peer_id]['SOCKADDR'] == _sockaddr: + self._peers[_peer_id]['PINGS_RECEIVED'] += 1 + self._peers[_peer_id]['LAST_PING'] = time() + self.send_peer(_peer_id, b''.join([MSTPONG, _peer_id])) + #logger.debug('(%s) Received and answered RPTPING from peer %s (%s)', self._system, self._peers[_peer_id]['CALLSIGN'], int_id(_peer_id)) + else: + self.transport.write(b''.join([MSTNAK, _peer_id]), _sockaddr) + logger.warning('(%s) Ping from Radio ID that is not logged in: %s', self._system, int_id(_peer_id)) + + elif _command == DMRA: + _peer_id = _data[4:8] + logger.info('(%s) Peer has sent Talker Alias packet %s', self._system, _data) + + else: + logger.error('(%s) Unrecognized command. Raw HBP PDU: %s', self._system, _data) + + # Aliased in __init__ to datagramReceived if system is a peer + def peer_datagramReceived(self, _data, _sockaddr): + # Keep This Line Commented Unless HEAVILY Debugging! + # logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_data)) + + # Validate that we receveived this packet from the master - security check! + if self._config['MASTER_SOCKADDR'] == _sockaddr: + # Extract the command, which is various length, but only 4 significant characters + _command = _data[:4] + if _command == DMRD: # DMRData -- encapsulated DMR data frame + + _peer_id = _data[11:15] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + #_seq = _data[4:5] + _seq = _data[4] + _rf_src = _data[5:8] + _dst_id = _data[8:11] + _bits = _data[15] + _slot = 2 if (_bits & 0x80) else 1 + #_call_type = 'unit' if (_bits & 0x40) else 'group' + if _bits & 0x40: + _call_type = 'unit' + elif (_bits & 0x23) == 0x23: + _call_type = 'vcsbk' + else: + _call_type = 'group' + _frame_type = (_bits & 0x30) >> 4 + _dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F + _stream_id = _data[16:20] + if not int_id(_stream_id): + logger.warning('(%s) CALL DROPPED AS STREAM ID IS NULL FROM SUBSCRIBER %s', self._system, int_id(_rf_src)) + return + #logger.debug('(%s) DMRD - Sequence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id)) + + # ACL Processing + if self._CONFIG['GLOBAL']['USE_ACL']: + if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY GLOBAL ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self._laststrid[_slot] = _stream_id + return + if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if _slot == 2 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG2_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if self._config['USE_ACL']: + if not acl_check(_rf_src, self._config['SUB_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self._laststrid[_slot] = _stream_id + return + if _slot == 1 and not acl_check(_dst_id, self._config['TG1_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + if _slot == 2 and not acl_check(_dst_id, self._config['TG2_ACL']): + if self._laststrid[_slot] != _stream_id: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM TS2 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self._laststrid[_slot] = _stream_id + return + + + # Userland actions -- typically this is the function you subclass for an application + self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data) + + elif _command == MSTN: # Actually MSTNAK -- a NACK from the master + _peer_id = _data[6:10] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + logger.warning('(%s) MSTNAK Received. Resetting connection to the Master.', self._system) + self._stats['CONNECTION'] = 'NO' # Disconnect ourselves and re-register + self._stats['CONNECTED'] = time() + + elif _command == RPTA: # Actually RPTACK -- an ACK from the master + # Depending on the state, an RPTACK means different things, in each clause, we check and/or set the state + if self._stats['CONNECTION'] == 'RPTL_SENT': # If we've sent a login request... + _login_int32 = _data[6:10] + logger.info('(%s) Repeater Login ACK Received with 32bit ID: %s', self._system, int_id(_login_int32)) + _pass_hash = sha256(b''.join([_login_int32, self._config['PASSPHRASE']])).hexdigest() + _pass_hash = bhex(_pass_hash) + self.send_master(b''.join([RPTK, self._config['RADIO_ID'], _pass_hash])) + self._stats['CONNECTION'] = 'AUTHENTICATED' + + elif self._stats['CONNECTION'] == 'AUTHENTICATED': # If we've sent the login challenge... + _peer_id = _data[6:10] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + logger.info('(%s) Repeater Authentication Accepted', self._system) + _config_packet = b''.join([\ + self._config['RADIO_ID'],\ + self._config['CALLSIGN'],\ + self._config['RX_FREQ'],\ + self._config['TX_FREQ'],\ + self._config['TX_POWER'],\ + self._config['COLORCODE'],\ + self._config['LATITUDE'],\ + self._config['LONGITUDE'],\ + self._config['HEIGHT'],\ + self._config['LOCATION'],\ + self._config['DESCRIPTION'],\ + self._config['SLOTS'],\ + self._config['URL'],\ + self._config['SOFTWARE_ID'],\ + self._config['PACKAGE_ID']\ + ]) + + self.send_master(b''.join([RPTC, _config_packet])) + self._stats['CONNECTION'] = 'CONFIG-SENT' + logger.info('(%s) Repeater Configuration Sent', self._system) + else: + self._stats['CONNECTION'] = 'NO' + logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system) + + elif self._stats['CONNECTION'] == 'CONFIG-SENT': # If we've sent out configuration to the master + _peer_id = _data[6:10] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + logger.info('(%s) Repeater Configuration Accepted', self._system) + if self._config['OPTIONS']: + self.send_master(b''.join([RPTO, self._config['RADIO_ID'], self._config['OPTIONS']])) + self._stats['CONNECTION'] = 'OPTIONS-SENT' + logger.info('(%s) Sent options: (%s)', self._system, self._config['OPTIONS']) + else: + self._stats['CONNECTION'] = 'YES' + self._stats['CONNECTED'] = time() + logger.info('(%s) Connection to Master Completed', self._system) + # If we are an XLX, send the XLX module request here. + if self._config['MODE'] == 'XLXPEER': + self.send_xlxmaster(self._config['RADIO_ID'], int(4000), self._config['MASTER_SOCKADDR']) + self.send_xlxmaster(self._config['RADIO_ID'], self._config['XLXMODULE'], self._config['MASTER_SOCKADDR']) + logger.info('(%s) Sending XLX Module request', self._system) + else: + self._stats['CONNECTION'] = 'NO' + logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system) + + elif self._stats['CONNECTION'] == 'OPTIONS-SENT': # If we've sent out options to the master + _peer_id = _data[6:10] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + logger.info('(%s) Repeater Options Accepted', self._system) + self._stats['CONNECTION'] = 'YES' + self._stats['CONNECTED'] = time() + logger.info('(%s) Connection to Master Completed with options', self._system) + else: + self._stats['CONNECTION'] = 'NO' + logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system) + + elif _command == MSTP: # Actually MSTPONG -- a reply to RPTPING (send by peer) + _peer_id = _data[7:11] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + self._stats['PING_OUTSTANDING'] = False + self._stats['NUM_OUTSTANDING'] = 0 + self._stats['PINGS_ACKD'] += 1 + #logger.debug('(%s) MSTPONG Received. Pongs Since Connected: %s', self._system, self._stats['PINGS_ACKD']) + + elif _command == MSTC: # Actually MSTCL -- notify us the master is closing down + _peer_id = _data[5:9] + if self._config['LOOSE'] or _peer_id == self._config['RADIO_ID']: # Validate the Radio_ID unless using loose validation + self._stats['CONNECTION'] = 'NO' + logger.info('(%s) MSTCL Recieved', self._system) + + else: + logger.error('(%s) Received an invalid command in packet: %s', self._system, ahex(_data)) + + + + + + + diff --git a/FreeDMR/Protocol/OpenBridge.py b/FreeDMR/Protocol/OpenBridge.py new file mode 100644 index 0000000..4699db4 --- /dev/null +++ b/FreeDMR/Protocol/OpenBridge.py @@ -0,0 +1,254 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +''' +This program does very little on its own. It is intended to be used as a module +to build applications on top of the HomeBrew Repeater Protocol. By itself, it +will only act as a peer or master for the systems specified in its configuration +file (usually freedmr.cfg). It is ALWAYS best practice to ensure that this program +works stand-alone before troubleshooting any applications that use it. It has +sufficient logging to be used standalone as a troubleshooting application. +''' + +# Specifig functions from modules we need +from binascii import b2a_hex as ahex +from binascii import a2b_hex as bhex +from random import randint +from hashlib import sha256, sha1 +from hmac import new as hmac_new, compare_digest +from time import time +from collections import deque + +# Twisted is pretty important, so I keep it separate +from twisted.internet.protocol import DatagramProtocol, Factory, Protocol +from twisted.protocols.basic import NetstringReceiver +from twisted.internet import reactor, task + +# Other files we pull from -- this is mostly for readability and segmentation +import log +import config +from FreeDMR.Const.const import * +from dmr_utils3.utils import int_id, bytes_4, try_download, mk_id_dict + +# Imports for the reporting server +import pickle +from FreeDMR.Const.reporting_const import * + + +# The module needs logging logging, but handlers, etc. are controlled by the parent +import logging +logger = logging.getLogger(__name__) + +# Does anybody read this stuff? There's a PEP somewhere that says I should do this. +__author__ = 'Cortney T. Buffington, N0MJS, Forked by Simon Adlem - G7RZU' +__copyright__ = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group, Simon Adlem, G7RZU 2020,2021' +__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT; Jon Lee, G4TSN; Norman Williams, M6NBP' +__license__ = 'GNU GPLv3' +__maintainer__ = 'Simon Adlem G7RZU' +__email__ = 'simon@gb7fr.org.uk' + +#************************************************ +# OPENBRIDGE CLASS +#************************************************ + +class OPENBRIDGE(DatagramProtocol): + def __init__(self, _name, _config, _report): + # Define a few shortcuts to make the rest of the class more readable + self._CONFIG = _config + self._system = _name + self._report = _report + self._config = self._CONFIG['SYSTEMS'][self._system] + self._laststrid = deque([], 20) + + + def loopingErrHandle(self,failure): + logger.error('(GLOBAL - freedmr.py) Unhandled error in timed loop.\n %s', failure) + + + def startProtocol(self): + logger.info('(%s) Starting OBP. TARGET_IP: %s, TARGET_PORT: %s',self._system, self._config['TARGET_IP'], self._config['TARGET_PORT']) + if self._config['ENHANCED_OBP']: + logger.debug('(%s) *BridgeControl* starting KeepAlive timer',self._system) + self._bcka_task = task.LoopingCall(self.send_bcka) + self._bcka = self._bcka_task.start(10) + self._bcka.addErrback(self.loopingErrHandle) + + def dereg(self): + logger.info('(%s) is mode OPENBRIDGE. No De-Registration required, continuing shutdown', self._system) + + def send_system(self, _packet): + if _packet[:4] == DMRD and self._config['TARGET_IP']: + #_packet = _packet[:11] + self._config['NETWORK_ID'] + _packet[15:] + _packet = b''.join([_packet[:11], self._CONFIG['GLOBAL']['SERVER_ID'], _packet[15:]]) + #_packet += hmac_new(self._config['PASSPHRASE'],_packet,sha1).digest() + _packet = b''.join([_packet, (hmac_new(self._config['PASSPHRASE'],_packet,sha1).digest())]) + self.transport.write(_packet, (self._config['TARGET_IP'], self._config['TARGET_PORT'])) + # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!! + #logger.debug('(%s) TX Packet to OpenBridge %s:%s -- %s', self._system, self._config['TARGET_IP'], self._config['TARGET_PORT'], ahex(_packet)) + else: + + if not self._config['TARGET_IP']: + logger.debug('(%s) Not sent packet as TARGET_IP not currently known') + else: + logger.error('(%s) OpenBridge system was asked to send non DMRD packet with send_system(): %s', self._system, _packet) + + def send_bcka(self): + if self._config['TARGET_IP']: + _packet = BCKA + _packet = b''.join([_packet[:4], (hmac_new(self._config['PASSPHRASE'],_packet,sha1).digest())]) + self.transport.write(_packet, (self._config['TARGET_IP'], self._config['TARGET_PORT'])) + logger.debug('(%s) *BridgeControl* sent KeepAlive',self._system) + else: + logger.debug('(%s) *BridgeControl* not sending KeepAlive, TARGET_IP currently not known',self._system) + + + def send_bcsq(self,_tgid,_stream_id): + if self._config['TARGET_IP']: + _packet = b''.join([BCSQ, _tgid, _stream_id]) + _packet = b''.join([_packet, (hmac_new(self._config['PASSPHRASE'],_packet,sha1).digest())]) + self.transport.write(_packet, (self._config['TARGET_IP'], self._config['TARGET_PORT'])) + logger.debug('(%s) *BridgeControl* sent BCSQ Source Quench, TG: %s, Stream ID: %s',self._system,int_id(_tgid), int_id(_stream_id)) + else: + logger.debug('(%s) *BridgeControl* Not sent BCSQ Source Quench TARGET_IP not known , TG: %s, Stream ID: %s',self._system,int_id(_tgid)) + + + def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data): + pass + #print(int_id(_peer_id), int_id(_rf_src), int_id(_dst_id), int_id(_seq), _slot, _call_type, _frame_type, repr(_dtype_vseq), int_id(_stream_id)) + + def datagramReceived(self, _packet, _sockaddr): + # Keep This Line Commented Unless HEAVILY Debugging! + #logger.debug('(%s) RX packet from %s -- %s', self._system, _sockaddr, ahex(_packet)) + + if _packet[:4] == DMRD: # DMRData -- encapsulated DMR data frame + _data = _packet[:53] + _hash = _packet[53:] + _ckhs = hmac_new(self._config['PASSPHRASE'],_data,sha1).digest() + + if compare_digest(_hash, _ckhs) and (_sockaddr == self._config['TARGET_SOCK'] or self._config['RELAX_CHECKS']): + _peer_id = _data[11:15] + if self._config['NETWORK_ID'] != _peer_id: + logger.error('(%s) OpenBridge packet discarded because NETWORK_ID: %s Does not match sent Peer ID: %s', self._system, int_id(self._config['NETWORK_ID']), int_id(_peer_id)) + return + _seq = _data[4] + _rf_src = _data[5:8] + _dst_id = _data[8:11] + _bits = _data[15] + _slot = 2 if (_bits & 0x80) else 1 + #_call_type = 'unit' if (_bits & 0x40) else 'group' + if _bits & 0x40: + _call_type = 'unit' + elif (_bits & 0x23) == 0x23: + _call_type = 'vcsbk' + else: + _call_type = 'group' + _frame_type = (_bits & 0x30) >> 4 + _dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F + _stream_id = _data[16:20] + #logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id)) + + # Sanity check for OpenBridge -- all calls must be on Slot 1 + if _slot != 1: + logger.error('(%s) OpenBridge packet discarded because it was not received on slot 1. SID: %s, TGID %s', self._system, int_id(_rf_src), int_id(_dst_id)) + return + + #Low-level TG filtering + if _call_type != 'unit': + _int_dst_id = int_id(_dst_id) + if _int_dst_id <= 79 or (_int_dst_id >= 9990 and _int_dst_id <= 9999) or _int_dst_id == 900999: + if _stream_id not in self._laststrid: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TG FILTER', self._system, int_id(_stream_id), _int_dst_id) + self.send_bcsq(_dst_id,_stream_id) + self._laststrid.append(_stream_id) + return + + # ACL Processing + if self._CONFIG['GLOBAL']['USE_ACL']: + if not acl_check(_rf_src, self._CONFIG['GLOBAL']['SUB_ACL']): + if _stream_id not in self._laststrid: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self.send_bcsq(_dst_id,_stream_id) + self._laststrid.append(_stream_id) + return + if _slot == 1 and not acl_check(_dst_id, self._CONFIG['GLOBAL']['TG1_ACL']): + if _stream_id not in self._laststrid: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY GLOBAL TS1 ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self.send_bcsq(_dst_id,_stream_id) + self._laststrid.append(_stream_id) + return + if self._config['USE_ACL']: + if not acl_check(_rf_src, self._config['SUB_ACL']): + if _stream_id not in self._laststrid: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s FROM SUBSCRIBER %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_rf_src)) + self.send_bcsq(_dst_id,_stream_id) + self._laststrid.append(_stream_id) + return + if not acl_check(_dst_id, self._config['TG1_ACL']): + if _stream_id not in self._laststrid: + logger.info('(%s) CALL DROPPED WITH STREAM ID %s ON TGID %s BY SYSTEM ACL', self._system, int_id(_stream_id), int_id(_dst_id)) + self.send_bcsq(_dst_id,_stream_id) + self._laststrid.append(_stream_id) + return + + # Userland actions -- typically this is the function you subclass for an application + self.dmrd_received(_peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data) + #Silently treat a DMRD packet like a keepalive - this is because it's traffic and the + #Other end may not have enabled ENAHNCED_OBP + self._config['_bcka'] = time() + else: + h,p = _sockaddr + logger.info('(%s) OpenBridge HMAC failed, packet discarded - OPCODE: %s DATA: %s HMAC LENGTH: %s HMAC: %s SRC IP: %s SRC PORT: %s', self._system, _packet[:4], repr(_packet[:53]), len(_packet[53:]), repr(_packet[53:]),h,p) + + if self._config['ENHANCED_OBP']: + if _packet[:2] == BC: # Bridge Control packet (Extended OBP) + #Keep Alive + if _packet[:4] == BCKA: + #_data = _packet[:53] + _hash = _packet[4:] + _ckhs = hmac_new(self._config['PASSPHRASE'],_packet[:4],sha1).digest() + if compare_digest(_hash, _ckhs): + logger.debug('(%s) *BridgeControl* Keep Alive received',self._system) + self._config['_bcka'] = time() + if _sockaddr != self._config['TARGET_SOCK']: + h,p = _sockaddr + logger.warning('(%s) *BridgeControl* Source IP and Port has changed for OBP from %s:%s to %s:%s, updating',self._system,self._config['TARGET_IP'],self._config['TARGET_PORT'],h,p) + self._config['TARGET_IP'] = h + self._config['TARGET_PORT'] = p + self._config['TARGET_SOCK'] = (h,p) + + else: + h,p = _sockaddr + logger.info('(%s) *BridgeControl* BCKA invalid KeepAlive, packet discarded - OPCODE: %s DATA: %s HMAC LENGTH: %s HMAC: %s SRC IP: %s SRC PORT: %s', self._system, _packet[:4], repr(_packet[:53]), len(_packet[53:]), repr(_packet[53:]),h,p) + #Source Quench + if _packet[:4] == BCSQ: + #_data = _packet[:11] + _hash = _packet[11:] + _tgid = _packet[4:7] + _stream_id = _packet[7:11] + _ckhs = hmac_new(self._config['PASSPHRASE'],_packet[:11],sha1).digest() + if compare_digest(_hash, _ckhs): + logger.debug('(%s) *BridgeControl* BCSQ Source Quench request received for TGID: %s, Stream ID: %s',self._system,int_id(_tgid), int_id(_stream_id)) + if '_bcsq' not in self._config: + self._config['_bcsq'] = {} + self._config['_bcsq'][_tgid] = _stream_id + else: + h,p = _sockaddr + logger.warning('(%s) *BridgeControl* BCSQ invalid Source Quench, packet discarded - OPCODE: %s DATA: %s HMAC LENGTH: %s HMAC: %s SRC IP: %s SRC PORT: %s', self._system, _packet[:4], repr(_packet[:53]), len(_packet[53:]), repr(_packet[53:]),h,p) + diff --git a/FreeDMR/Utilities/.report.py.kate-swp b/FreeDMR/Utilities/.report.py.kate-swp new file mode 100644 index 0000000000000000000000000000000000000000..4188a449f5da0246576eb56e8b7c8ca9ed4ef622 GIT binary patch literal 89 zcmZQzU=Z?7EJ;-eE>A2_aLdd|RWQ;sU|?VndCswX#s8P?j-6_EgBxEjt=Ts>Y-_M5 nNCt>OKqfP{Ait +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### +from bitarray import bitarray +from itertools import islice +import os +import glob + +class readAMBE: + + def __init__(self, lang,path): + self.langcsv = lang + self.langs = lang.split(',') + self.path = path + + def _make_bursts(self,data): + it = iter(data) + for i in range(0, len(data), 108): + yield bitarray([k for k in islice(it, 108)] ) + + #Read indexed files + def readfiles(self): + + _AMBE_LENGTH = 9 + + _wordBADictofDicts = {} + + for _lang in self.langs: + + _prefix = self.path+_lang + _wordBADict = {} + + indexDict = {} + + if os.path.isdir(_prefix): + ambeBytearray = {} + _wordBitarray = bitarray(endian='big') + _wordBADict = {} + _glob = _prefix + "/*.ambe" + for ambe in glob.glob(_glob): + basename = os.path.basename(ambe) + _voice,ext = basename.split('.') + inambe = open(ambe,'rb') + _wordBitarray.frombytes(inambe.read()) + inambe.close() + _wordBADict[_voice] = [] + pairs = 1 + _lastburst = '' + for _burst in self._make_bursts(_wordBitarray): + #Not sure if we need to pad or not? Seems to make little difference. + if len(_burst) < 108: + pad = (108 - len(_burst)) + for i in range(0,pad,1): + _burst.append(False) + if pairs == 2: + _wordBADict[_voice].append([_lastburst,_burst]) + _lastburst = '' + pairs = 1 + next + else: + pairs = pairs + 1 + _lastburst = _burst + + _wordBitarray.clear() + _wordBADict['silence'] = ([ + [bitarray('101011000000101010100000010000000000001000000000000000000000010001000000010000000000100000000000100000000000'), + bitarray('001010110000001010101000000100000000000010000000000000000000000100010000000100000000001000000000001000000000')] + ]) + _wordBADictofDicts[_lang] = _wordBADict + else: + try: + with open(_prefix+'.indx') as index: + for line in index: + (voice,start,length) = line.split() + indexDict[voice] = [int(start) * _AMBE_LENGTH ,int(length) * _AMBE_LENGTH] + index.close() + except IOError: + return False + + ambeBytearray = {} + _wordBitarray = bitarray(endian='big') + _wordBADict = {} + try: + with open(_prefix+'.ambe','rb') as ambe: + for _voice in indexDict: + ambe.seek(indexDict[_voice][0]) + _wordBitarray.frombytes(ambe.read(indexDict[_voice][1])) + #108 + _wordBADict[_voice] = [] + pairs = 1 + _lastburst = '' + for _burst in self._make_bursts(_wordBitarray): + #Not sure if we need to pad or not? Seems to make little difference. + if len(_burst) < 108: + pad = (108 - len(_burst)) + for i in range(0,pad,1): + _burst.append(False) + if pairs == 2: + _wordBADict[_voice].append([_lastburst,_burst]) + _lastburst = '' + pairs = 1 + next + else: + pairs = pairs + 1 + _lastburst = _burst + + _wordBitarray.clear() + ambe.close() + except IOError: + return False + _wordBADict['silence'] = ([ + [bitarray('101011000000101010100000010000000000001000000000000000000000010001000000010000000000100000000000100000000000'), + bitarray('001010110000001010101000000100000000000010000000000000000000000100010000000100000000001000000000001000000000')] + ]) + _wordBADictofDicts[_lang] = _wordBADict + + return _wordBADictofDicts + + #Read a single ambe file from the audio directory + def readSingleFile(self,filename): + ambeBytearray = {} + _wordBitarray = bitarray(endian='big') + _wordBA= [] + try: + with open(self.path+filename,'rb') as ambe: + _wordBitarray.frombytes(ambe.read()) + #108 + _wordBA = [] + pairs = 1 + _lastburst = '' + for _burst in self._make_bursts(_wordBitarray): +#Not sure if we need to pad or not? Seems to make little difference. + if len(_burst) < 108: + pad = (108 - len(_burst)) + for i in range(0,pad,1): + _burst.append(False) + if pairs == 2: + _wordBA.append([_lastburst,_burst]) + _lastburst = '' + pairs = 1 + next + else: + pairs = pairs + 1 + _lastburst = _burst + + _wordBitarray.clear() + ambe.close() + except IOError: + raise + + return(_wordBA) + + +if __name__ == '__main__': + + #test = readAMBE('en_GB','./Audio/') + + #print(test.readfiles()) + test = readAMBE('en_GB_2','./Audio/') + print(test.readfiles()) + print(test.readSingleFile('44xx.ambe')) diff --git a/FreeDMR/Utilities/report.py b/FreeDMR/Utilities/report.py new file mode 100644 index 0000000..e708a7a --- /dev/null +++ b/FreeDMR/Utilities/report.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + + +from twisted.protocols.basic import NetstringReceiver + +# Socket-based reporting section +# +class report(NetstringReceiver): + def __init__(self, factory): + self._factory = factory + + def connectionMade(self): + self._factory.clients.append(self) + logger.info('(REPORT) freedmr reporting client connected: %s', self.transport.getPeer()) + + def connectionLost(self, reason): + logger.info('(REPORT) freedmr reporting client disconnected: %s', self.transport.getPeer()) + self._factory.clients.remove(self) + + def stringReceived(self, data): + self.process_message(data) + + def process_message(self, _message): + opcode = _message[:1] + if opcode == REPORT_OPCODES['CONFIG_REQ']: + logger.info('(REPORT) freedmr reporting client sent \'CONFIG_REQ\': %s', self.transport.getPeer()) + self.send_config() + else: + logger.error('(REPORT) got unknown opcode') diff --git a/FreeDMR/Utilities/reportFactory.py b/FreeDMR/Utilities/reportFactory.py new file mode 100644 index 0000000..3cb2c05 --- /dev/null +++ b/FreeDMR/Utilities/reportFactory.py @@ -0,0 +1,69 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +''' +This program does very little on its own. It is intended to be used as a module +to build applications on top of the HomeBrew Repeater Protocol. By itself, it +will only act as a peer or master for the systems specified in its configuration +file (usually freedmr.cfg). It is ALWAYS best practice to ensure that this program +works stand-alone before troubleshooting any applications that use it. It has +sufficient logging to be used standalone as a troubleshooting application. +''' +# Twisted is pretty important, so I keep it separate +from twisted.internet.protocol import Factory + +# Imports for the reporting server +import pickle +from FreeDMR.Const.reporting_const import * + + +# The module needs logging logging, but handlers, etc. are controlled by the parent +import logging +logger = logging.getLogger(__name__) + +# Does anybody read this stuff? There's a PEP somewhere that says I should do this. +__author__ = 'Cortney T. Buffington, N0MJS, Forked by Simon Adlem - G7RZU' +__copyright__ = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group, Simon Adlem, G7RZU 2020,2021' +__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT; Jon Lee, G4TSN; Norman Williams, M6NBP' +__license__ = 'GNU GPLv3' +__maintainer__ = 'Simon Adlem G7RZU' +__email__ = 'simon@gb7fr.org.uk' + + +class reportFactory(Factory): + def __init__(self, config): + self._config = config + + def buildProtocol(self, addr): + if (addr.host) in self._config['REPORTS']['REPORT_CLIENTS'] or '*' in self._config['REPORTS']['REPORT_CLIENTS']: + logger.debug('(REPORT) Permitting report server connection attempt from: %s:%s', addr.host, addr.port) + return report(self) + else: + logger.error('(REPORT) Invalid report server connection attempt from: %s:%s', addr.host, addr.port) + return None + + def send_clients(self, _message): + for client in self.clients: + client.sendString(_message) + + def send_config(self): + serialized = pickle.dumps(self._config['SYSTEMS'], protocol=2) #.decode('utf-8', errors='ignore') #pickle.HIGHEST_PROTOCOL) + logger.debug('(REPORT) Send config') + self.send_clients(b''.join([REPORT_OPCODES['CONFIG_SND'], serialized])) diff --git a/FreeDMR/freedmr.py b/FreeDMR/freedmr.py new file mode 100644 index 0000000..919e74a --- /dev/null +++ b/FreeDMR/freedmr.py @@ -0,0 +1,206 @@ +#!/usr/bin/env python +# +############################################################################### +# Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### + +''' +This program does very little on its own. It is intended to be used as a module +to build applications on top of the HomeBrew Repeater Protocol. By itself, it +will only act as a peer or master for the systems specified in its configuration +file (usually freedmr.cfg). It is ALWAYS best practice to ensure that this program +works stand-alone before troubleshooting any applications that use it. It has +sufficient logging to be used standalone as a troubleshooting application. +''' + +# Specifig functions from modules we need +from binascii import b2a_hex as ahex +from binascii import a2b_hex as bhex +from random import randint +from hashlib import sha256, sha1 +from hmac import new as hmac_new, compare_digest +from time import time +from collections import deque + +# Twisted is pretty important, so I keep it separate +from twisted.internet.protocol import DatagramProtocol, Factory, Protocol +from twisted.protocols.basic import NetstringReceiver +from twisted.internet import reactor, task + +# Other files we pull from -- this is mostly for readability and segmentation +import log +import config +from FreeDMR.Const.const import * +from dmr_utils3.utils import int_id, bytes_4, try_download, mk_id_dict + +# Imports for the reporting server +import pickle +from FreeDMR.Const.reporting_const import * + +#Protocols +from FreeDMR.Protocol.OpenBridge import OPENBRIDGE +from FreeDMR.Protocol.HomeBrewProtocol import HBSYSTEM +from FreeDMR.Utilities.report import report +from FreeDMR.Utilities.reportFactory import reportFactory + +# The module needs logging logging, but handlers, etc. are controlled by the parent +import logging +logger = logging.getLogger(__name__) + +# Does anybody read this stuff? There's a PEP somewhere that says I should do this. +__author__ = 'Cortney T. Buffington, N0MJS, Forked by Simon Adlem - G7RZU' +__copyright__ = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group, Simon Adlem, G7RZU 2020,2021' +__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT; Jon Lee, G4TSN; Norman Williams, M6NBP' +__license__ = 'GNU GPLv3' +__maintainer__ = 'Simon Adlem G7RZU' +__email__ = 'simon@gb7fr.org.uk' + + +# Global variables used whether we are a module or __main__ +systems = {} + +# Timed loop used for reporting HBP status +def config_reports(_config, _factory): + def reporting_loop(_logger, _server): + _logger.debug('(GLOBAL) Periodic reporting loop started') + _server.send_config() + + logger.info('(GLOBAL) freedmr TCP reporting server configured') + + report_server = _factory(_config) + report_server.clients = [] + reactor.listenTCP(_config['REPORTS']['REPORT_PORT'], report_server) + + reporting = task.LoopingCall(reporting_loop, logger, report_server) + reporting.start(_config['REPORTS']['REPORT_INTERVAL']) + + return report_server + + +# Shut ourselves down gracefully by disconnecting from the masters and peers. +def freedmr_handler(_signal, _frame): + for system in systems: + logger.info('(GLOBAL) SHUTDOWN: DE-REGISTER SYSTEM: %s', system) + systems[system].dereg() + +# Check a supplied ID against the ACL provided. Returns action (True|False) based +# on matching and the action specified. +def acl_check(_id, _acl): + id = int_id(_id) + for entry in _acl[1]: + if entry[0] <= id <= entry[1]: + return _acl[0] + return not _acl[0] + +# ID ALIAS CREATION +# Download +def mk_aliases(_config): + if _config['ALIASES']['TRY_DOWNLOAD'] == True: + # Try updating peer aliases file + result = try_download(_config['ALIASES']['PATH'], _config['ALIASES']['PEER_FILE'], _config['ALIASES']['PEER_URL'], _config['ALIASES']['STALE_TIME']) + logger.info('(GLOBAL) %s', result) + # Try updating subscriber aliases file + result = try_download(_config['ALIASES']['PATH'], _config['ALIASES']['SUBSCRIBER_FILE'], _config['ALIASES']['SUBSCRIBER_URL'], _config['ALIASES']['STALE_TIME']) + logger.info('(GLOBAL) %s', result) + #Try updating tgid aliases file + result = try_download(_config['ALIASES']['PATH'], _config['ALIASES']['TGID_FILE'], _config['ALIASES']['TGID_URL'], _config['ALIASES']['STALE_TIME']) + logger.info('(GLOBAL) %s', result) + + # Make Dictionaries + peer_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['PEER_FILE']) + if peer_ids: + logger.info('(GLOBAL) ID ALIAS MAPPER: peer_ids dictionary is available') + + subscriber_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['SUBSCRIBER_FILE']) + if subscriber_ids: + logger.info('(GLOBAL) ID ALIAS MAPPER: subscriber_ids dictionary is available') + + talkgroup_ids = mk_id_dict(_config['ALIASES']['PATH'], _config['ALIASES']['TGID_FILE']) + if talkgroup_ids: + logger.info('(GLOBAL) ID ALIAS MAPPER: talkgroup_ids dictionary is available') + + return peer_ids, subscriber_ids, talkgroup_ids + + + + +#************************************************ +# MAIN PROGRAM LOOP STARTS HERE +#************************************************ + +if __name__ == '__main__': + # Python modules we need + import argparse + import sys + import os + import signal + + # Change the current directory to the location of the application + os.chdir(os.path.dirname(os.path.realpath(sys.argv[0]))) + + # CLI argument parser - handles picking up the config file from the command line, and sending a "help" message + parser = argparse.ArgumentParser() + parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually freedmr.cfg)') + parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.') + cli_args = parser.parse_args() + + # Ensure we have a path for the config file, if one wasn't specified, then use the execution directory + if not cli_args.CONFIG_FILE: + cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/freedmr.cfg' + + # Call the external routine to build the configuration dictionary + CONFIG = config.build_config(cli_args.CONFIG_FILE) + + # Call the external routing to start the system logger + if cli_args.LOG_LEVEL: + CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL + logger = log.config_logging(CONFIG['LOGGER']) + logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018, 2019\n\tThe Regents of the K0USY Group. All rights reserved.\n') + logger.debug('(GLOBAL) Logging system started, anything from here on gets logged') + + # Set up the signal handler + def sig_handler(_signal, _frame): + logger.info('(GLOBAL) SHUTDOWN: freedmr IS TERMINATING WITH SIGNAL %s', str(_signal)) + freedmr_handler(_signal, _frame) + logger.info('(GLOBAL) SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR') + reactor.stop() + + # Set signal handers so that we can gracefully exit if need be + for sig in [signal.SIGTERM, signal.SIGINT]: + signal.signal(sig, sig_handler) + + peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG) + + # INITIALIZE THE REPORTING LOOP + if CONFIG['REPORTS']['REPORT']: + report_server = config_reports(CONFIG, reportFactory) + else: + report_server = None + logger.info('(REPORT) TCP Socket reporting not configured') + + # freedmr instance creation + logger.info('(GLOBAL) freedmr \'freedmr.py\' -- SYSTEM STARTING...') + for system in CONFIG['SYSTEMS']: + if CONFIG['SYSTEMS'][system]['ENABLED']: + if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE': + systems[system] = OPENBRIDGE(system, CONFIG, report_server) + else: + systems[system] = HBSYSTEM(system, CONFIG, report_server) + reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP']) + logger.debug('(GLOBAL) %s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system]) + + reactor.run() diff --git a/FreeDMR/i8n/i8n_voice_map.py b/FreeDMR/i8n/i8n_voice_map.py new file mode 100644 index 0000000..401d2c1 --- /dev/null +++ b/FreeDMR/i8n/i8n_voice_map.py @@ -0,0 +1,348 @@ +############################################################################### +# Copyright (C) 2020 Simon Adlem, G7RZU +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software Foundation, +# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +############################################################################### +voiceMap = { + 'en_GB': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + + 'en_GB_2': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + 'cy_GB': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + 'en_US': { + 'to': '2', + 'freedmr': 'silence', + 'this-is': 'silence' + }, + + 'es_ES': { + '1': 'one', + '2': 'two', + '3': 'three', + '4': 'four', + '5': 'five', + '6': 'six', + '7': 'seven', + '8': 'eight', + '9': 'nine', + 'A': 'alfa', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + 'es_ES_2': { + '1': 'one', + '2': 'two', + '3': 'three', + '4': 'four', + '5': 'five', + '6': 'six', + '7': 'seven', + '8': 'eight', + '9': 'nine', + 'A': 'alfa', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + 'fr_FR': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + 'pt_PT': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + 'el_GR': { + 'A': 'alpha', + 'B': 'bravo', + 'C': 'charlie', + 'D': 'delta', + 'E': 'echo', + 'F': 'foxtrot', + 'G': 'golf', + 'H': 'hotel', + 'I': 'india', + 'J': 'juliet', + 'K': 'kilo', + 'L': 'lima', + 'M': 'mike', + 'N': 'november', + 'O': 'oscar', + 'P': 'papa', + 'Q': 'quebec', + 'R': 'romeo', + 'S': 'sierra', + 'T': 'tango', + 'U': 'uniform', + 'V': 'victor', + 'W': 'whiskey', + 'X': 'x-ray', + 'Y': 'yankee', + 'Z': 'zulu', + 'to': 'silence', + 'notlinked': 'not-linked', + 'linkedto': 'linked-to' + }, + + 'de_DE': { + + 'to': 'silence', + }, + + 'dk_DK': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence' + + }, + + 'it_IT': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence' + }, + + 'no_NO': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence' + }, + + 'pl_PL': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence' + }, + + 'se_SE': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence' + }, + + 'CW': { + 'to': 'silence', + 'freedmr': 'silence', + 'this-is': 'silence', + 'linkedto': 'silence' + }, + + 'th_TH': { + + 'to': 'silence', + }, + + +} +