README
1Introduction
2------------
3The RTRlib implements the client-side of the RPKI-RTR protocol (RFC
46810, RFC 8210) and BGP Prefix Origin Validation (RFC 6811). This also
5enables the maintenance of router keys. Router keys are required to
6deploy BGPSEC.
7
8The software was successfully tested on Linux and FreeBSD.
9
10This package contains also the rtrclient program. It connects to an
11RTR-Server over TCP or SSH and shows on STDOUT prefix origin data and
12router keys that have been received from the RTR server. The program can
13be found in the bin/ directory.
14
15Requirements
16------------
17To build the RTRlib, the CMake build system must be installed.
18
19To establish an SSH connection between RTR-Client and RTR-Server, the
20libssh 0.6.x or higher library must also be installed.
21
22cmocka (optional) is required for unit tests
23Doxygen (optional) is required to create the HTML documentation.
24
25
26Compilation
27-----------
28
29* Generate Makefile:
30
31 Without debugging options
32
33 cmake -D CMAKE_BUILD_TYPE=Release .
34
35 With debug symbols and debug messages:
36
37 cmake -D CMAKE_BUILD_TYPE=Debug .
38
39 If the libssh isn't installed within the systems include and library
40 directories you can run cmake with the following parameters:
41
42 -D LIBSSH_LIBRARY=<path-to-libssh.so>
43 -D LIBSSH_INCLUDE=<include-directory>
44
45 To specify another directory where the RTRlib will be installed, you
46 can pass the following argument to cmake:
47
48 -D CMAKE_INSTALL_PREFIX=<path>
49
50* Build library, tests, and tools
51
52 make
53
54
55Installation
56------------
57To copy libraries and headers to system directories, run (optional):
58
59 make install
60
61
62Linking to RTRlib
63----------------------
64The name of the shared library is rtr. To link programs to the RTRlib,
65pass the following parameter to gcc:
66
67 -lrtr
68
69In case an error such as
70
71 -/usr/bin/ld: cannot find -lrtr
72 -collect2: error: ld returned 1 exit status
73
74occurs, the location of the library can be passed explicitly as a parameter
75
76 -L<path_to_librtr.so>
77
78e.g.,
79 -L/usr/local/lib64/
80
81
82API Documentation
83-----------------
84The RTRlib includes a HTML documentation of the API. To build them,
85doxygen must be installed. The documentation will be located in the
86docs/ directory after the execution of:
87
88 make doc
89
90
91Test RTR-Server Connection
92--------------------------
93The following command establishes a plain TCP connection to an
94RTR-Server using the rtrclient command line tool:
95
96 bin/rtrclient tcp rpki-validator.realmv6.org 8282
97
98rpki-validator.realmv6.org is an open RTR-Server instance for testing
99purposes, which runs the RIPE Validator. It listens on port 8282 and
100validates ROAs from the following trust anchors: AfriNIC, APNIC, ARIN,
101LACNIC, RIPE.
102
103
104Directories
105-----------
106* cmake/ - CMake modules
107* doxygen/ - Example code and graphics used in the Doxygen
108 documentation
109* rtrlib/ - Header and source code files of the RTRlib
110* tests/ - Unit tests
111* tools/ - Contains the rtrclient
112
113
114Contact
115-------
116Website: http://rtrlib.realmv6.org/
117
118Mailing List: rtrlib@googlegroups.com
119
120
121
122
123
124/* vim: set tw=72 sts=2 sw=2 ts=2 expandtab: */
125