3 .\" Manual for the conntrack service
5 .\" (c) 2010 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 ../common/defs.man \"@@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH connect 8 "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 conntrack \- tripe service to start/stop peers depending on external connectivity
37 .\"--------------------------------------------------------------------------
53 .\"--------------------------------------------------------------------------
58 service watches D-Bus network management services like
59 .BR NetworkManager (8)
62 bringing peers up and down automatically. It's designed to be useful on
63 a mobile device, such as a laptop; I expect servers to stay where
64 they're put and be configured statically.
68 service reads a configuration file, by default
70 explaining which peers to bring up under which circumstances. The
71 configuration file is automatically re-read if it's changed.
74 configuration is split into sections, each describing a
76 A section begins with the peer group name in square brackets:
80 The group name is entirely arbitrary, and affects nothing else. This is
81 followed by peer definitions, each of which looks like this:
88 This means that the peer
90 should be selected if the host's current IP address is within the
92 .IB network / mask \fR.
95 is an IP address in dotted-quad form, and
97 is a netmask, either in dotted-quad form, or as a number of 1-bits.
98 Only one peer in each group may be connected at any given time; if a
99 change is needed, any existing peer in the group is killed before
100 connecting the new one. If no match is found in a particular group,
101 then no peers in the group are connected. Strange and unhelpful things
102 will happen if you put the same peer in several different groups.
104 The notion of `current IP address' is somewhat vague. The
106 service calculates it as the source address that the host would put on
107 an IP packet sent to an arbitrarily chosen remote address. The default
108 remote address is 1.2.3.4 (which is unlikely ever to be assigned); this
109 should determine an IP address on the network interface closest to the
110 default gateway. You can influence this process in two ways. Firstly,
111 you can change the default remote address used by adding a line
116 before the first peer group section. Secondly, you can specify a
119 to use when checking whether a particular peer is applicable.
121 The peer definitions can be in any order. They are checked
122 most-specific first, and searching stops as soon as a match is found.
123 Therefore a default definition can be added as
129 without fear of overriding any more specific definitions. For avoidance
130 of doubt, one peer definition is
132 than another if either the former has a specified
134 and the latter has not, or the former is wholly contained within the
135 latter. (Overlapping definitions are not recommended, and will be
136 processed in an arbitrary order.)
138 Peers are connected using the
142 .B SVCSUBMIT connect active
145 In addition to the standard options described in
146 .BR tripe-service (7),
147 the following command-line options are recognized.
149 .BI "\-f, \-\-config=" file
152 as the configuration file. In the absence of this option, the
155 in the current working directory is used instead.
157 .\"--------------------------------------------------------------------------
158 .SH "SERVICE COMMAND REFERENCE"
160 .\"* 10 Service commands
161 The commands provided by the service are as follows.
163 .BI "up " reason\fR...
164 Informs the service that the network connection has been established:
165 peer groups should be connected. The
167 is quoted in the status notification.
169 .BI "down " reason\fR...
170 Informs the service that the network connection has been lost:
171 peer groups should be disconnected. The
173 is quoted in the status notification.
175 .\"--------------------------------------------------------------------------
178 .\"* 30 Notification broadcasts (NOTE codes)
179 All notifications issued by
181 begin with the tokens
182 .BR "USER conntrack" .
184 .BI "USER conntrack dbus-connection " status
185 The service's connection to D-Bus has changed state. The
187 is one of the following.
191 Initially trying to connect.
194 Successfully established a connection to the bus.
197 A connection has been lost.
200 The service's internal state machine is confused.
202 .BI "USER conntrack " up \fR| down " " reason\fR...
203 The network connection has apparently gone up or down, and
205 is about to kill and/or connect peers accordingly. The
207 is one of the following.
210 .B "nm initially-connected"
211 NetworkManager was detected on startup, and has an active network
214 .B "nm initially-disconnected"
215 NetworkManager was detected on startup, and has no active network
219 NetworkManager has acquired an active network connection.
222 NetworkManager has lost its active network connection.
224 .B "nm default-connection-change"
225 NetworkManager has changed its default route.
227 .BI "icd initially-connected " iap
228 Maemo ICd was detected on startup, and has an active network connection
232 .B "icd initially-disconnected"
233 Maemo ICd was detected on startup, and has no active network connection.
235 .BI "icd connected " iap
236 Maemo ICd has acquired an active network connection, identified by
240 Maemo ICd has lost its active network connection.
243 A change was detected during
245 periodic status check. This usually means that the network connection
246 was reconfigured manually without informing
249 .BI "manual " reason\fR...
250 The connection status was changed manually, using the
257 .\"--------------------------------------------------------------------------
260 .\"* 40 Warning broadcasts (WARN codes)
261 All warnings issued by
263 begin with the tokens
264 .BR "USER conntrack" .
266 .BI "USER conntrack config-file-error " exception " " error-text
267 The configuration file is invalid. The
269 token names a Python exception; the
271 describes the problem encountered, though it may not be very useful.
273 .BI "USER conntrack connect-failed " peer " " tokens\fR...
274 An attempt to connect the named
276 failed; the error message is given by the
279 .\"--------------------------------------------------------------------------
284 .\"--------------------------------------------------------------------------
287 .BR tripe-service (7),
292 .\"--------------------------------------------------------------------------
295 Mark Wooding, <mdw@distorted.org.uk>
297 .\"----- That's all, folks --------------------------------------------------