This repository has been archived by the owner on Mar 12, 2023. It is now read-only.
/
fne_parrot.py
283 lines (241 loc) · 12.7 KB
/
fne_parrot.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
#!/usr/bin/env python
#
# Digital Voice Modem - Fixed Network Equipment
# GPLv2 Open Source. Use is subject to license terms.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# @package DVM / FNE
#
###############################################################################
# Copyright (C) 2016 Cortney T. Buffington, N0MJS <n0mjs@me.com>
# Copyright (C) 2017-2021 Bryan Biedenkapp <gatekeep@gmail.com>
#
# 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 __future__ import print_function
import sys
from binascii import b2a_hex as ahex
from bitarray import bitarray
from time import time, sleep
from importlib import import_module
from twisted.python import log
from twisted.internet.protocol import Factory, Protocol
from twisted.protocols.basic import NetstringReceiver
from twisted.internet import reactor, task
from fne.fne_core import short_to_bytes, coreFNE, systems, fne_shutdown_handler, REPORT_OPCODES, reportFactory, config_reports, setup_activity_log
from fne import fne_config, fne_log, fne_const
from dmr_utils import lc, bptc, const
# ---------------------------------------------------------------------------
# Class Declaration
# This implements the parrot network FNE logic.
# ---------------------------------------------------------------------------
class parrotFNE(coreFNE):
def __init__(self, _name, _config, _logger, _act_log_file, _report):
coreFNE.__init__(self, _name, _config, _logger, _act_log_file, _report)
# Status information for the system, TS1 & TS2
# 1 & 2 are "timeslot"
# In TX_EMB_LC, 2-5 are burst B-E
self.STATUS = {
1: {
'RX_START': time(),
'RX_SEQ': 0,
'RX_RFS': 0,
'TX_RFS': 0,
'RX_STREAM_ID': 0,
'TX_STREAM_ID': 0,
'RX_TGID': 0,
'TX_TGID': 0,
'TX_PI_TGID': 0,
'RX_TIME': time(),
'TX_TIME': time(),
'RX_TYPE': fne_const.DT_TERMINATOR_WITH_LC,
'RX_LC': 0,
'RX_PI_LC': 0,
'TX_H_LC': 0,
'TX_P_LC': 0,
'TX_T_LC': 0,
'TX_EMB_LC': {
1: 0,
2: 0,
3: 0,
4: 0,
}
},
2: {
'RX_START': time(),
'RX_SEQ': 0,
'RX_RFS': 0,
'TX_RFS': 0,
'RX_STREAM_ID': 0,
'TX_STREAM_ID': 0,
'RX_TGID': 0,
'TX_TGID': 0,
'TX_PI_TGID': 0,
'RX_TIME': time(),
'TX_TIME': time(),
'RX_TYPE': fne_const.DT_TERMINATOR_WITH_LC,
'RX_LC': 0,
'RX_PI_LC': 0,
'TX_H_LC': 0,
'TX_P_LC': 0,
'TX_T_LC': 0,
'TX_EMB_LC': {
1: 0,
2: 0,
3: 0,
4: 0,
}
}
}
self.CALL_DATA = []
self.LAST_MODE = 'DMR'
def dmrd_validate(self, _peer_id, _rf_src, _dst_id, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id):
return True
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
pkt_time = time()
dmrpkt = _data[20:53]
_bits = _data[15]
if _call_type == 'group':
if (self.LAST_MODE != 'DMR'):
self._logger.info('(%s) DMRD: Previous call was not DMR, mixed call modes! Dropping call data.', self._system)
self.CALL_DATA = []
if (_rf_src == 0):
self._logger.warning('(%s) DMRD: Received call from SRC_ID %s? Dropping call data.', self._system, _rf_src)
self.CALL_DATA = []
self.LAST_MODE = 'P25'
return
self.LAST_MODE = 'DMR'
# Is this is a new call stream?
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']):
self.STATUS['RX_START'] = pkt_time
self._logger.info('(%s) DMRD: Traffic *CALL START * PEER %s SRC_ID %s TGID %s TS %s [STREAM ID %s]', self._system,
_peer_id, _rf_src, _dst_id, _slot, _stream_id)
# If we can, use the LC from the voice header as to keep all
# options intact
if _frame_type == fne_const.FT_DATA_SYNC and _dtype_vseq == fne_const.DT_VOICE_LC_HEADER:
lcHeader = lc.decode_lc_header(dmrpkt)
self.STATUS[_slot]['RX_LC'] = lcHeader['LC'][:9]
# If we don't have a voice header then don't wait to decode it
# from the Embedded LC
# just make a new one from the HBP header. This is good
# enough, and it saves lots of time
else:
self.STATUS[_slot]['RX_LC'] = const.LC_OPT + short_to_bytes(_dst_id) + short_to_bytes(_rf_src)
self.STATUS[_slot]['RX_PI_LC'] = const.LC_PI_OPT + b'\x00\x00\x00' + b'\x00\x00'
self._logger.debug('(%s) TS %s [STREAM ID %s] RX_LC %s', self._system, _slot, _stream_id, ahex(self.STATUS[_slot]['RX_LC']))
# If we can, use the PI LC from the PI voice header as to keep all
# options intact
if _frame_type == fne_const.FT_DATA_SYNC and _dtype_vseq == fne_const.DT_VOICE_PI_HEADER:
lcHeader = lc.decode_lc_header(dmrpkt)
_alg_id = lcHeader['LC'][0] & 0x7
_key_id = lcHeader['LC'][2]
self._logger.info('(%s) DMRD: Traffic *CALL PI PARAMS * PEER %s DST_ID %s TS %s ALGID %s KID %s [STREAM ID %s]', self._system,
_peer_id, _dst_id, _slot, _alg_id, _key_id, _stream_id)
self.STATUS[_slot]['RX_PI_LC'] = lcHeader['LC'][:10]
self._logger.debug('(%s) TS %s [STREAM ID %s] RX_PI_LC %s', self._system, _slot, _stream_id, ahex(self.STATUS[_slot]['RX_PI_LC']))
# Final actions - Is this a voice terminator?
if (_frame_type == fne_const.FT_DATA_SYNC) and (_dtype_vseq == fne_const.DT_TERMINATOR_WITH_LC) and (self.STATUS[_slot]['RX_TYPE'] != fne_const.DT_TERMINATOR_WITH_LC):
call_duration = pkt_time - self.STATUS['RX_START']
self._logger.info('(%s) DMRD: Traffic *CALL END * PEER %s SRC_ID %s TGID %s TS %s DUR %s [STREAM ID %s]', self._system,
_peer_id, _rf_src, _dst_id, _slot, call_duration, _stream_id)
self.CALL_DATA.append(_data)
sleep(2)
self._logger.info('(%s) DMRD: Playing back transmission from SRC_ID %s', self._system, _rf_src)
for _peer in self.CALL_DATA:
self.send_peers(_peer)
sleep(0.06)
self.CALL_DATA = []
else:
if not self.CALL_DATA:
self._logger.info('(%s) DMRD: Receiving transmission to be played back from SRC_ID %s', self._system, _rf_src)
self.CALL_DATA.append(_data)
# Mark status variables for use later
self.STATUS[_slot]['RX_RFS'] = _rf_src
self.STATUS[_slot]['RX_TYPE'] = _dtype_vseq
self.STATUS[_slot]['RX_TGID'] = _dst_id
self.STATUS[_slot]['RX_TIME'] = pkt_time
self.STATUS[_slot]['RX_STREAM_ID'] = _stream_id
def p25d_preprocess(self, _peer_id, _rf_src, _dst_id, _call_type, _duid, _dtype_vseq, _stream_id, _data):
return
def p25d_validate(self, _peer_id, _rf_src, _dst_id, _call_type, _duid, _dtype_vseq, _stream_id):
return True
def p25d_received(self, _peer_id, _rf_src, _dst_id, _call_type, _duid, _dtype_vseq, _stream_id, _data):
pkt_time = time()
p25pkt = _data[24:]
_slot = 1 # fake the slot data, P25 doesn't have this
if _call_type == 'group':
if (self.LAST_MODE != 'P25'):
self._logger.info('(%s) P25D: Previous call was not P25, mixed call modes! Dropping call data.', self._system)
self.CALL_DATA = []
if (_rf_src == 0):
self._logger.warning('(%s) P25D: Received call from SRC_ID %s? Dropping call data.', self._system, _rf_src)
self.CALL_DATA = []
self.LAST_MODE = 'P25'
return
self.LAST_MODE = 'P25'
# Is this is a new call stream?
if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']) and ((_duid != fne_const.P25_DUID_TDU) and (_duid != fne_const.P25_DUID_TDULC)):
self.STATUS['RX_START'] = pkt_time
self._logger.info('(%s) P25D: Traffic *CALL START * PEER %s SRC_ID %s TGID %s [STREAM ID %s]', self._system,
_peer_id, _rf_src, _dst_id, _stream_id)
# Final actions - Is this a voice terminator?
if ((_duid == fne_const.P25_DUID_TDU) or (_duid == fne_const.P25_DUID_TDULC)) and (self.STATUS[_slot]['RX_TYPE'] != fne_const.DT_TERMINATOR_WITH_LC):
call_duration = pkt_time - self.STATUS['RX_START']
self._logger.info('(%s) P25D: Traffic *CALL END * PEER %s SRC_ID %s TGID %s DUR %s [STREAM ID %s]', self._system,
_peer_id, _rf_src, _dst_id, call_duration, _stream_id)
self.CALL_DATA.append(_data)
sleep(2)
self._logger.info('(%s) P25D: Playing back transmission from SRC_ID %s', self._system, _rf_src)
for _peer in self.CALL_DATA:
self.send_peers(_peer)
sleep(0.12)
self.CALL_DATA = []
else:
if not self.CALL_DATA:
self._logger.info('(%s) P25D: Receiving transmission to be played back from SRC_ID %s', self._system, _rf_src)
self.CALL_DATA.append(_data)
# Mark status variables for use later
self.STATUS[_slot]['RX_RFS'] = _rf_src
self.STATUS[_slot]['RX_TYPE'] = _dtype_vseq
self.STATUS[_slot]['RX_TGID'] = _dst_id
self.STATUS[_slot]['RX_TIME'] = pkt_time
self.STATUS[_slot]['RX_STREAM_ID'] = _stream_id
def peer_ignored(self, _peer_id, _rf_src, _dst_id, _call_type, _slot, _dtype_vseq, _stream_id, _is_source):
return False
def peer_connected(self, _peer_id, _peer):
return
# ---------------------------------------------------------------------------
# Program Entry Point
# ---------------------------------------------------------------------------
if __name__ == '__main__':
from fne.fne_core import mk_id_dict
from fne.fne_core import setup_fne
# perform basic FNE setup
config, logger, act_log_file = setup_fne()
logger.info('Digital Voice Modem FNE Parrot Service R01.50')
# setup FNE report server
report_server = config_reports(config, logger, reportFactory)
# make dictionaries
white_rids = mk_id_dict(config['Aliases']['Path'], config['Aliases']['WhitelistRIDsFile'])
if white_rids:
logger.info('ID MAPPER: white_rids dictionary is available')
# FNE instance creation
logger.info('Parrot FNE - SYSTEM STARTING...')
for system in config['Systems']:
if config['Systems'][system]['Enabled']:
systems[system] = parrotFNE(system, config, logger, act_log_file, report_server)
reactor.listenUDP(config['Systems'][system]['Port'], systems[system], interface = config['Systems'][system]['Address'])
logger.debug('%s instance created: %s, %s', config['Systems'][system]['Mode'], system, systems[system])
reactor.run()