chiark / gitweb /
build, debian: Add a suffix to the main TrIPE-specific manpages.
[tripe] / keys / tripe-keys.8.in
CommitLineData
060ca767 1.\" -*-nroff-*-
2.\".
fc916a09
MW
3.\" Manual for the key-management tool
4.\"
5.\" (c) 2008 Straylight/Edgeware
6.\"
7.
8.\"----- Licensing notice ---------------------------------------------------
9.\"
10.\" This file is part of Trivial IP Encryption (TrIPE).
11.\"
12.\" TrIPE is free software; you can redistribute it and/or modify
13.\" it under the terms of the GNU General Public License as published by
14.\" the Free Software Foundation; either version 2 of the License, or
15.\" (at your option) any later version.
16.\"
17.\" TrIPE is distributed in the hope that it will be useful,
18.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
19.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20.\" GNU General Public License for more details.
21.\"
22.\" You should have received a copy of the GNU General Public License
23.\" along with TrIPE; if not, write to the Free Software Foundation,
24.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25.
26.\"--------------------------------------------------------------------------
e99aedcf 27.so ../common/defs.man \" @@@PRE@@@
fc916a09
MW
28.
29.\"--------------------------------------------------------------------------
0647ba7c 30.TH tripe-keys 8tripe "14 September 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
fc916a09
MW
31.
32.\"--------------------------------------------------------------------------
060ca767 33.SH "NAME"
fc916a09 34.
060ca767 35tripe-keys \- simple centralized key management for tripe
fc916a09
MW
36.
37.\"--------------------------------------------------------------------------
060ca767 38.SH "SYNOPSIS"
fc916a09 39.
060ca767 40.B tripe-keys
41.I operation
42.IP "Operations supported:"
c77687d5 43.BI "help \fR[" command \fR]
44.br
45.B "setup"
46.br
47.B "upload"
060ca767 48.br
49.BI "generate " tag
50.br
51.B "update"
52.br
c77687d5 53.B "newmaster"
060ca767 54.br
c77687d5 55.B "rebuild"
060ca767 56.br
c77687d5 57.B "clean"
65faf8df 58.br
c2f28e4b
MW
59.B "check"
60.br
65faf8df 61.BR "mtu " [ \fIpath-mtu ]
fc916a09
MW
62.
63.\"--------------------------------------------------------------------------
060ca767 64.SH "DESCRIPTION"
fc916a09 65.
060ca767 66The
67.B tripe-keys
68script implements a very simple, centralized key management system for
69.BR tripe (8).
70It assumes that there is a central authority who knows all the public
71keys for a private network.
72.SS "Overview"
73The
74.B tripe-keys
75program maintains a
76.I repository
77of public keys. It provides a way for a master authority to publish the
78repository and for clients to obtain authentic copies of it.
79.PP
80The repository is very simple: it consists of a directory
81.B repos
82full of public-key files, each named
83.BI peer- tag .pub \fR.
84.PP
85The repository setup process creates a master signing key, stored in the
86.B master
87keyring, and a key describing the parameters to be used for generating
88key-exchange keys, stored in
89.BR repos/param .
90.PP
91The master authority has a configuration file
92.BR tripe-keys.master ,
e04c2d50 93usually created by copying the template provided and editing it.
060ca767 94.PP
95The published repository consists of a tarball of the
96.B repos
97directory, containing the key-generation parameters and all the peers'
98public keys, and a client configuration file
99.BR tripe-keys.conf .
100The tarball is signed by the master authority's signing key.
101.PP
102The client configuration file is essentially a copy of
103.B tripe-keys.master
104with some extra bits filled in: in particular, it contains the
105fingerprint of the master signing key, so that the client can be sure
106it's checking the right key.
107.PP
108A peer starts by downloading a copy of
109.B tripe-keys.conf
110and then making sure it's authentic. (This is one of the tricky bits.
e04c2d50 111The other is getting public keys back to the master authority.) This is
060ca767 112enough for the peer to fetch a copy of the repository, verify the
113signature, and assemble a public keyring for the other peers in the
114network.
115.PP
116In fact, it's not
117.I quite
118that simple. The system allows new signing keys to replace old ones, so
119in fact the publication process signs the repository archive using a
120collection of keys. Each signing key is given a sequence number. The
121client configuration file contains the sequence number of the master
122signing key whose fingerprint it knows. During an update, the right
123signature is fetched and checked; if there's a new master key, then the
124.B tripe-keys.conf
125in the new repository archive will have its sequence number and
126fingerprint: the update process will replace its configuration file with
127the new version, and the peer will use the new key from then on.
128.SS "Options"
129The
130.B tripe-keys
131program accepts some standard command-line options:
132.TP
133.B "\-h, \-\-help"
134Print general help about
135.B tripe-keys
136to standard output and exit successfully.
137.TP
138.B "\-v, \-\-version"
139Print the version number of
140.B tripe-keys
141to standard output and exit successfully.
142.TP
143.B "\-u, \-\-usage"
144Print brief usage about
145.B tripe-keys
146to standard output and exit successfully.
147.SS "Subcommands"
148.TP
c77687d5 149.BI "help \fR[" command \fR]
060ca767 150With no arguments, shows help, as for the
151.B \-\-help
152option. With an argument, shows help about that
153.IR command .
154.TP
155.B "setup"
e04c2d50 156Constructs a new repository and makes a signing key (as for
060ca767 157.BR newmaster )
158and key-exchange parameters. Fails if
159.B repos
160already exists.
161.TP
162.B "upload"
163Build a repository archive, sign it with the active signing keys, and
164make a
165.B tripe-keys.conf
166file. Copy the results to the places named by
167.IR repos-file ,
168.IR sig-file ,
169and
170.I conf-file
171respectively. (This command is currently misnamed. It only copies
172stuff about the local filesystem. Some day it'll really upload stuff.)
173.TP
174.BI "generate " tag
175Generate a peer key for the peer named
176.IR tag .
177The private key ends up in
178.BR keyring ;
179the public key is written to
180.BI peer- tag .pub
181in the
182.I current
183directory.
184.TP
185.B update
186Fetches a new copy of the repository archive and its signature. It
187unpacks the archive in a temporary directory, and checks the enclosed
188master public key against the fingerprint in the configuration file. It
189then verifies the signature on the archive using this public key. If
190all is well, it replaces the current
191.B repos
192directory with the version in the new archive, and if necessary it
193replaces the current configuration file with the new one in the
e04c2d50 194archive. It then does a
060ca767 195.B rebuild
196to construct a new
197.B keyring.pub
198file.
199.TP
200.B newmaster
201Generates a new master signing key. The old master key is not deleted.
202.TP
203.B rebuild
204Rebuilds the public keyring
205.B keyring.pub
206from the public keys in the
207.B repos
208directory.
209.TP
210.B clean
211Deletes everything which
212.B tripe-keys
213might have written to a directory. In particular, it deletes
214.BR repos ,
215.BR tmp ,
216.BR master ,
217.BR keyring ,
218.BR keying.pub ,
219and their associated
220.B .old
221files.
65faf8df 222.TP
c2f28e4b
MW
223.B check
224Checks the various keyrings. Currently, it checks the
225.B master
226and
227.B keyring.pub
228files, and prints a report warning of keys which will expire soon. It
229is expected that this command be run against the master repository by
230.BR cron (8).
231Additional checking may added in the future.
232.TP
65faf8df
MW
233.BR "mtu " [ \fIpath-mtu ]
234Write, as a decimal number on standard output, the recommended MTU for a
235TrIPE tunnel interface, given that the
236.I path-mtu
237between two peers is as specified. The default is 1500, which is very
238commonly correct, but you should check using a tool such as
239.BR tracepath (8).
240Getting the MTU too big will lead to unnecessary fragmentation of
241TrIPE's UDP datagrams; getting it too small will fail to utilize the
242underlying network effectively. If in doubt, it's therefore better to
243underestimate.
fc916a09
MW
244.
245.\"--------------------------------------------------------------------------
060ca767 246.SH "SEE ALSO"
fc916a09 247.
060ca767 248.BR key (1),
249.BR tripe\-keys.conf (5),
250.BR tripe (8).
fc916a09
MW
251.
252.\"--------------------------------------------------------------------------
060ca767 253.SH "AUTHOR"
fc916a09 254.
060ca767 255Mark Wooding, <mdw@distorted.org.uk>
fc916a09
MW
256.
257.\"----- That's all, folks --------------------------------------------------