RTRlib Python Binding

The RTRlib is also available for scripting in Python using the RTRlib Python binding [1]. This section gives a quick overview on the usage of the Python binding. An even more detailed documentation on the API and further usage examples can be found on the corresponding readthedocs.io [2] page.


The RTRlib Python binding runs on Linux and Apple macOS like the C library. It supports both Python 2 and Python 3, in any recent release, detailed requirements and install instructions are described here.

Getting Started

The Python binding for the RTRlib has several dependencies. For compilation it requires the following external packages to be installed:

  • Python, version 2.7 or 3.x
  • C Compiler
  • RTRlib C library

To use the Python binding, the following Python packages have to be installed as well:

  • cffi>=1.4.0
  • enum34
  • six

If you are using virtualenv, these are installed automatically during the install step, otherwise you have to use your platforms package management tool or just run pip install -r requirements.txt.

Building and Installation

The setup process of the RTRlib Python binding is straight forward and complies to well-known Python standards. First, download the source code from Github:

git clone https://github.com/rtrlib/python-binding.git
cd python-binding

And second, build and install the package using Python commands:

python setup.py build
python setup.py install

Step-by-Step Example

The following code listings show how to implement a simple RPKI validator based on the RTRlib Python binding. The functionality basically reflects the rpki-rov tool shipped with the RTRlib C library (see RTRlib ROV Validator).

First, import required Python packages as shown in Listing 8; namely rtrlib, but also some future imports in case of Python 2.

Listing 8 Import RTRlib package
# uncomment future imports, required for Python 2
#from __future__ import print_function
from rtrlib import RTRManager, PfxvState

Afterwards, initialized and start an instance of the RTRManager, see Listing 9, mandatory parameters are host and port of a trusted RPKI cache server.

Listing 9 Setup and run RTRManager
mgr = RTRManager('rpki-validator.realmv6.org', 8282)

As soon as the RTRManager is up and running, it can validate any prefix to origin AS relation as shown in Listing 10. The return value in result contains the corresponding validation state, i.e., valid, invalid, or not_found; other return values indicate an error during validation.

Listing 10 Validate prefix to origin AS relation
result = mgr.validate(12345, '', 24)
if result == PfxvState.valid:
    print('Prefix Valid')
elif result == PfxvState.invalid:
    print('Prefix Invalid')
elif result == PfxvState.not_found:
    print('Prefix not found')
    print('Invalid response')
[1]RTRlib Python binding – https://github.com/rtrlib/python-binding
[2]ReadTheDocs – https://python-rtrlib.readthedocs.io