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 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.
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
22 .\" You should have received a copy of the GNU General Public License
23 .\" along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
25 .\"--------------------------------------------------------------------------
26 .so ../common/defs.man \"@@@PRE@@@
28 .\"--------------------------------------------------------------------------
29 .TH tripe-ifup 8tripe "20 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
31 .\"--------------------------------------------------------------------------
34 tripe-ifup \- configure VPN network interfaces and routes
36 .\"--------------------------------------------------------------------------
45 .\"--------------------------------------------------------------------------
50 program configures network interfaces and routes for
52 It expects a number of values to be passed as environment variables. It
53 is usually invoked by the
55 service, which provides values for these environment variables by
56 consulting the peer database
58 These parameters are therefore described in terms of their keys in the
59 peer's database record; the corresponding environment variable name is
60 formed by converting letters to uppercase and prefixing with
63 The command-line arguments are as follows.
66 The name of the peer, as known to the
68 server and various services. This is used to notify the server of
69 changes, and to announce final success.
72 The current name of the interface, as known to the kernel.
74 .IR address-family " and " addr
75 The address, in the format described in
79 address family is supported.
81 In the following, a name in
83 is used to represent the value of the correspondingly named key in the
84 peer's record. For example,then
86 denotes the value assigned to the
92 The network interface is configured as follows.
94 The network interface name is set. If
96 is set, then the network interface is renamed to
100 command is issued to keep the server informed. Further configuration is
101 performed using the new interface name.
103 Configure the interface addresses. If
105 is set, it should be a space-separated list of IPv4 and IPv6 addresses
106 with optional prefix lengths; there may be any number of either. If
108 is set, it should be a list IPv4 and/or an IPv6 addresses, with optional
109 prefix lengths, separated by space: these are the addresses to
110 configure as the remote end point of the point-to-point link. (Further
111 remote addresses can be configured as host routes: see below.) IPv4
112 addresses are expected to be in dotted-quad form; IPv6 addresses should
113 be in RFC4291 hex-and-colons form.
115 Establish routes. If addresses were configured, and
119 is split into space-separated networks. For each network, of the form
120 .IB address / mask \fR,
121 a route is configured to the given network, via the remote address of
122 the link, over the tunnel interface. The
124 may be IPv4 or IPv6 addresses. If the interface has only an IPv4
125 address then IPv6 routes will be ignored, and
129 If any configuration commands fail, a warning
131 .B USER tripe-ifup command-failed
138 Configure the interface MTU and bring it up. The
139 interface MTU is configured based on the path MTU to the peer's external
140 address and the cryptographic algorithms in use by the
142 server; this can be overridden by setting the
148 is set, it is interpreted as a Bourne shell command and evaluated.
150 Notify services. A notification
153 .B USER tripe-ifup configured
159 token is included if any of the configuration commands failed.
162 .\"--------------------------------------------------------------------------
169 .\"--------------------------------------------------------------------------
172 Mark Wooding, <mdw@distorted.org.uk>
174 .\"----- That's all, folks --------------------------------------------------