3 .\" Manual for the watch service
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 tripe-ifup 8tripe "20 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripe-ifup \- configure VPN network interfaces and routes
37 .\"--------------------------------------------------------------------------
46 .\"--------------------------------------------------------------------------
51 program configures network interfaces and routes for
53 It expects a number of values to be passed as environment variables. It
54 is usually invoked by the
56 service, which provides values for these environment variables by
57 consulting the peer database
59 These parameters are therefore described in terms of their keys in the
60 peer's database record; the corresponding environment variable name is
61 formed by converting letters to uppercase and prefixing with
64 The command-line arguments are as follows.
67 The name of the peer, as known to the
69 server and various services. This is used to notify the server of
70 changes, and to announce final success.
73 The current name of the interface, as known to the kernel.
75 .IR address-family " and " addr
76 The address, in the format described in
80 address family is supported.
82 In the following, a name in
84 is used to represent the value of the correspondingly named key in the
85 peer's record. For example,then
87 denotes the value assigned to the
93 The network interface is configured as follows.
95 The network interface name is set. If
97 is set, then the network interface is renamed to
101 command is issued to keep the server informed. Further configuration is
102 performed using the new interface name.
104 Configure the interface addresses. If
106 is set, it should be a space-separated list of IPv4 and IPv6 addresses
107 with optional prefix lengths; there may be any number of either. If
109 is set, it should be a list IPv4 and/or an IPv6 addresses, with optional
110 prefix lengths, separated by space: these are the addresses to
111 configure as the remote end point of the point-to-point link. (Further
112 remote addresses can be configured as host routes: see below.) IPv4
113 addresses are expected to be in dotted-quad form; IPv6 addresses should
114 be in RFC4291 hex-and-colons form.
116 Establish routes. If addresses were configured, and
120 is split into space-separated networks. For each network, of the form
121 .IB address / mask \fR,
122 a route is configured to the given network, via the remote address of
123 the link, over the tunnel interface. The
125 may be IPv4 or IPv6 addresses. If the interface has only an IPv4
126 address then IPv6 routes will be ignored, and
130 If any configuration commands fail, a warning
132 .B USER tripe-ifup command-failed
139 Configure the interface MTU and bring it up. The
140 interface MTU is configured based on the path MTU to the peer's external
141 address and the cryptographic algorithms in use by the
143 server; this can be overridden by setting the
149 is set, it is interpreted as a Bourne shell command and evaluated.
151 Notify services. A notification
154 .B USER tripe-ifup configured
160 token is included if any of the configuration commands failed.
163 .\"--------------------------------------------------------------------------
170 .\"--------------------------------------------------------------------------
173 Mark Wooding, <mdw@distorted.org.uk>
175 .\"----- That's all, folks --------------------------------------------------