3 .\" Manual for the peer configuration file
5 .\" (c) 2008 Straylight/Edgeware
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of Trivial IP Encryption (TrIPE).
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.
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.
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.
26 .\"--------------------------------------------------------------------------
27 .so ../defs.man.in \"@@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH peers.in 5tripe "27 March 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 peers.in \- source form for TrIPE peer database
37 .\"--------------------------------------------------------------------------
42 file is a plain text configuration file. It is read by
43 .BR tripe-newpeers (8)
44 in order to produce the
46 database used by services and other tools.
48 .SS "General structure"
49 The configuration file is line-oriented. Blank lines are ignored; lines
54 are ignored. The file is divided into sections by section headers,
55 which are lines of the form
59 Within each section are a number of assignments, of the form
63 or (entirely equivalent)
69 must start in the left hand column. The
71 may span multiple lines if subsequent lines begin with whitespace, in
72 the manner of RFC822 headers.
74 There is a special case to be aware of: if a section doesn't specify a
77 then the section's own name is used as a default.
79 The following substitutions are made in the body of a value.
83 is replaced by the value assigned to the given
88 is replaced by the IP address of the named
96 There is a simple concept of
98 for sections. If a section contains an assignment
100 .BI "@inherit = " parent
105 then any lookups which can't be satisfied in that section will be
106 satisfied instead from its
108 sections (and, if necessary, their parents in turn, and so on).
111 If a value can be found for a key via multiple parents then all of them
114 value. This restriction may be relaxed somewhat, if it turns out that a
115 more flexible notion of multiple inheritance is useful.
117 It's not allowed for a section to inherit, possibly indirectly, from
118 itself. Currently errors of this kind are only diagnosed when a cycle
119 is encountered while looking up a key and none of the sections on the
120 path from the original section up to and round the cycle define a value
121 for it. Future versions of this program might be more picky.
125 substitutions in the resulting value will be satisfied from the original
126 section (though falling back to scanning parent sections). For
127 example, given the sections
131 blurb = expand $(detail)
139 .RB ` "expand in parent" '
143 .RB ` "expand in child" '
147 Apart from its effect on lookups, as just described, the
149 key is entirely ignored. In particular, it is never written to the
152 .SS "Standard keys and their meanings"
153 The following keys have meanings to programs in the TrIPE suite. Other
154 keys may be used by separately distributed extensions or for local use.
155 The descriptions given are summaries only; see the references for
159 If true, include the peer in the
164 .BR tripe-newpeers (8);
168 Shell command for initiating connection to this peer. Used by
172 Don't initiate immediate key exchange. Used by
176 Shell command for closing down connection to this peer. Used by
180 Interval for checking that the peer is still alive and well. Used by
184 Script to bring down tunnel interface connected to the peer. Used by
188 Interface name to set for the tunnel interface to the peer. Used by
192 Script to bring up tunnel interface connected to the peer. Used by
196 Script containing additional interface setup. Used by
200 Local address for the tunnel interface to the peer. Used by
204 Interval for sending keepalive pings. Used by
208 Key tag to use to authenticate the peer. Used by
212 Peer's IP address is highly volatile. Used by
216 Maximum transmission unit for the tunnel interface. Used by
220 Networks to be routed over the tunnel interface. Used by
224 Network address for this peer, or
230 Tag of the private key to use when communicating with the peer.
235 Remote address for the tunnel interface to the peer. Used by
239 Number of failed ping attempts before attempting reconnection. Used by
243 Timeout for ping probes. Used by
247 Tunnel driver to use when adding the peer. Used by
251 Peer will make active connection as
256 .BR tripe-newpeers (8);
260 This section describes how the textual
262 file is converted into the
266 The handling of each section depends on its name.
268 Sections whose names have the form
270 are ignored (though their contents may be relevant if the section is
271 named in another section's
275 Sections whose names have the form
277 are written to local-type database records with the same name. The keys
278 and values defined in the section (and its parent section, if it
281 key) are stored in the record using
283 as defined in RFC1822, except that the key-value pairs are separated by
286 rather than ampersands
290 key-value pair is not written to the database.
292 Other sections are written to peer-type database records, named
294 in exactly the same way as for local-type records. However, two special
295 actions are also taken.
297 Firstly, if there is a key
299 in the section (or in its parent, etc.), and the value is
307 then the section's name is added in the special
311 Secondly, if there is a key
313 in the section (or in its parent, etc.), then a user record
315 is created whose contents is the section name.
317 .\"--------------------------------------------------------------------------
323 .BR tripe-newpeers (8),
328 .\"--------------------------------------------------------------------------
331 Mark Wooding, <mdw@distorted.org.uk>
333 .\"----- That's all, folks --------------------------------------------------