aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2014-09-12 22:05:07 +0000
committerRob Austein <sra@hactrn.net>2014-09-12 22:05:07 +0000
commitc02686daf6dcc4175f119adc5d19261f577b2856 (patch)
tree29fb08838b408777b54358241fe251e71ad1ad56
parentace1ec7906ef38a9ed8cd73b5bada7846ba71563 (diff)
Pull from trunk.
svn path=/branches/tk705/; revision=5946
-rw-r--r--doc/doc.RPKI.RP14
-rw-r--r--doc/doc.RPKI.RP.HierarchicalRsync8
-rw-r--r--doc/doc.RPKI.RP.RunningUnderCron14
-rw-r--r--doc/doc.RPKI.RP.rpki-rtr120
-rw-r--r--doc/manual.pdfbin757140 -> 757928 bytes
5 files changed, 83 insertions, 73 deletions
diff --git a/doc/doc.RPKI.RP b/doc/doc.RPKI.RP
index 1f6774ee..107e878b 100644
--- a/doc/doc.RPKI.RP
+++ b/doc/doc.RPKI.RP
@@ -8,7 +8,7 @@ BGP security.
See the CA tools for programs to help you generate RPKI objects, if you need to
do that.
-The RP main tools are rcynic and rtr-origin, each of which is discussed below.
+The RP main tools are rcynic and rpki-rtr, each of which is discussed below.
The installation process sets up everything you need for a basic RPKI
validation installation. You will, however, need to think at least briefly
@@ -30,14 +30,14 @@ documentation if you need to know more.
See the discussion of trust anchors.
-***** rtr-origin *****
+***** rpki-rtr *****
-rtr-origin is an implementation of the rpki-rtr protocol, using rcynic's output
-as its data source. rtr-origin includes the rpki-rtr server, a test client, and
-a utiltity for examining the content of the database rtr-origin generates from
-the data supplied by rcynic.
+rpki-rtr is an implementation of the rpki-rtr protocol, using rcynic's output
+as its data source. rpki-rtr includes the rpki-rtr server, a test client, and a
+utiltity for examining the content of the database rpki-rtr generates from the
+data supplied by rcynic.
-See the rtr-origin documentation for further details.
+See the rpki-rtr documentation for further details.
***** rcynic-cron *****
diff --git a/doc/doc.RPKI.RP.HierarchicalRsync b/doc/doc.RPKI.RP.HierarchicalRsync
index 06aeefeb..c3825556 100644
--- a/doc/doc.RPKI.RP.HierarchicalRsync
+++ b/doc/doc.RPKI.RP.HierarchicalRsync
@@ -50,8 +50,8 @@ Script for a downstream relying party using ssh might look like this:
data/rcynic.${host}
done
cd /var/rcynic/rpki-rtr
- /usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
- data/authenticated'
+ /usr/bin/su -m rcynic -c '/usr/local/bin/rpki-rtr cronjob /var/rcynic/data/
+ authenticated'
where /root/rpki_ssh_id_rsa is an SSH private key authorized to log in as user
"rpkisync" on the gatherer machines. If you want to lock this down a little
@@ -81,8 +81,8 @@ configuration would look more like this:
data/rcynic.${host}
done
cd /var/rcynic/rpki-rtr
- /usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
- data/authenticated'
+ /usr/bin/su -m rcynic -c '/usr/local/bin/rpki-rtr cronjob /var/rcynic/data/
+ authenticated'
where "unauthenticated" here is an rsync module pointing at /var/rcynic/data/
unauthenticated on each of the gatherer machines. Configuration for such a
diff --git a/doc/doc.RPKI.RP.RunningUnderCron b/doc/doc.RPKI.RP.RunningUnderCron
index efb6defd..3fc2da71 100644
--- a/doc/doc.RPKI.RP.RunningUnderCron
+++ b/doc/doc.RPKI.RP.RunningUnderCron
@@ -6,8 +6,8 @@ under the cron daemon, so that they can make use of rcynic's output immediately
after rcynic finishes a validation run.
rcynic-cron runs the basic set of relying party tools (rcynic, rcynic-html, and
-`rtr-origin --cronjob`); if this suffices for your purposes, you don't need to
-do anything else. This section is a discussion of alternative approaches.
+rpki-rtr cronjob); if this suffices for your purposes, you don't need to do
+anything else. This section is a discussion of alternative approaches.
Which tools you want to run depends on how you intend to use the relying party
tools. Here we assume a typical case in which you want to gather and validate
@@ -39,9 +39,8 @@ On FreeBSD or MacOSX, this script might look like this:
rcynic.conf || exit
/var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /usr/local/www/data/
rcynic
- cd /var/rcynic/rpki-rtr
- /usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
- data/authenticated'
+ /usr/bin/su -m rcynic -c '/usr/local/bin/rpki-rtr cronjob /var/rcynic/data/
+ authenticated /var/rcynic/rpki-rtr'
This assumes that you have done
@@ -54,9 +53,8 @@ program:
#!/bin/sh -
/usr/bin/chrootuid /var/rcynic rcynic /bin/rcynic -c /etc/rcynic.conf || exit
/var/rcynic/bin/rcynic-html /var/rcynic/data/rcynic.xml /var/www/rcynic
- cd /var/rcynic/rpki-rtr
- /usr/bin/su -m rcynic -c '/usr/local/bin/rtr-origin --cronjob /var/rcynic/
- data/authenticated'
+ /usr/bin/su -m rcynic -c '/usr/local/bin/rpki-rtr cronjob /var/rcynic/data/
+ authenticated /var/rcynic/rpki-rtr'
If you use the chroot program instead of chrootuid, change the line that
invokes rcynic to:
diff --git a/doc/doc.RPKI.RP.rpki-rtr b/doc/doc.RPKI.RP.rpki-rtr
index af91b4a9..bb27ea4e 100644
--- a/doc/doc.RPKI.RP.rpki-rtr
+++ b/doc/doc.RPKI.RP.rpki-rtr
@@ -1,73 +1,75 @@
****** rpki-rtr ******
-rtr-origin is an implementation of the "RPKI-router" protocol (RFC-6810).
+rpki-rtr is an implementation of the "RPKI-router" protocol (RFC-6810).
-rtr-origin depends on `rcynic` to collect and validate the RPKI data. rtr-
-origin's's job is to serve up that data in a lightweight format suitable for
+rpki-rtr depends on `rcynic` to collect and validate the RPKI data. rpki-
+rtr's's job is to serve up that data in a lightweight format suitable for
routers that want to do prefix origin authentication.
-To use rtr-origin, you need to do two things beyond just running rcynic:
+To use rpki-rtr, you need to do two things beyond just running rcynic:
1. You need to post-process `rcynic`'s output into the data files used by
- rtr-origin. The rcynic-cron script handles this automatically, so the
+ rpki-rtr. The rcynic-cron script handles this automatically, so the
default installation should already be taking care of this for you.
- 2. You need to set up a listener for the rtr-origin server, using the
- generated data files. The platform-specific packages for FreeBSD, Debian,
- and Ubuntu automatically set up a plain TCP listener, but you will have to
- do something on other platforms, or if you're using a transport protocol
+ 2. You need to set up a listener for the rpki-rtr server, using the generated
+ data files. The platform-specific packages for FreeBSD, Debian, and Ubuntu
+ automatically set up a plain TCP listener, but you will have to do
+ something on other platforms, or if you're using a transport protocol
other than plain TCP.
***** Post-processing rcynic's output *****
-rtr-origin is designed to do the translation from raw RPKI data into the rpki-
-rtr protocol only once. It does this by pre-computing the answers to all the
+rpki-rtr is designed to do the translation from raw RPKI data into the rpki-rtr
+protocol only once. It does this by pre-computing the answers to all the
queries it is willing to answer for a given data set, and storing them on disk.
-rtr-origin's --cronjob mode handles this computation.
+rpki-rtr's cronjob command handles this computation.
-To set this up, add an invocation of rtr-origin --cronjob to the cron job
-you're already running to run rcynic. As mentioned above, if you're running the
+To set this up, add an invocation of rpki-rtr cronjob to the cron job you're
+already running to run rcynic. As mentioned above, if you're running the
rcynic-cron script, this is already being done for you automatically, so you
don't need to do anything. If you've written your own cron script, you'll need
to add something like this to your script:
- cd /var/rcynic/rpki-rtr
- /usr/local/bin/rtr-origin --cronjob /var/rcynic/data/authenticated
+ /usr/local/bin/rpki-rtr cronjob /var/rcynic/data/authenticated /var/rcynic/
+ rpki-rtr
-In --cronjob mode, rtr-origin, needs write access to a directory where it can
-store pre-digested versions of the data it pulls from rcynic. In the example
-above, the directory /var/rcynic/rpki-rtr should be writable by the user ID
-that is executing the cron script.
+rpki-rtr cronjob needs write access to a directory where it can store pre-
+digested versions of the data it pulls from rcynic. In the example above, the
+directory /var/rcynic/rpki-rtr should be writable by the user ID that is
+executing the cron script.
-rtr-origin creates a collection of data files, as well as a subdirectory in
-which each instance of the program running in --server mode can write a PF_UNIX
-socket file. At present, rtr-origin creates these files under the directory in
-which you run it, hence the cd command shown above.
+rpki-rtr creates a collection of data files, as well as a subdirectory in which
+each instance of rpki-rtr server can place a PF_UNIX socket file. By default,
+rpki-rtr creates these files under the directory in which you run it, but you
+can change that by specifying the target directory as a second command line
+argument, as shown above.
-You should make sure that rtr-origin --cronjob runs at least once before
-attempting to configure --server mode. Nothing terrible will happen if you
-don't do this, but --server invocations started before the first --cronjob run
-may behave oddly.
+You should make sure that rpki-rtr cronjob runs at least once before attempting
+to configure rpki-rtr server. Nothing terrible will happen if you don't do
+this, but rpki-rtr server invocations started before the first rpki-rtr cronjob
+run may behave oddly.
***** Setting up the rpki-rtr server *****
-You need to to set up a server listener that invokes rtr-origin in --server
-mode. What kind of server listener you set up depends on which network protocol
-you're using to transport this protocol. rtr-origin is happy to run under
-inetd, xinetd, sshd, or pretty much anything -- rtr-origin doesn't really care,
-it just reads from stdin and writes to stdout.
+You need to to set up a server listener that invokes `rpki-rtr server`. What
+kind of server listener you set up depends on which network protocol you're
+using to transport this protocol. rpki-rtr is happy to run under inetd, xinetd,
+sshd, or pretty much anything -- rpki-rtr doesn't really care, it just reads
+from stdin and writes to stdout.
---server mode should be run as a non-privileged user (it is read-only for a
+rpki-rtr server should be run as a non-privileged user (it is read-only for a
reason). You may want to set up a separate UNIX userid for this purpose.
---server mode takes an optional argument specifying the path to its data
+rpki-rtr server takes an optional argument specifying the path to its data
directory; if you omit this argument, it uses the directory in in which you run
it.
The details of how you set up a listener for this vary depending on the network
-protocol and the operating system on which you run it. Here are two examples,
-one for running under inetd on FreeBSD, the other for running under sshd.
+protocol and the operating system on which you run it. Here are three examples,
+for running under inetd on FreeBSD, under sshd, or as a free-standing server
+using rpki-rtr listener.
-**** Running rtr-origin --server under inetd ****
+**** Running rpki-rtr server under inetd ****
Running under inetd with plain TCP is insecure and should only be done for
testing, but you can also run it with TCP-MD5 or TCP-AO, or over IPsec. The
@@ -87,8 +89,8 @@ To run under inetd, you need to:
1. Add the service line to /etc/inetd.conf:
- rpki-rtr stream tcp nowait nobody /usr/local/bin/rtr-origin rtr-origin --
- server /var/rcynic/rpki-rtr
+ rpki-rtr stream tcp nowait nobody /usr/local/bin/rpki-rtr rpki-rtr server /
+ var/rcynic/rpki-rtr
This assumes that you want the server to run as user "nobody", which
is generally a safe choice, or you could create a new non-priviledged
@@ -96,12 +98,12 @@ To run under inetd, you need to:
anything bad, but it's a network server that doesn't need root
access, therefore it shouldn't have root access.
-**** Running rtr-origin --server under sshd ****
+**** Running rpki-rtr server under sshd ****
-To run rtr-origin under sshd, you need to:
+To run rpki-rtr server under sshd, you need to:
1. Decide whether to run a new instance of sshd on a separate port or use the
- standard port. rtr-origin doesn't care, but some people seem to think that
+ standard port. rpki-rtr doesn't care, but some people seem to think that
it's somehow more secure to run this service on a different port. Setting
up sshd in general is beyond the scope of this documention, but most
likely you can copy the bulk of your configuration from the standard
@@ -109,12 +111,12 @@ To run rtr-origin under sshd, you need to:
2. Configure sshd to know about the rpki-rtr subsystem. Add something like
this to your sshd.conf:
- Subsystem rpki-rtr /usr/local/bin/rtr-origin
+ Subsystem rpki-rtr /usr/local/bin/rpki-rtr
1. Configure the userid(s) you expect SSH clients to use to connect to the
server. For operational use you almost certainly do NOT want this user to
have a normal shell, instead you should configure its shell to be the
- server (/usr/local/bin/rtr-origin or wherever you've installed it on your
+ server (/usr/local/bin/rpki-rtr or wherever you've installed it on your
system) and its home directory to be the rpki-rtr data directory (/var/
rcynic/rpki-rtr or whatever you're using). If you're using passwords to
authenticate instead of ssh keys (not recommended) you will always need to
@@ -140,6 +142,19 @@ To run rtr-origin under sshd, you need to:
Subsystem line, which runs the server.sh script as the "rpki-rtr"
service, as required by the protocol specification.
+**** Running rpki-rtr listener ****
+
+rpki-rtr listener is a free-standing plain TCP server which just listens on a
+TCP socket then forks a child process running rpki-rtr server.
+
+All of the caveats regarding plain TCP apply to rpki-rtr listener.
+
+rpki-rtr listener takes one required argument, the TCP port number on which to
+listen; it also accepts a second argument which specifies the rcynic output
+directory, like rpki-rtr server.
+
+ /usr/local/bin/rpki-rtr listener 42420 /var/rcynic/rpki-rtr
+
**** Other transports ****
You can also run this code under xinetd, or the netpipes "faucet" program, or
@@ -151,19 +166,16 @@ doesn't make a lot of sense to go to all the trouble of checking RPKI data then
let the bad guys feed bad data into your routers anyway because you were
running the rpki-rtr link over an unsecured TCP connection.
-***** Other modes *****
+***** Other commands *****
-rtr-origin has two other modes which might be useful for debugging:
+rpki-rtr has two other commands which might be useful for debugging:
- 1. --client mode implements a dumb client program for this protocol, over
- SSH, raw TCP, or by invoking --server mode directly in a subprocess. The
+ 1. rpki-rtr client implements a dumb client program for this protocol, over
+ SSH, raw TCP, or by invoking rpki-rtr server directly in a subprocess. The
output is not expected to be useful except for debugging. Either run it
locally where you run the cron job, or run it anywhere on the net, as in
- $ rtr-origin --client tcp <hostname> <port>
+ $ rpki-rtr client tcp <hostname> <port>
- 2. --show mode will display a text dump of pre-digested data files in the
+ 2. rpki-rtr show will display a text dump of pre-digested data files in the
current directory.
-
-rtr-origin has a few other modes intended to support specific research
-projects, but they're not intended for general use.
diff --git a/doc/manual.pdf b/doc/manual.pdf
index 2985cc6a..656f1223 100644
--- a/doc/manual.pdf
+++ b/doc/manual.pdf
Binary files differ