[tripe] / svc / conntrack.8.in

.\" -*-nroff-*-
.\".
.\" Manual for the conntrack service
.\"
.\" (c) 2010 Straylight/Edgeware
.\"
.
.\"----- Licensing notice ---------------------------------------------------
.\"
.\" This file is part of Trivial IP Encryption (TrIPE).
.\"
.\" TrIPE is free software: you can redistribute it and/or modify it under
.\" the terms of the GNU General Public License as published by the Free
.\" Software Foundation; either version 3 of the License, or (at your
.\" option) any later version.
.\"
.\" TrIPE is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with TrIPE.  If not, see <https://www.gnu.org/licenses/>.
.
.\"--------------------------------------------------------------------------
.so ../common/defs.man \"@@@PRE@@@
.
.\"--------------------------------------------------------------------------
.TH conntrack 8tripe "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
.
.\"--------------------------------------------------------------------------
.SH "NAME"
.
conntrack \- tripe service to start/stop peers depending on external connectivity
.
.\"--------------------------------------------------------------------------
.SH "SYNOPSIS"
.
.B conntrack
.RB [ \-a
.IR socket ]
.RB [ \-d
.IR dir ]
.RB [ \-f
.IR file ]
.br
\&	\c
.RB [ \-\-daemon ]
.RB [ \-\-debug ]
.RB [ \-\-startup ]
.
.\"--------------------------------------------------------------------------
.SH "DESCRIPTION"
.
The
.B conntrack
service watches D-Bus network management services like
.BR NetworkManager (8),
.BR ConnMan
.RB ( connmand (8)),
and Nokia's
.BR ICd ,
bringing peers up and down automatically.  It's designed to be useful on
a mobile device, such as a laptop; I expect servers to stay where
they're put and be configured statically.
.SS "Configuration"
The
.B conntrack
service reads a configuration file, by default
.BR conntrack.conf ,
explaining which peers to bring up under which circumstances.  The
configuration file is automatically re-read if it's changed.
.PP
The
configuration is split into sections, each describing a
.IR "peer group" . 
A section begins with the peer group name in square brackets:
.IP
.BI [ group ]
.PP
The group name is entirely arbitrary, and affects nothing else.  This is
followed by peer definitions, each of which looks like this:
.IP
.I tag
.B =
.RI [ remote-addr ]
.IB network / mask
.PP
This means that the peer
.I tag
should be selected if the host's current IP address is within the
network indicated by
.IB network / mask \fR.  
Here,
.I network
is an IP address in dotted-quad form, and
.I mask
is a netmask, either in dotted-quad form, or as a number of 1-bits.
Only one peer in each group may be connected at any given time; if a
change is needed, any existing peer in the group is killed before
connecting the new one.  If no match is found in a particular group,
then no peers in the group are connected.  Strange and unhelpful things
will happen if you put the same peer in several different groups.
.PP
The tags
.B down
and
.BI down/ anything
are special and mean that no peer from the group should be active.  This
is useful for detecting a `home' network, where a VPN is unnecessary
(or, worse, break routing completely).
.PP
The notion of `current IP address' is somewhat vague.  The
.B conntrack
service calculates it as the source address that the host would put on
an IP packet sent to an arbitrarily chosen remote address.  The default
remote address is 1.2.3.4 (which is unlikely ever to be assigned); this
should determine an IP address on the network interface closest to the
default gateway.  You can influence this process in two ways.  Firstly,
you can change the default remote address used by adding a line
.IP
.B "test-addr ="
.I remote-addr
.PP
before the first peer group section.  Secondly, you can specify a
particular
.I remote-addr
to use when checking whether a particular peer is applicable.
.PP
The peer definitions in each group are checked in the order given, and
searching stops as soon as a match is found.
.PP
Peers are connected using the
.BR connect (8)
service:
.IP
.B SVCSUBMIT connect active
.I peer
.SS "Command line"
In addition to the standard options described in
.BR tripe-service (7),
the following command-line options are recognized.
.TP
.BI "\-f, \-\-config=" file
Use
.I file
as the configuration file.  In the absence of this option, the
file named
.B conntrack.conf
in the current working directory is used instead.
.
.\"--------------------------------------------------------------------------
.SH "SERVICE COMMAND REFERENCE"
.
.\"* 10 Service commands
The commands provided by the service are as follows.
.SP
.BI "up " reason\fR...
Informs the service that the network connection has been established:
peer groups should be connected.  The
.I reason
is quoted in the status notification.
.SP
.BI "down " reason\fR...
Informs the service that the network connection has been lost:
peer groups should be disconnected.  The
.I reason
is quoted in the status notification.
.
.\"--------------------------------------------------------------------------
.SH "NOTIFICATIONS"
.
.\"* 30 Notification broadcasts (NOTE codes)
All notifications issued by
.B conntrack
begin with the tokens
.BR "USER conntrack" .
.SP
.BI "USER conntrack dbus-connection " status
The service's connection to D-Bus has changed state.  The
.I status
is one of the following.
.RS
.TP
.B startup
Initially trying to connect.
.TP
.B connected
Successfully established a connection to the bus.
.TP
.B lost
A connection has been lost.
.TP
.BI state= label
The service's internal state machine is confused.
.RE
.SP
.BI "USER conntrack " up \fR| down " " group = peer\fR... " " reason\fR...
The network connection has apparently gone up or down, and
.B conntrack
is about to kill and/or connect peers accordingly: for each group, the
selected peer is listed; if a group is not listed, then either the group
is to be brought down, or no matching peer was found.  The
.I reason
is one of the following.
.RS
.TP
.BI "connman initially-" state
ConnMan was detected on startup, and is in the given
.I state
\(en see below.
.TP
.BI "connman " state
ConnMan has transitioned to
.IR state .
The possible states are:
.B offline
(the network is turned off by user request);
.B idle
(no network interfaces are active);
.B ready
(an interface is up but not fully configured); and
.B online
(an interface is up and configured).
.TP
.BI "icd connected " iap
Maemo ICd has acquired an active network connection, identified by
.IR iap .
.TP
.B "icd idle"
Maemo ICd has lost its active network connection.
.TP
.BI "icd initially-connected " iap
Maemo ICd was detected on startup, and has an active network connection
identified by
.IR iap .
.TP
.B "icd initially-disconnected"
Maemo ICd was detected on startup, and has no active network connection.
.TP
.B interval-timer
A change was detected during
.BR conntrack 's
periodic status check.  This usually means that the network connection
was reconfigured manually without informing
.BR conntrack .
.TP
.BI "manual " reason\fR...
The connection status was changed manually, using the
.B up
or
.B down
service command.
.TP
.B "nm connected"
NetworkManager has acquired an active network connection.
.TP
.B "nm default-connection-change"
NetworkManager has changed its default route.
.TP
.B "nm disconnected"
NetworkManager has lost its active network connection.
.TP
.B "nm initially-connected"
NetworkManager was detected on startup, and has an active network
connection.
.TP
.B "nm initially-disconnected"
NetworkManager was detected on startup, and has no active network
connection.
.RE
.
.\"--------------------------------------------------------------------------
.SH "WARNINGS"
.
.\"* 40 Warning broadcasts (WARN codes)
All warnings issued by
.B conntrack
begin with the tokens
.BR "USER conntrack" .
.SP
.BI "USER conntrack config-file-error " exception " " error-text
The configuration file is invalid.  The
.I exception
token names a Python exception; the
.I error-text
describes the problem encountered, though it may not be very useful.
.SP
.BI "USER conntrack connect-failed " peer " " tokens\fR...
An attempt to connect the named
.I peer
failed; the error message is given by the
.IR tokens .
.
.\"--------------------------------------------------------------------------
.SH "SUMMARY"
.
.\"= summary
.
.\"--------------------------------------------------------------------------
.SH "SEE ALSO"
.
.BR tripe-service (7),
.BR peers.in (5),
.BR watch (8),
.BR tripe (8).
.
.\"--------------------------------------------------------------------------
.SH "AUTHOR"
.
Mark Wooding, <mdw@distorted.org.uk>
.
.\"----- That's all, folks --------------------------------------------------
Commit	Line	Data
2ec90437 MW	1	.\" --nroff--
	2	.\".
	3	.\" Manual for the conntrack service
	4	.\"
	5	.\" (c) 2010 Straylight/Edgeware
	6	.\"
	7	.
	8	.\"----- Licensing notice ---------------------------------------------------
	9	.\"
	10	.\" This file is part of Trivial IP Encryption (TrIPE).
	11	.\"
11ad66c2 MW	12	.\" TrIPE is free software: you can redistribute it and/or modify it under
	13	.\" the terms of the GNU General Public License as published by the Free
	14	.\" Software Foundation; either version 3 of the License, or (at your
	15	.\" option) any later version.
2ec90437	16	.\"
11ad66c2 MW	17	.\" TrIPE is distributed in the hope that it will be useful, but WITHOUT
	18	.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	19	.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	20	.\" for more details.
2ec90437 MW	21	.\"
2ec90437 MW	22	.\" You should have received a copy of the GNU General Public License
11ad66c2	23	.\" along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
2ec90437 MW	24	.
	25	.\"--------------------------------------------------------------------------
	26	.so ../common/defs.man \"@@@PRE@@@
	27	.
	28	.\"--------------------------------------------------------------------------
0647ba7c	29	.TH conntrack 8tripe "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
2ec90437 MW	30	.
	31	.\"--------------------------------------------------------------------------
	32	.SH "NAME"
	33	.
	34	conntrack \- tripe service to start/stop peers depending on external connectivity
	35	.
	36	.\"--------------------------------------------------------------------------
	37	.SH "SYNOPSIS"
	38	.
	39	.B conntrack
	40	.RB [ \-a
	41	.IR socket ]
	42	.RB [ \-d
	43	.IR dir ]
	44	.RB [ \-f
	45	.IR file ]
	46	.br
	47	\& \c
	48	.RB [ \-\-daemon ]
	49	.RB [ \-\-debug ]
	50	.RB [ \-\-startup ]
	51	.
	52	.\"--------------------------------------------------------------------------
	53	.SH "DESCRIPTION"
	54	.
	55	The
	56	.B conntrack
	57	service watches D-Bus network management services like
0f0cfd6d MW	58	.BR NetworkManager (8),
	59	.BR ConnMan
	60	.RB ( connmand (8)),
2ec90437 MW	61	and Nokia's
	62	.BR ICd ,
	63	bringing peers up and down automatically. It's designed to be useful on
	64	a mobile device, such as a laptop; I expect servers to stay where
	65	they're put and be configured statically.
	66	.SS "Configuration"
	67	The
	68	.B conntrack
	69	service reads a configuration file, by default
	70	.BR conntrack.conf ,
	71	explaining which peers to bring up under which circumstances. The
	72	configuration file is automatically re-read if it's changed.
	73	.PP
	74	The
	75	configuration is split into sections, each describing a
	76	.IR "peer group" .
	77	A section begins with the peer group name in square brackets:
	78	.IP
	79	.BI [ group ]
	80	.PP
	81	The group name is entirely arbitrary, and affects nothing else. This is
	82	followed by peer definitions, each of which looks like this:
	83	.IP
	84	.I tag
	85	.B =
	86	.RI [ remote-addr ]
	87	.IB network / mask
	88	.PP
	89	This means that the peer
	90	.I tag
	91	should be selected if the host's current IP address is within the
	92	network indicated by
	93	.IB network / mask \fR.
	94	Here,
	95	.I network
	96	is an IP address in dotted-quad form, and
	97	.I mask
	98	is a netmask, either in dotted-quad form, or as a number of 1-bits.
	99	Only one peer in each group may be connected at any given time; if a
	100	change is needed, any existing peer in the group is killed before
	101	connecting the new one. If no match is found in a particular group,
	102	then no peers in the group are connected. Strange and unhelpful things
	103	will happen if you put the same peer in several different groups.
	104	.PP
f2bdb96e MW	105	The tags
	106	.B down
	107	and
	108	.BI down/ anything
	109	are special and mean that no peer from the group should be active. This
	110	is useful for detecting a `home' network, where a VPN is unnecessary
	111	(or, worse, break routing completely).
	112	.PP
2ec90437 MW	113	The notion of `current IP address' is somewhat vague. The
	114	.B conntrack
	115	service calculates it as the source address that the host would put on
	116	an IP packet sent to an arbitrarily chosen remote address. The default
	117	remote address is 1.2.3.4 (which is unlikely ever to be assigned); this
	118	should determine an IP address on the network interface closest to the
	119	default gateway. You can influence this process in two ways. Firstly,
	120	you can change the default remote address used by adding a line
	121	.IP
	122	.B "test-addr ="
	123	.I remote-addr
	124	.PP
	125	before the first peer group section. Secondly, you can specify a
	126	particular
	127	.I remote-addr
	128	to use when checking whether a particular peer is applicable.
	129	.PP
f8204e50 MW	130	The peer definitions in each group are checked in the order given, and
f8204e50 MW	131	searching stops as soon as a match is found.
2ec90437 MW	132	.PP
	133	Peers are connected using the
	134	.BR connect (8)
	135	service:
	136	.IP
	137	.B SVCSUBMIT connect active
	138	.I peer
	139	.SS "Command line"
	140	In addition to the standard options described in
	141	.BR tripe-service (7),
	142	the following command-line options are recognized.
	143	.TP
	144	.BI "\-f, \-\-config=" file
	145	Use
	146	.I file
	147	as the configuration file. In the absence of this option, the
	148	file named
	149	.B conntrack.conf
	150	in the current working directory is used instead.
	151	.
	152	.\"--------------------------------------------------------------------------
	153	.SH "SERVICE COMMAND REFERENCE"
	154	.
	155	.\"* 10 Service commands
	156	The commands provided by the service are as follows.
	157	.SP
	158	.BI "up " reason\fR...
	159	Informs the service that the network connection has been established:
	160	peer groups should be connected. The
	161	.I reason
	162	is quoted in the status notification.
	163	.SP
	164	.BI "down " reason\fR...
	165	Informs the service that the network connection has been lost:
	166	peer groups should be disconnected. The
	167	.I reason
	168	is quoted in the status notification.
	169	.
	170	.\"--------------------------------------------------------------------------
	171	.SH "NOTIFICATIONS"
	172	.
	173	.\"* 30 Notification broadcasts (NOTE codes)
	174	All notifications issued by
	175	.B conntrack
	176	begin with the tokens
	177	.BR "USER conntrack" .
	178	.SP
75d9c6fd MW	179	.BI "USER conntrack dbus-connection " status
	180	The service's connection to D-Bus has changed state. The
	181	.I status
	182	is one of the following.
	183	.RS
	184	.TP
	185	.B startup
	186	Initially trying to connect.
	187	.TP
	188	.B connected
	189	Successfully established a connection to the bus.
	190	.TP
	191	.B lost
	192	A connection has been lost.
	193	.TP
	194	.BI state= label
	195	The service's internal state machine is confused.
56d0fa7e	196	.RE
75d9c6fd	197	.SP
2d4998c4	198	.BI "USER conntrack " up \fR\| down " " group = peer\fR... " " reason\fR...
2ec90437 MW	199	The network connection has apparently gone up or down, and
2ec90437 MW	200	.B conntrack
2d4998c4 MW	201	is about to kill and/or connect peers accordingly: for each group, the
	202	selected peer is listed; if a group is not listed, then either the group
	203	is to be brought down, or no matching peer was found. The
2ec90437 MW	204	.I reason
	205	is one of the following.
	206	.RS
	207	.TP
0f0cfd6d MW	208	.BI "connman initially-" state
	209	ConnMan was detected on startup, and is in the given
	210	.I state
	211	\(en see below.
	212	.TP
	213	.BI "connman " state
	214	ConnMan has transitioned to
	215	.IR state .
	216	The possible states are:
	217	.B offline
	218	(the network is turned off by user request);
	219	.B idle
	220	(no network interfaces are active);
	221	.B ready
	222	(an interface is up but not fully configured); and
	223	.B online
	224	(an interface is up and configured).
	225	.TP
43b89954 MW	226	.BI "icd connected " iap
	227	Maemo ICd has acquired an active network connection, identified by
	228	.IR iap .
2ec90437	229	.TP
43b89954 MW	230	.B "icd idle"
43b89954 MW	231	Maemo ICd has lost its active network connection.
2ec90437 MW	232	.TP
	233	.BI "icd initially-connected " iap
	234	Maemo ICd was detected on startup, and has an active network connection
	235	identified by
	236	.IR iap .
	237	.TP
	238	.B "icd initially-disconnected"
	239	Maemo ICd was detected on startup, and has no active network connection.
	240	.TP
2ec90437 MW	241	.B interval-timer
	242	A change was detected during
	243	.BR conntrack 's
	244	periodic status check. This usually means that the network connection
	245	was reconfigured manually without informing
	246	.BR conntrack .
	247	.TP
	248	.BI "manual " reason\fR...
	249	The connection status was changed manually, using the
	250	.B up
	251	or
	252	.B down
	253	service command.
43b89954 MW	254	.TP
	255	.B "nm connected"
	256	NetworkManager has acquired an active network connection.
	257	.TP
	258	.B "nm default-connection-change"
	259	NetworkManager has changed its default route.
	260	.TP
	261	.B "nm disconnected"
	262	NetworkManager has lost its active network connection.
	263	.TP
	264	.B "nm initially-connected"
	265	NetworkManager was detected on startup, and has an active network
	266	connection.
	267	.TP
	268	.B "nm initially-disconnected"
	269	NetworkManager was detected on startup, and has no active network
	270	connection.
2ec90437 MW	271	.RE
	272	.
	273	.\"--------------------------------------------------------------------------
	274	.SH "WARNINGS"
	275	.
	276	.\"* 40 Warning broadcasts (WARN codes)
	277	All warnings issued by
	278	.B conntrack
	279	begin with the tokens
	280	.BR "USER conntrack" .
	281	.SP
	282	.BI "USER conntrack config-file-error " exception " " error-text
	283	The configuration file is invalid. The
	284	.I exception
	285	token names a Python exception; the
	286	.I error-text
	287	describes the problem encountered, though it may not be very useful.
cf2e4ea6 MW	288	.SP
	289	.BI "USER conntrack connect-failed " peer " " tokens\fR...
	290	An attempt to connect the named
	291	.I peer
	292	failed; the error message is given by the
	293	.IR tokens .
2ec90437 MW	294	.
	295	.\"--------------------------------------------------------------------------
	296	.SH "SUMMARY"
	297	.
	298	.\"= summary
	299	.
	300	.\"--------------------------------------------------------------------------
	301	.SH "SEE ALSO"
	302	.
	303	.BR tripe-service (7),
	304	.BR peers.in (5),
	305	.BR watch (8),
	306	.BR tripe (8).
	307	.
	308	.\"--------------------------------------------------------------------------
	309	.SH "AUTHOR"
	310	.
	311	Mark Wooding, <mdw@distorted.org.uk>
	312	.
	313	.\"----- That's all, folks --------------------------------------------------