Merge pull request #38 from Algafix/general-dev

Fix repeated IOD after out of sight
Algafix · May 27, 2024 · 5f0ead6 · 5f0ead6
2 parents a03b115 + 76e8b3c
commit 5f0ead6
Show file tree

Hide file tree

Showing 7 changed files with 238 additions and 3 deletions.
diff --git a/osnma/osnma_core/nav_data_manager.py b/osnma/osnma_core/nav_data_manager.py
@@ -177,8 +177,14 @@ def _iod_unambiguous(self, gst_page: GST) -> bool:
             return True
         return False
 
-    def _is_new_adkd0_data_block(self, iod: BitArray) -> bool:
-        return len(self.adkd0_data_blocks) == 0 or self.adkd0_data_blocks[-1].iod != iod
+    def _is_new_adkd0_data_block(self, iod: BitArray, gst_page: GST) -> bool:
+        if len(self.adkd0_data_blocks) == 0:
+            return True
+        if self.adkd0_data_blocks[-1].iod != iod:
+            return True
+        if gst_page - self.adkd0_data_blocks[-1].last_gst_updated > GST(tow=4*60*60):
+            # The IOD may be the same after 4 hours of data due to rotation of nav messages
+            return True
 
     def _clean_old_data(self):
         """
@@ -223,7 +229,7 @@ def add_word(self, word_type: int, page: BitArray, gst_page: GST):
 
         if word_type != 5:
             iod = adkd_data[:10]
-            if self._is_new_adkd0_data_block(iod):
+            if self._is_new_adkd0_data_block(iod, gst_page):
                 new_adkd0 = ADKD0DataBlock(gst_page)
                 new_adkd0.add_word(word_type, adkd_data, gst_page)
                 self.adkd0_data_blocks.append(new_adkd0)

diff --git a/tests/test_corner_cases.py b/tests/test_corner_cases.py
@@ -169,6 +169,30 @@ def test_osnma_after_outage(log_level=logging.INFO):
     input_module = SBF(config_dict['scenario_path'])
     run(input_module, config_dict, expected_results)
 
+def test_svid_12_repeats_iod(log_level=logging.INFO):
+
+    config_dict = {
+        'console_log_level': log_level,
+        'logs_path': LOGS_PATH,
+        'scenario_path': Path(__file__).parent / 'test_corner_cases/svid_12_repeats_iod/tag_error_12.sbf',
+        'exec_path': Path(__file__).parent / 'test_corner_cases/svid_12_repeats_iod/',
+        'pubk_name': 'OSNMA_PublicKey_1.xml',
+        'kroot_name': 'OSNMA_start_KROOT.txt'
+    }
+
+    expected_results = {
+        "tags_auth": 1359,
+        "data_auth": 1297,
+        "kroot_auth": 56,
+        "broken_kroot": 11,
+        "crc_failed": 123,
+        "warnings": 134,
+        "errors": 0
+    }
+
+    input_module = SBF(config_dict['scenario_path'])
+    run(input_module, config_dict, expected_results)
+
 def test_6_hours(log_level=logging.INFO):
 
     config_dict = {
@@ -265,6 +289,17 @@ def test_24_hours(log_level=logging.INFO):
     finally:
         test_done += 1
 
+    print(f"\nSVID 12 repeats IOD")
+    try:
+        test_svid_12_repeats_iod(general_log_level)
+    except AssertionError:
+        print(f"\tFAILED")
+    else:
+        test_passed += 1
+        print(f"\tCORRECT")
+    finally:
+        test_done += 1
+
     print(f"\n6 hours")
     try:
         test_6_hours(general_log_level)
@@ -276,6 +311,17 @@ def test_24_hours(log_level=logging.INFO):
     finally:
         test_done += 1
 
+    print(f"\n24 hours")
+    try:
+        test_24_hours(general_log_level)
+    except AssertionError:
+        print(f"\tFAILED")
+    else:
+        test_passed += 1
+        print(f"\tCORRECT")
+    finally:
+        test_done += 1
+
     print('\n=====================================')
     print(f'\tTEST PASSED: {test_passed}/{test_done}')
     print('=====================================')

diff --git a/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_MerkleTree.xml b/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_MerkleTree.xml
@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no" ?><signalData><header><GAL-header><source><GAL-EXT-GOC-SC-GLAd><mission>GAL</mission><segment>EXT</segment><element>GOC-SC</element></GAL-EXT-GOC-SC-GLAd></source><destination><GAL-EXT-GOC-SC-GLAd><mission>GAL</mission><segment>EXT</segment><element>GOC-SC</element></GAL-EXT-GOC-SC-GLAd></destination><issueDate>2024-01-15T10:00:00Z</issueDate><signalVersion>1.0</signalVersion><dataVersion>1.0</dataVersion></GAL-header></header><body><MerkleTree><UID>MT-22D568909FE0E92D2CE88F0B354E61BF827BB6A8007491A5A14C992C819A0F35</UID><Applicability><Begin>2024-01-15T10:00:00Z</Begin></Applicability><State>Applicable</State><SignatureFile>OSNMA_MerkleTree_20240115100000_newPKID_1.xml.p256</SignatureFile><SignatureVerificationCertificate>OSNMA_MerkleTree_20240115100000_newPKID_1.crt</SignatureVerificationCertificate><N>16</N><HashFunction>SHA-256</HashFunction><PublicKey><i>0</i><PKID>1</PKID><lengthInBits>264</lengthInBits><point>0397EB43789AA0F6D052A638468ECF5278E6F6DF8465ECB8D8B84B8C7A3501F73B</point><PKType>ECDSA P-256/SHA-256</PKType></PublicKey><TreeNode><j>4</j><i>0</i><lengthInBits>256</lengthInBits><x_ji>832E15EDE55655EAC6E399A539477B7C034CCE24C3C93FFC904ACD9BF842F04E</x_ji></TreeNode><TreeNode><j>3</j><i>1</i><lengthInBits>256</lengthInBits><x_ji>84DE3669E6DA551292979E5B8D045787FA967C57CC23638A30237614EDD9171A</x_ji></TreeNode><TreeNode><j>2</j><i>1</i><lengthInBits>256</lengthInBits><x_ji>DE73D209E4C5BCDC34CD117F2FE40FD08B110009997AD2B3291D3A2CF29943F9</x_ji></TreeNode><TreeNode><j>1</j><i>1</i><lengthInBits>256</lengthInBits><x_ji>6AAFDE28017BF0744D42819CE40E3A0CDA1ECA3F7A4EA67E134E7AA714C1E843</x_ji></TreeNode><TreeNode><j>0</j><i>1</i><lengthInBits>256</lengthInBits><x_ji>941BD34EA7DF668B6FC5BE75C1D93464D109BC615CB52C8124847FAFB09CBB2B</x_ji></TreeNode></MerkleTree></body></signalData>
diff --git a/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_PublicKey_1.xml b/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_PublicKey_1.xml
@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no" ?><signalData><header><GAL-header><source><GAL-EXT-GOC-SC-GLAd><mission>GAL</mission><segment>EXT</segment><element>GOC-SC</element></GAL-EXT-GOC-SC-GLAd></source><destination><GAL-EXT-GOC-SC-GLAd><mission>GAL</mission><segment>EXT</segment><element>GOC-SC</element></GAL-EXT-GOC-SC-GLAd></destination><issueDate>2024-01-15T10:00:00Z</issueDate><signalVersion>1.0</signalVersion><dataVersion>1.0</dataVersion></GAL-header></header><body><PublicKey><UID>PK-3A519D5B0E51F0E361AB46030E62C955271A3548DA1978F49EAEBC77EC67064E</UID><Applicability><Begin>2024-01-15T10:00:00Z</Begin></Applicability><State>Applicable</State><i>0</i><PKID>1</PKID><lengthInBits>264</lengthInBits><point>0397EB43789AA0F6D052A638468ECF5278E6F6DF8465ECB8D8B84B8C7A3501F73B</point><Certificate>OSNMA_PublicKey_20240115100000_newPKID_1.crt</Certificate><CRL>OSNMA_PublicKeyCRL_20240115100000_newPKID_1.crl</CRL><PKType>ECDSA P-256/SHA-256</PKType></PublicKey></body></signalData>
diff --git a/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_start_KROOT.txt b/tests/test_corner_cases/svid_12_repeats_iod/OSNMA_start_KROOT.txt
@@ -0,0 +1,2 @@
+2150492205096c1ee4b009ae6f643371be918fe4be6b8b2855f1a09ff72576fc70e7c4ef9ef56dcbbc27a48a97a0668b7fba60433ccfe010a935261dfffe3715b993d491b9cb6d63ed5beadcdbc7a3727068c0a294d522ef86e524f59822119da9ca365284853d04
+52
diff --git a/tests/test_corner_cases/svid_12_repeats_iod/extract_svid.py b/tests/test_corner_cases/svid_12_repeats_iod/extract_svid.py
@@ -0,0 +1,179 @@
+
+########### SCRIPT ###########
+IN_FILE = 'tag_error.sbf'
+OUT_FILE = 'tag_error_12.sbf'
+EXTRACT_SVID = 12
+
+########### SBF ###########
+SYNC = b'$@'
+TOW_DNU = 4294967295
+WNc_DNU = 65535
+TIME_STAMP = slice(8, 14)
+SVID = 14
+CRC = 15
+SOURCE = 17
+NAV_START = 20
+SIGNAL_MASK = 0x1f
+signal_type = {
+    17: 'GAL_L1BC',
+    19: 'GAL_E6BC',
+    20: 'GAL_E5a',
+    21: 'GAL_E5b',
+    22: 'GAL_E4_AltBOC'
+}
+CRC16_XMODEM_TABLE = [
+    0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7,
+    0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef,
+    0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6,
+    0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de,
+    0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485,
+    0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee, 0xf5cf, 0xc5ac, 0xd58d,
+    0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4,
+    0xb75b, 0xa77a, 0x9719, 0x8738, 0xf7df, 0xe7fe, 0xd79d, 0xc7bc,
+    0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823,
+    0xc9cc, 0xd9ed, 0xe98e, 0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b,
+    0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12,
+    0xdbfd, 0xcbdc, 0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a,
+    0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41,
+    0xedae, 0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49,
+    0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
+    0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78,
+    0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e, 0xe16f,
+    0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067,
+    0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c, 0xe37f, 0xf35e,
+    0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256,
+    0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e, 0xe54f, 0xd52c, 0xc50d,
+    0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
+    0xa7db, 0xb7fa, 0x8799, 0x97b8, 0xe75f, 0xf77e, 0xc71d, 0xd73c,
+    0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634,
+    0xd94c, 0xc96d, 0xf90e, 0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab,
+    0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3,
+    0xcb7d, 0xdb5c, 0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a,
+    0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92,
+    0xfd2e, 0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9,
+    0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
+    0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8,
+    0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1, 0x1ef0,
+]
+
+
+def crc_calculation(data, crc=0):
+
+    for byte in data:
+        crc = ((crc << 8) & 0xff00) ^ CRC16_XMODEM_TABLE[((crc >> 8) & 0xff) ^ byte]
+    return crc & 0xffff
+
+def parse_header(header):
+    """Parses the header into crc, id, length and id into block
+    number and block revision.
+
+    :param header: Bytes object with the 8 byte header.
+    :return: Tuple with the values (bytes) crc, (int) id, (int) length, (int) block_num, (int) rev_num.
+
+    """
+
+    crc = int.from_bytes(header[2:4], "little")
+    id = int.from_bytes(header[4:6], "little")
+    length = int.from_bytes(header[6:8], "little")
+
+    block_num = id & 0xdfff
+    rev_num = id >> 13
+
+    return crc, id, length, block_num, rev_num
+
+def parse_tow_wn(buffer):
+    tow = int.from_bytes(buffer[:4], 'little')
+    wn_c = int.from_bytes(buffer[4:], 'little')
+
+    if tow == TOW_DNU:
+        tow = 'DNU'
+    if wn_c == WNc_DNU:
+        wn_c = 'DNU'
+
+    return tow, wn_c
+
+def parse_SVID(svid):
+    if svid == 0:
+        svid = 'DNU'
+    elif 1 <= svid <= 37:
+        pass
+    elif 38 <= svid <= 61:
+        svid = svid - 37
+    elif svid == 62:
+        svid = 'GLONASS not known'
+    elif 63 <= svid <= 68:
+        svid = svid - 38
+    elif 71 <= svid <= 106:
+        svid = svid - 70
+    elif 107 <= svid <= 119:
+        pass
+    elif 120 <= svid <= 140:
+        pass
+    elif 141 <= svid <= 180:
+        svid = svid - 140
+    elif 181 <= svid <= 187:
+        svid = svid - 180
+    elif 191 <= svid <= 197:
+        svid = svid - 190
+    elif 198 <= svid <= 215:
+        svid = svid - 57
+    elif 216 <= svid <= 222:
+        svid = svid - 208
+    elif 223 <= svid <= 245:
+        svid = svid - 182
+    else:
+        svid = 'Not known'
+
+    return svid
+
+def parse_GALRawINAV(block):
+
+    tow, wn_c = parse_tow_wn(block[TIME_STAMP])
+    svid = parse_SVID(block[SVID])
+    crc_passed = bool(block[CRC])
+    source = signal_type[block[SOURCE] & SIGNAL_MASK]
+
+    return tow, wn_c, svid, crc_passed, source
+
+
+if __name__ == '__main__':
+
+    in_file = open(IN_FILE,'rb')
+    in_file_pos = in_file.tell()
+    out_file = open(OUT_FILE,'wb')
+
+    while header := in_file.read(8):
+        if header[:2] == SYNC:
+            # Possible block header detected
+            crc, block_id, length, block_num, rev_num = parse_header(header)
+
+            if length % 4 != 0:
+                # Not a block, advance one byte
+                in_file_pos += 1
+                in_file.seek(in_file_pos)
+                continue
+
+            block = header + in_file.read(length - 8)
+            calculated_crc = crc_calculation(block[4:])
+
+            if calculated_crc != crc:
+                # Not a block, advance one byte
+                in_file_pos += 1
+                in_file.seek(in_file_pos)
+                continue
+
+            if block_id == 4023:
+                # We have a block and its a gal raw nav block
+                tow, wn_c, svid, crc_passed, band = parse_GALRawINAV(block)
+
+                if svid == EXTRACT_SVID and band == 'GAL_L1BC' and tow != 'DNU' and wn_c != 'DNU':
+                    out_file.write(block)
+
+            # It was a valid block, update descriptor and continue
+            in_file_pos = in_file.tell()
+        else:
+            in_file_pos += 1
+            in_file.seek(in_file_pos)
+
+    in_file.close()
+    out_file.close()
diff --git a/tests/test_corner_cases/svid_12_repeats_iod/tag_error_12.sbf b/tests/test_corner_cases/svid_12_repeats_iod/tag_error_12.sbf