OSNMAlib is an open-source Python library that can be used for research purposes or be integrated into existing receivers and applications to incorporate navigation message authentication to the positioning process. It can read the Galileo I/NAV pages from an input, store the navigation and authentication data, perform the verification operations, and report the status.
The software has been successfully tested using the official ICD test vectors and data from corner cases recorded by us. To our knowledge, it has also been used to verify other third-party OSNMA implementations and in research.
Note that the security of the OSNMA protocol can only be guaranteed if the receiver providing the navigation data is synchronized with TL seconds of error with the Galileo System Time. By default, OSNMAlib assumes a TL of 30s: the maximum to process all tags. However, it can be configured for a different TL depending on what your receiver can guarantee. For more information about time synchronisation see the OSNMA Receiver Guidelines, and Configuration Options to configure OSNMAlib.
OSNMAlib implements several optimizations in the cryptographic material extraction and in the process of linking navigation data to tags [link]. None of these optimizations imply trial-and-error on the verification process, so if you see authentication failures in a non-spoofing scenario, feel free to report them.
A live visualization of the output of OSNMAlib can be found at OSNMAlib.eu. This web view uses a receiver located in KU Leuven, Belgium, and live aggregated data from galmon, to display the general state of OSNMA. It also provides the raw navigation bits received and the OSNMAlib status in JSON format.
If you are using data from the OSNMA Test Phase (before 2023-08-03 11:00), use the OSNMA_Test_Phase_ICD branch.
Supports Python 3.8, 3.9, 3.10, and 3.11. Tested on Linux and Windows.
Current OSNMA features supported:
- Verification of the public key retrieved from the DSM-PKR message.
- Verification of the TESLA root key retrieved from the DSM-KROOT message.
- Verification of a TESLA key against a root key or a previously authenticated key.
- Verification of the MACK message structure:
- ADKD sequence.
- MACSEQ value.
- FLX tags.
- Verification of the ADKD 0, ADKD 4 and ADKD 12 tags.
- Authentication of the navigation data.
- Support for custom TL values.
- Support for Cold Start, Warm Start and Hot Start.
- Support for the following events: EOC, CREV, NPK, PKREV, NMT, and OAM.
- JSON output for monitoring and postprocessing with
json-schema[html|json].
Extra optimizations for a faster TTFAF:
- Reconstruct broken HKROOT messages.
- Reconstruct TESLA key from partial MACK messages.
- Extract valid tags from broken MACK messages.
- Reed-Solomon recovery of I/NAV data using word types 17 to 20.
- Dual frequency reception of I/NAV data from the E5b-I signal.
- Link and recover lost data using the IOD and the COP.
- Obtain TTFAF as low as 44 seconds in hot start.
- https://arxiv.org/abs/2403.14739
Current data formats supported:
- Septentrio Binary Format (SBF) log files.
- Septentrio receiver live connection through IP port.
- u-blox UBX log files
- u-blox live connection through COM port
- Live aggregated data from the galmon project.
- GNSS-SDR project format through UDP socket.
- Note that GNSS-SDR recently implemented OSNMA inside their GNSS receiver.
- Allows for custom data by implementing your iterator.
Future development:
- Time synchronization options for live execution.
- IDD ICD implementation for authentication of cryptographic materials.
OSNMAlib
- This README file.
- Wiki
- OSNMAlib Paper ICL-GNSS 2024
- (Some information outdated) OSNMAlib Paper NAVITEC 2022
- See later in the README for a list of publications using OSNMAlib.
General OSNMA documentation
- GSC website with the reference documents
- Look at the ICD, the Receiver Guidelines, and the IDD
The required Python libraries can all be installed with pip using the requirements.txt file.
$ pip install -r requirements.txt
The folder custom_run/ contains the current Merkle Tree and Public Key, both downloaded from the official GSC website.
It also contains the current_config.sbf file with the current configuration recorded by me. You can run it directly with the console with:
$ cd custom_run/
$ python run.py
Beware the console output will be huge. A log folder will be created with the same logs for easy parsing.
The run.py file contains a dictionary with the configuration parameters that are more useful for a normal user.
The parameters are set to their default value, feel free to modify them at will.
You can also run your own SBF files by passing the file name as parameter.
Mind to also update the Merkle Tree and Public Key files in the configuration dictionary of run.py appropriately.
$ cd custom_run/
$ python run.py [filename]
If you want to see the library process data in real-time but don't have a receiver, I've integrated OSNMAlib with the galmon project.
You can find it under the folder live_galmon_run/ and run it with:
$ cd live_galmon_run/
$ python run.py
You will see information printed every 30s approximately. There may be some problems with the data received from galmon due to the P2P nature of this service.
The IP and Port are defaulted to 86.82.68.237:10000. You can specify your own in the Galmon input class constructor.
If you have access to a Septentrio receiver SBF log output, I have implemented a real-time input module for that.
To tell the receiver to output the required navigation data send the following commands to it. Mind that Stream2 or port 20000 may be in use.
setSBFOutput, Stream2, IPS1, GALRawINAV, sec1
setIPServerSettings, IPS1, 20000
Then just execute the software. By default, it connects to 192.168.3.1:20000.
$ cd live_septentrio_run/
$ python run.py
The wiki page Input Data contains useful information about all the input formats supported by OSNMAlib as well as documentation on how to develop a new one.
The software is provided with several test scenarios under the folder tests/scenarios/.
The scenarios cover different configurations and events of the OSNMA protocol.
The test files come from the Official Test Vectors and also from the live recording of some corner cases.
The pytest framework is the easiest way to execute the OSNMA Open Implementation receiver tests. To do so, the
following shell commands are provided. Note that the users interpreter work directory is assumed to be the top
folder of the provided software and python pip shall be already installed.
$ pip install -r requirements.txt
$ cd tests
$ pytest icd_test_vectors.py
# or
$ pytest test_corner_cases.py
The tests can also be executed using the traditional Python interpreter. In that case, execute the following shell commands.
$ pip install -r requirements.txt
$ cd tests
$ python3 icd_test_vectors.py
# or
$ python3 test_corner_cases.py
OSNMAlib has several configuration parameters that can be defined previous to execution. The parameters are defined in a dictionary and passed to the receiver when creating the receiver object. The receiver will load default values for the configuration parameters not specified.
The most important parameters are:
exec_path [mandatory]: Path to the folder where OSNMAlib will search for the Merkle Tree root, Public Key and KROOT. OSNMAlib will also store the received cryptographic material and logs (if no log path is specified).merkle_name [default='OSNMA_MerkleTree.xml']: Name of the Merkle Tree root file. Shall be in the GSA XML format.pubkey_name [default='']: Name of the stored Public Key file. If nothing is specified, OSNMAlib will assume Cold Start. Shall be in the GSA XML format.kroot_name [default='']: Name of the stored KROOT file. Shall have one line with the DSM KROOT complete message in hexadecimal and another line with the NMA Header in hexadecimal.TL [default=30]: Time synchronization value [s] of the receiver with the Galileo Satellite System time.
Based on the cryptographic material provided to OSNMAlib in the configuration dictionary, it will be set in one of the 3 start states defined in the ICD.
- Cold Start: OSNMAlib has no Public Key saved, it needs to be retrieved from the OSNMA message.
- Warm Start: OSNMAlib has a Public Key saved, but it is missing the Tesla KROOT. It needs to be retrieved from the OSNMA message.
- Hot Start: OSNMAlib has a Public Key and a Tesla KROOT saved, but it needs to ensure the KROOT is still valid by verifying one TESLA Key.
For a full description of the parameters and a diagram of the starting sequence, see the wiki page OSNMAlib Configuration Options.
There are two logging modalities (verbose and status) and two logging destinations (console and file) that can be enabled independently.
The verbose log outputs everything meaningful that happens in OSNMAlib in a time-sorted way. This means that OSNMAlib processes the data from the input and outputs what has managed to do with this data before reading the next.
The status log, on the other hand, outputs information only at the end of a subframe in JSON format.
This logging modality is useful to see the current state of OSNMAlib and post-process OSNMA information logged in the
JSON file. The description of the JSON structure can be found in the following json-schema [html|json].
When enabling the console as logging destination, both logging modalities are merged in the console output. However, if you enable the file logging, a file is created for each modality. Finally, there is a logging mode that only outputs the last subframe status in JSON format to a file.
For more information on how to set these logging options, see the wiki page OSNMAlib Configuration Options.
This repository partially contains data, information, and ideas regarding an ongoing PhD research. Please do not plagiarize OSNMA ideas and optimizations read on this repository until they have been scientifically disclosed, so you can reference them.
I strongly believe in open-source software and free access to knowledge, and this whole project remains open to honour these ideals.
However, this approach by my side requires the uttermost respect to the research integrity and ethics by anyone accessing the repository.
Publication list:
- "OSNMAlib Improvements and Real-Time Monitoring of Galileo OSNMA," ICL-GNSS, 2024. [link]
- Report on the latest OSNMAlib improvements including osnmalib.eu
- "Improving Galileo OSNMA Time To First Authenticated Fix." arXiv preprint arXiv:2403.14739, 2024. [link]
- Technical description of the optimization to reduce the TTFAF to 44 seconds and testing with live data recording.
- "GNSS Recordings for Galileo OSNMA Evaluation", IEEE Dataport, 2024. [link]
- Dataset used for the "Improving Galileo OSNMA Time To First Authenticated Fix" manuscript.
- "OSNMAlib: An Open Python Library for Galileo OSNMA," NAVITEC, Noordwijk, Netherlands, 2022. [link]
- Some sections are outdated.
In case of any doubt, contact me at aleix.galan[@]kuleuven.be
Thank you.
If you are having issues, please use the Issues page in GitHub.
If you want a protocol to be supported as an input for OSNMAlib you can kindly request it in the GitHub Issues page, providing its documentation and possible ways to test it.
Or you can create a Pull Request with your implementation. I will help you with any question that you may have about the interface class.
The project is licensed under the EUPL-1.2 license.
The research leading to this work was supported by European Commission contract SI2.823546/9 and by the Spanish Ministry of Science and Innovation project PID2020-118984GB-I00.
The current research is partially funded by the Research Foundation Flanders (FWO) Frank de Winne PhD Fellowship, project number 1SH9424N.
OSNMAlib has not been developed or tested operationally. OSNMAlib users use it at their own risk, without any guarantee or liability from the code authors or the Galileo signal provider.
OSNMAlib is not under any private company.