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 5 "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 "@inherits = " parent
102 then any lookups which can't be satisfied in that section will be
103 satisfied instead from the
105 section (and, if necessary, its parent in turn, and so on). Note that
107 substitutions in the resulting value will be satisfied from the original
108 section (though falling back to scanning the parent section). For
109 example, given the sections
113 blurb = expand $(detail)
115 Apart from its effect on lookups, as just described, the
117 key is entirely ignored. In particular, it is never written to the
120 .SS "Standard keys and their meanings"
121 The following keys have meanings to programs in the TrIPE suite. Other
122 keys may be used by separately distributed extensions or for local use.
123 The descriptions given are summaries only; see the references for
127 If true, include the peer in the
132 .BR tripe-newpeers (8);
136 Shell command for initiating connection to this peer. Used by
140 Don't initiate immediate key exchange. Used by
144 Shell command for closing down connection to this peer. Used by
148 Interval for checking that the peer is still alive and well. Used by
152 Script to bring down tunnel interface connected to the peer. Used by
156 Interface name to set for the tunnel interface to the peer. Used by
160 Script to bring up tunnel interface connected to the peer. Used by
164 Script containing additional interface setup. Used by
168 Local address for the tunnel interface to the peer. Used by
172 Interval for sending keepalive pings. Used by
176 Key tag to use to authenticate the peer. Used by
180 Peer's IP address is highly volatile. Used by
184 Maximum transmission unit for the tunnel interface. Used by
188 Networks to be routed over the tunnel interface. Used by
192 Network address for this peer, or
198 Tag of the private key to use when communicating with the peer.
203 Remote address for the tunnel interface to the peer. Used by
207 Number of failed ping attempts before attempting reconnection. Used by
211 Timeout for ping probes. Used by
215 Tunnel driver to use when adding the peer. Used by
219 Peer will make active connection as
224 .BR tripe-newpeers (8);
228 This section describes how the textual
230 file is converted into the
234 The handling of each section depends on its name.
236 Sections whose names have the form
238 are ignored (though their contents may be relevant if the section is
239 named in another section's
243 Sections whose names have the form
245 are written to local-type database records with the same name. The keys
246 and values defined in the section (and its parent section, if it
249 key) are stored in the record using
251 as defined in RFC1822, except that the key-value pairs are separated by
254 rather than ampersands
258 key-value pair is not written to the database.
260 Other sections are written to peer-type database records, named
262 in exactly the same way as for local-type records. However, two special
263 actions are also taken.
265 Firstly, if there is a key
267 in the section (or in its parent, etc.), and the value is
275 then the section's name is added in the special
279 Secondly, if there is a key
281 in the section (or in its parent, etc.), then a user record
283 is created whose contents is the section name.
285 .\"--------------------------------------------------------------------------
291 .BR tripe-newpeers (8),
296 .\"--------------------------------------------------------------------------
299 Mark Wooding, <mdw@distorted.org.uk>
301 .\"----- That's all, folks --------------------------------------------------