| 1 |
root |
1.13 |
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) |
| 2 |
pcg |
1.1 |
.\" |
| 3 |
|
|
.\" Standard preamble: |
| 4 |
|
|
.\" ======================================================================== |
| 5 |
|
|
.de Sp \" Vertical space (when we can't use .PP) |
| 6 |
|
|
.if t .sp .5v |
| 7 |
|
|
.if n .sp |
| 8 |
|
|
.. |
| 9 |
|
|
.de Vb \" Begin verbatim text |
| 10 |
|
|
.ft CW |
| 11 |
|
|
.nf |
| 12 |
|
|
.ne \\$1 |
| 13 |
|
|
.. |
| 14 |
|
|
.de Ve \" End verbatim text |
| 15 |
|
|
.ft R |
| 16 |
|
|
.fi |
| 17 |
|
|
.. |
| 18 |
|
|
.\" Set up some character translations and predefined strings. \*(-- will |
| 19 |
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 20 |
pcg |
1.10 |
.\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 21 |
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 22 |
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 23 |
|
|
.\" nothing in troff, for use with C<>. |
| 24 |
|
|
.tr \(*W- |
| 25 |
pcg |
1.1 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 26 |
|
|
.ie n \{\ |
| 27 |
|
|
. ds -- \(*W- |
| 28 |
|
|
. ds PI pi |
| 29 |
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 30 |
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 31 |
|
|
. ds L" "" |
| 32 |
|
|
. ds R" "" |
| 33 |
|
|
. ds C` |
| 34 |
|
|
. ds C' |
| 35 |
|
|
'br\} |
| 36 |
|
|
.el\{\ |
| 37 |
|
|
. ds -- \|\(em\| |
| 38 |
|
|
. ds PI \(*p |
| 39 |
|
|
. ds L" `` |
| 40 |
|
|
. ds R" '' |
| 41 |
root |
1.13 |
. ds C` |
| 42 |
|
|
. ds C' |
| 43 |
pcg |
1.1 |
'br\} |
| 44 |
|
|
.\" |
| 45 |
pcg |
1.10 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 46 |
|
|
.ie \n(.g .ds Aq \(aq |
| 47 |
|
|
.el .ds Aq ' |
| 48 |
|
|
.\" |
| 49 |
pcg |
1.1 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
| 50 |
root |
1.12 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 51 |
pcg |
1.1 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 52 |
|
|
.\" output yourself in some meaningful fashion. |
| 53 |
root |
1.13 |
.\" |
| 54 |
|
|
.\" Avoid warning from groff about undefined register 'F'. |
| 55 |
|
|
.de IX |
| 56 |
pcg |
1.1 |
.. |
| 57 |
root |
1.13 |
.nr rF 0 |
| 58 |
|
|
.if \n(.g .if rF .nr rF 1 |
| 59 |
|
|
.if (\n(rF:(\n(.g==0)) \{ |
| 60 |
|
|
. if \nF \{ |
| 61 |
|
|
. de IX |
| 62 |
|
|
. tm Index:\\$1\t\\n%\t"\\$2" |
| 63 |
pcg |
1.10 |
.. |
| 64 |
root |
1.13 |
. if !\nF==2 \{ |
| 65 |
|
|
. nr % 0 |
| 66 |
|
|
. nr F 2 |
| 67 |
|
|
. \} |
| 68 |
|
|
. \} |
| 69 |
pcg |
1.10 |
.\} |
| 70 |
root |
1.13 |
.rr rF |
| 71 |
pcg |
1.1 |
.\" |
| 72 |
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 73 |
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 74 |
|
|
. \" fudge factors for nroff and troff |
| 75 |
|
|
.if n \{\ |
| 76 |
|
|
. ds #H 0 |
| 77 |
|
|
. ds #V .8m |
| 78 |
|
|
. ds #F .3m |
| 79 |
|
|
. ds #[ \f1 |
| 80 |
|
|
. ds #] \fP |
| 81 |
|
|
.\} |
| 82 |
|
|
.if t \{\ |
| 83 |
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 84 |
|
|
. ds #V .6m |
| 85 |
|
|
. ds #F 0 |
| 86 |
|
|
. ds #[ \& |
| 87 |
|
|
. ds #] \& |
| 88 |
|
|
.\} |
| 89 |
|
|
. \" simple accents for nroff and troff |
| 90 |
|
|
.if n \{\ |
| 91 |
|
|
. ds ' \& |
| 92 |
|
|
. ds ` \& |
| 93 |
|
|
. ds ^ \& |
| 94 |
|
|
. ds , \& |
| 95 |
|
|
. ds ~ ~ |
| 96 |
|
|
. ds / |
| 97 |
|
|
.\} |
| 98 |
|
|
.if t \{\ |
| 99 |
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 100 |
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 101 |
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 102 |
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 103 |
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 104 |
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 105 |
|
|
.\} |
| 106 |
|
|
. \" troff and (daisy-wheel) nroff accents |
| 107 |
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 108 |
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 109 |
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 110 |
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 111 |
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 112 |
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 113 |
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 114 |
|
|
.ds ae a\h'-(\w'a'u*4/10)'e |
| 115 |
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 116 |
|
|
. \" corrections for vroff |
| 117 |
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 118 |
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 119 |
|
|
. \" for low resolution devices (crt and lpr) |
| 120 |
|
|
.if \n(.H>23 .if \n(.V>19 \ |
| 121 |
|
|
\{\ |
| 122 |
|
|
. ds : e |
| 123 |
|
|
. ds 8 ss |
| 124 |
|
|
. ds o a |
| 125 |
|
|
. ds d- d\h'-1'\(ga |
| 126 |
|
|
. ds D- D\h'-1'\(hy |
| 127 |
|
|
. ds th \o'bp' |
| 128 |
|
|
. ds Th \o'LP' |
| 129 |
|
|
. ds ae ae |
| 130 |
|
|
. ds Ae AE |
| 131 |
|
|
.\} |
| 132 |
|
|
.rm #[ #] #H #V #F C |
| 133 |
|
|
.\" ======================================================================== |
| 134 |
|
|
.\" |
| 135 |
|
|
.IX Title "GVPE 5" |
| 136 |
root |
1.14 |
.TH GVPE 5 "2016-11-02" "2.25" "GNU Virtual Private Ethernet" |
| 137 |
pcg |
1.10 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 138 |
|
|
.\" way too many mistakes in technical documents. |
| 139 |
|
|
.if n .ad l |
| 140 |
|
|
.nh |
| 141 |
pcg |
1.1 |
.SH "NAME" |
| 142 |
|
|
GNU\-VPE \- Overview of the GNU Virtual Private Ethernet suite. |
| 143 |
|
|
.SH "DESCRIPTION" |
| 144 |
|
|
.IX Header "DESCRIPTION" |
| 145 |
|
|
\&\s-1GVPE\s0 is a suite designed to provide a virtual private network for multiple |
| 146 |
pcg |
1.5 |
nodes over an untrusted network. This document first gives an introduction |
| 147 |
root |
1.13 |
to VPNs in general and then describes the specific implementation of \s-1GVPE.\s0 |
| 148 |
|
|
.SS "\s-1WHAT IS A VPN\s0?" |
| 149 |
pcg |
1.5 |
.IX Subsection "WHAT IS A VPN?" |
| 150 |
|
|
\&\s-1VPN\s0 is an acronym, it stands for: |
| 151 |
pcg |
1.11 |
.IP "Virtual" 4 |
| 152 |
|
|
.IX Item "Virtual" |
| 153 |
pcg |
1.5 |
Virtual means that no physical network is created (of course), but a |
| 154 |
|
|
network is \fIemulated\fR by creating multiple tunnels between the member |
| 155 |
|
|
nodes by encapsulating and sending data over another transport network. |
| 156 |
|
|
.Sp |
| 157 |
|
|
Usually the emulated network is a normal \s-1IP\s0 or Ethernet, and the transport |
| 158 |
|
|
network is the Internet. However, using a \s-1VPN\s0 system like \s-1GVPE\s0 to connect |
| 159 |
|
|
nodes over other untrusted networks such as Wireless \s-1LAN\s0 is not uncommon. |
| 160 |
pcg |
1.11 |
.IP "Private" 4 |
| 161 |
|
|
.IX Item "Private" |
| 162 |
pcg |
1.3 |
Private means that non-participating nodes cannot decode (\*(L"sniff)\*(R" nor |
| 163 |
pcg |
1.5 |
inject (\*(L"spoof\*(R") packets. This means that nodes can be connected over |
| 164 |
|
|
untrusted networks such as the public Internet without fear of being |
| 165 |
|
|
eavesdropped while at the same time being able to trust data sent by other |
| 166 |
|
|
nodes. |
| 167 |
pcg |
1.3 |
.Sp |
| 168 |
root |
1.13 |
In the case of \s-1GVPE,\s0 even participating nodes cannot sniff packets |
| 169 |
pcg |
1.5 |
send to other nodes or spoof packets as if sent from other nodes, so |
| 170 |
|
|
communications between any two nodes is private to those two nodes. |
| 171 |
pcg |
1.11 |
.IP "Network" 4 |
| 172 |
|
|
.IX Item "Network" |
| 173 |
pcg |
1.3 |
Network means that more than two parties can participate in the network, |
| 174 |
|
|
so for instance it's possible to connect multiple branches of a company |
| 175 |
root |
1.13 |
into a single network. Many so-called \*(L"\s-1VPN\*(R"\s0 solutions only create |
| 176 |
pcg |
1.5 |
point-to-point tunnels, which in turn can be used to build larger |
| 177 |
|
|
networks. |
| 178 |
|
|
.Sp |
| 179 |
pcg |
1.10 |
\&\s-1GVPE\s0 provides a true multi-point network in which any number of nodes (at |
| 180 |
pcg |
1.5 |
least a few dozen in practise, the theoretical limit is 4095 nodes) can |
| 181 |
|
|
participate. |
| 182 |
root |
1.13 |
.SS "\s-1GVPE DESIGN GOALS\s0" |
| 183 |
pcg |
1.5 |
.IX Subsection "GVPE DESIGN GOALS" |
| 184 |
root |
1.13 |
.IP "\s-1SIMPLE DESIGN\s0" 4 |
| 185 |
pcg |
1.1 |
.IX Item "SIMPLE DESIGN" |
| 186 |
|
|
Cipher, \s-1HMAC\s0 algorithms and other key parameters must be selected |
| 187 |
|
|
at compile time \- this makes it possible to only link in algorithms |
| 188 |
|
|
you actually need. It also makes the crypto part of the source very |
| 189 |
pcg |
1.5 |
transparent and easy to inspect, and last not least this makes it possible |
| 190 |
|
|
to hardcode the layout of all packets into the binary. \s-1GVPE\s0 goes a step |
| 191 |
|
|
further and internally reserves blocks of the same length for all packets, |
| 192 |
|
|
which virtually removes all possibilities of buffer overflows, as there is |
| 193 |
|
|
only a single type of buffer and it's always of fixed length. |
| 194 |
root |
1.13 |
.IP "\s-1EASY TO SETUP\s0" 4 |
| 195 |
pcg |
1.1 |
.IX Item "EASY TO SETUP" |
| 196 |
|
|
A few lines of config (the config file is shared unmodified between all |
| 197 |
root |
1.14 |
hosts) and generating an \s-1RSA\s0 key-pair on each node suffices to make it |
| 198 |
|
|
work. |
| 199 |
pcg |
1.1 |
.IP "MAC-BASED \s-1SECURITY\s0" 4 |
| 200 |
|
|
.IX Item "MAC-BASED SECURITY" |
| 201 |
|
|
Since every host has it's own private key, other hosts cannot spoof |
| 202 |
|
|
traffic from this host. That makes it possible to filter packet by \s-1MAC\s0 |
| 203 |
|
|
address, e.g. to ensure that packets from a specific \s-1IP\s0 address come, in |
| 204 |
|
|
fact, from a specific host that is associated with that \s-1IP\s0 and not from |
| 205 |
|
|
another host. |
| 206 |
|
|
.SH "PROGRAMS" |
| 207 |
|
|
.IX Header "PROGRAMS" |
| 208 |
pcg |
1.10 |
Gvpe comes with two programs: one daemon (\f(CW\*(C`gvpe\*(C'\fR) and one control program |
| 209 |
pcg |
1.1 |
(\f(CW\*(C`gvpectrl\*(C'\fR). |
| 210 |
|
|
.IP "gvpectrl" 4 |
| 211 |
|
|
.IX Item "gvpectrl" |
| 212 |
pcg |
1.10 |
This program is used to generate the keys, check and give an overview of of the |
| 213 |
|
|
configuration and to control the daemon (restarting etc.). |
| 214 |
pcg |
1.1 |
.IP "gvpe" 4 |
| 215 |
|
|
.IX Item "gvpe" |
| 216 |
pcg |
1.10 |
This is the daemon used to establish and maintain connections to the other |
| 217 |
|
|
network nodes. It should be run on the gateway of each \s-1VPN\s0 subnet. |
| 218 |
pcg |
1.1 |
.SH "COMPILETIME CONFIGURATION" |
| 219 |
|
|
.IX Header "COMPILETIME CONFIGURATION" |
| 220 |
|
|
Please have a look at the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific |
| 221 |
|
|
information. |
| 222 |
|
|
.PP |
| 223 |
pcg |
1.10 |
Gvpe hardcodes most encryption parameters. While this reduces flexibility, |
| 224 |
|
|
it makes the program much simpler and helps making buffer overflows |
| 225 |
|
|
impossible under most circumstances. |
| 226 |
|
|
.PP |
| 227 |
pcg |
1.4 |
Here are a few recipes for compiling your gvpe, showing the extremes |
| 228 |
pcg |
1.10 |
(fast, small, insecure \s-1OR\s0 slow, large, more secure), between which you |
| 229 |
|
|
should choose: |
| 230 |
root |
1.13 |
.SS "\s-1AS LOW PACKET OVERHEAD AS POSSIBLE\s0" |
| 231 |
pcg |
1.1 |
.IX Subsection "AS LOW PACKET OVERHEAD AS POSSIBLE" |
| 232 |
|
|
.Vb 1 |
| 233 |
pcg |
1.10 |
\& ./configure \-\-enable\-hmac\-length=4 \-\-enable\-rand\-length=0 |
| 234 |
pcg |
1.1 |
.Ve |
| 235 |
|
|
.PP |
| 236 |
pcg |
1.4 |
Minimize the header overhead of \s-1VPN\s0 packets (the above will result in |
| 237 |
|
|
only 4 bytes of overhead over the raw ethernet frame). This is a insecure |
| 238 |
root |
1.12 |
configuration because a \s-1HMAC\s0 length of 4 makes collision attacks almost |
| 239 |
|
|
trivial. |
| 240 |
root |
1.13 |
.SS "\s-1MINIMIZE CPU TIME REQUIRED\s0" |
| 241 |
pcg |
1.1 |
.IX Subsection "MINIMIZE CPU TIME REQUIRED" |
| 242 |
|
|
.Vb 1 |
| 243 |
pcg |
1.10 |
\& ./configure \-\-enable\-cipher=bf \-\-enable\-digest=md4 |
| 244 |
pcg |
1.1 |
.Ve |
| 245 |
|
|
.PP |
| 246 |
pcg |
1.4 |
Use the fastest cipher and digest algorithms currently available in |
| 247 |
pcg |
1.10 |
gvpe. \s-1MD4\s0 has been broken and is quite insecure, though, so using another |
| 248 |
|
|
digest algorithm is recommended. |
| 249 |
root |
1.13 |
.SS "\s-1MAXIMIZE SECURITY\s0" |
| 250 |
pcg |
1.1 |
.IX Subsection "MAXIMIZE SECURITY" |
| 251 |
|
|
.Vb 1 |
| 252 |
root |
1.12 |
\& ./configure \-\-enable\-hmac\-length=16 \-\-enable\-rand\-length=12 \-\-enable\-digest=ripemd610 |
| 253 |
pcg |
1.1 |
.Ve |
| 254 |
|
|
.PP |
| 255 |
|
|
This uses a 16 byte \s-1HMAC\s0 checksum to authenticate packets (I guess 8\-12 |
| 256 |
|
|
would also be pretty secure ;) and will additionally prefix each packet |
| 257 |
root |
1.12 |
with 12 bytes of random data. |
| 258 |
pcg |
1.1 |
.PP |
| 259 |
pcg |
1.10 |
In general, remember that \s-1AES\-128\s0 seems to be as secure but faster than |
| 260 |
root |
1.13 |
\&\s-1AES\-192\s0 or \s-1AES\-256,\s0 more randomness helps against sniffing and a longer |
| 261 |
|
|
\&\s-1HMAC\s0 helps against spoofing. \s-1MD4\s0 is a fast digest, \s-1SHA1, RIPEMD160, SHA256\s0 |
| 262 |
pcg |
1.10 |
are consecutively better, and Blowfish is a fast cipher (and also quite |
| 263 |
|
|
secure). |
| 264 |
pcg |
1.1 |
.SH "HOW TO SET UP A SIMPLE VPN" |
| 265 |
|
|
.IX Header "HOW TO SET UP A SIMPLE VPN" |
| 266 |
|
|
In this section I will describe how to get a simple \s-1VPN\s0 consisting of |
| 267 |
|
|
three hosts up and running. |
| 268 |
root |
1.13 |
.SS "\s-1STEP 1:\s0 configuration" |
| 269 |
pcg |
1.1 |
.IX Subsection "STEP 1: configuration" |
| 270 |
pcg |
1.10 |
First you have to create a daemon configuration file and put it into the |
| 271 |
pcg |
1.1 |
configuration directory. This is usually \f(CW\*(C`/etc/gvpe\*(C'\fR, depending on how you |
| 272 |
pcg |
1.10 |
configured gvpe, and can be overwritten using the \f(CW\*(C`\-c\*(C'\fR command line switch. |
| 273 |
pcg |
1.1 |
.PP |
| 274 |
|
|
Put the following lines into \f(CW\*(C`/etc/gvpe/gvpe.conf\*(C'\fR: |
| 275 |
|
|
.PP |
| 276 |
|
|
.Vb 3 |
| 277 |
pcg |
1.10 |
\& udp\-port = 50000 # the external port to listen on (configure your firewall) |
| 278 |
pcg |
1.1 |
\& mtu = 1400 # minimum MTU of all outgoing interfaces on all hosts |
| 279 |
|
|
\& ifname = vpn0 # the local network device name |
| 280 |
pcg |
1.10 |
\& |
| 281 |
pcg |
1.1 |
\& node = first # just a nickname |
| 282 |
|
|
\& hostname = first.example.net # the DNS name or IP address of the host |
| 283 |
pcg |
1.10 |
\& |
| 284 |
pcg |
1.1 |
\& node = second |
| 285 |
|
|
\& hostname = 133.55.82.9 |
| 286 |
pcg |
1.10 |
\& |
| 287 |
pcg |
1.1 |
\& node = third |
| 288 |
|
|
\& hostname = third.example.net |
| 289 |
|
|
.Ve |
| 290 |
|
|
.PP |
| 291 |
pcg |
1.10 |
The only other file necessary is the \f(CW\*(C`if\-up\*(C'\fR script that initializes the |
| 292 |
|
|
virtual ethernet interface on the local host. Put the following lines into |
| 293 |
|
|
\&\f(CW\*(C`/etc/gvpe/if\-up\*(C'\fR and make it executable (\f(CW\*(C`chmod 755 /etc/gvpe/if\-up\*(C'\fR): |
| 294 |
pcg |
1.1 |
.PP |
| 295 |
|
|
.Vb 6 |
| 296 |
|
|
\& #!/bin/sh |
| 297 |
|
|
\& ip link set $IFNAME address $MAC mtu $MTU up |
| 298 |
|
|
\& [ $NODENAME = first ] && ip addr add 10.0.1.1 dev $IFNAME |
| 299 |
|
|
\& [ $NODENAME = second ] && ip addr add 10.0.2.1 dev $IFNAME |
| 300 |
|
|
\& [ $NODENAME = third ] && ip addr add 10.0.3.1 dev $IFNAME |
| 301 |
|
|
\& ip route add 10.0.0.0/16 dev $IFNAME |
| 302 |
|
|
.Ve |
| 303 |
|
|
.PP |
| 304 |
|
|
This script will give each node a different \s-1IP\s0 address in the \f(CW\*(C`10.0/16\*(C'\fR |
| 305 |
pcg |
1.10 |
network. The internal network (if gvpe runs on a router) should then be |
| 306 |
pcg |
1.1 |
set to a subset of that network, e.g. \f(CW\*(C`10.0.1.0/24\*(C'\fR on node \f(CW\*(C`first\*(C'\fR, |
| 307 |
|
|
\&\f(CW\*(C`10.0.2.0/24\*(C'\fR on node \f(CW\*(C`second\*(C'\fR, and so on. |
| 308 |
|
|
.PP |
| 309 |
|
|
By enabling routing on the gateway host that runs \f(CW\*(C`gvpe\*(C'\fR all nodes will |
| 310 |
pcg |
1.10 |
be able to reach the other nodes. You can, of course, also use proxy \s-1ARP\s0 |
| 311 |
|
|
or other means of pseudo-bridging, or (best) full routing \- the choice is |
| 312 |
|
|
yours. |
| 313 |
root |
1.14 |
.SS "\s-1STEP 2:\s0 create the \s-1RSA\s0 key pair for each node" |
| 314 |
|
|
.IX Subsection "STEP 2: create the RSA key pair for each node" |
| 315 |
|
|
Next you have to generate the \s-1RSA\s0 keys for the nodes. While you can set |
| 316 |
|
|
up \s-1GVPE\s0 so you can generate all keys on a single host and centrally |
| 317 |
|
|
distribute all keys, it is safer to generate the key for each node on the |
| 318 |
|
|
node, so that the secret/private key does not have to be copied over the |
| 319 |
|
|
network. |
| 320 |
|
|
.PP |
| 321 |
|
|
To do so, run the following command to generate a key pair: |
| 322 |
pcg |
1.1 |
.PP |
| 323 |
|
|
.Vb 1 |
| 324 |
root |
1.14 |
\& gvpectrl \-c /etc/gvpe \-g nodekey |
| 325 |
pcg |
1.1 |
.Ve |
| 326 |
|
|
.PP |
| 327 |
root |
1.14 |
This will create two files, \fInodekey\fR and \fInodekey.privkey\fR. The former |
| 328 |
|
|
should be copied to \fI/etc/gvpe/pubkey/\fInodename\fI\fR on the host where |
| 329 |
|
|
your config file is (you will have to create the \fIpubkey\fR directory |
| 330 |
|
|
first): |
| 331 |
pcg |
1.10 |
.PP |
| 332 |
root |
1.14 |
.Vb 1 |
| 333 |
|
|
\& scp nodekey confighost:/etc/gvpe/pubkey/nodename |
| 334 |
|
|
.Ve |
| 335 |
pcg |
1.1 |
.PP |
| 336 |
root |
1.14 |
The private key \fInodekey.privkey\fR should be moved to \fI/etc/gvpe/hostkey\fR: |
| 337 |
pcg |
1.1 |
.PP |
| 338 |
root |
1.14 |
.Vb 2 |
| 339 |
|
|
\& mkdir \-p /etc/gvpe |
| 340 |
|
|
\& mv nodekey.privkey /etc/gvpe/hostkey |
| 341 |
pcg |
1.1 |
.Ve |
| 342 |
root |
1.14 |
.SS "\s-1STEP 3:\s0 distribute the config files to all nodes" |
| 343 |
|
|
.IX Subsection "STEP 3: distribute the config files to all nodes" |
| 344 |
|
|
Now distribute the config files and public keys to the other nodes. |
| 345 |
pcg |
1.1 |
.PP |
| 346 |
root |
1.14 |
The example uses rsync-over-ssh to copy the config file and all the public |
| 347 |
|
|
keys: |
| 348 |
pcg |
1.1 |
.PP |
| 349 |
|
|
.Vb 3 |
| 350 |
root |
1.14 |
\& rsync \-avzessh /etc/gvpe first.example.net:/etc/. \-\-exclude hostkey |
| 351 |
|
|
\& rsync \-avzessh /etc/gvpe 133.55.82.9:/etc/. \-\-exclude hostkey |
| 352 |
|
|
\& rsync \-avzessh /etc/gvpe third.example.net:/etc/. \-\-exclude hostkey |
| 353 |
pcg |
1.1 |
.Ve |
| 354 |
|
|
.PP |
| 355 |
root |
1.14 |
You should now check the configuration by issuing the command \f(CW\*(C`gvpectrl |
| 356 |
|
|
\&\-c /etc/gvpe \-s\*(C'\fR on each node and verify it's output. |
| 357 |
root |
1.13 |
.SS "\s-1STEP 4:\s0 starting gvpe" |
| 358 |
pcg |
1.1 |
.IX Subsection "STEP 4: starting gvpe" |
| 359 |
|
|
You should then start gvpe on each node by issuing a command like: |
| 360 |
|
|
.PP |
| 361 |
|
|
.Vb 1 |
| 362 |
pcg |
1.10 |
\& gvpe \-D \-l info first # first is the nodename |
| 363 |
pcg |
1.1 |
.Ve |
| 364 |
|
|
.PP |
| 365 |
pcg |
1.10 |
This will make the gvpe daemon stay in foreground. You should then see |
| 366 |
pcg |
1.1 |
\&\*(L"connection established\*(R" messages. If you don't see them check your |
| 367 |
|
|
firewall and routing (use tcpdump ;). |
| 368 |
|
|
.PP |
| 369 |
|
|
If this works you should check your networking setup by pinging various |
| 370 |
|
|
endpoints. |
| 371 |
|
|
.PP |
| 372 |
pcg |
1.10 |
To make gvpe run more permanently you can either run it as a daemon (by |
| 373 |
|
|
starting it without the \f(CW\*(C`\-D\*(C'\fR switch), or, much better, from your inittab |
| 374 |
|
|
or equivalent. I use a line like this on all my systems: |
| 375 |
pcg |
1.1 |
.PP |
| 376 |
|
|
.Vb 1 |
| 377 |
pcg |
1.10 |
\& t1:2345:respawn:/opt/gvpe/sbin/gvpe \-D \-L first >/dev/null 2>&1 |
| 378 |
pcg |
1.1 |
.Ve |
| 379 |
root |
1.13 |
.SS "\s-1STEP 5:\s0 enjoy" |
| 380 |
pcg |
1.1 |
.IX Subsection "STEP 5: enjoy" |
| 381 |
|
|
\&... and play around. Sending a \-HUP (\f(CW\*(C`gvpectrl \-kHUP\*(C'\fR) to the daemon |
| 382 |
|
|
will make it try to connect to all other nodes again. If you run it from |
| 383 |
root |
1.14 |
inittab \f(CW\*(C`gvpectrl \-k\*(C'\fR (or simply \f(CW\*(C`killall gvpe\*(C'\fR) will kill the daemon, |
| 384 |
|
|
start it again, making it read it's configuration files again. |
| 385 |
|
|
.PP |
| 386 |
|
|
To run the \s-1GVPE\s0 daemon permanently from your SysV init, you can add it to |
| 387 |
|
|
your \fIinittab\fR, e.g.: |
| 388 |
|
|
.PP |
| 389 |
|
|
.Vb 1 |
| 390 |
|
|
\& t1:2345:respawn:/bin/sh \-c "exec nice \-n\-20 /path/to/gvpe \-D node >/var/log/gvpe.log 2>&1" |
| 391 |
|
|
.Ve |
| 392 |
|
|
.PP |
| 393 |
|
|
For systems using systemd, you can use a unit file similar to this one: |
| 394 |
|
|
.PP |
| 395 |
|
|
.Vb 4 |
| 396 |
|
|
\& [Unit] |
| 397 |
|
|
\& Description=gvpe |
| 398 |
|
|
\& After=network.target |
| 399 |
|
|
\& Before=remote\-fs.target |
| 400 |
|
|
\& |
| 401 |
|
|
\& [Service] |
| 402 |
|
|
\& ExecStart=/path/to/gvpe \-D node |
| 403 |
|
|
\& KillMode=process |
| 404 |
|
|
\& Restart=always |
| 405 |
|
|
\& |
| 406 |
|
|
\& [Install] |
| 407 |
|
|
\& WantedBy=multi\-user.target |
| 408 |
|
|
.Ve |
| 409 |
pcg |
1.1 |
.SH "SEE ALSO" |
| 410 |
|
|
.IX Header "SEE ALSO" |
| 411 |
pcg |
1.10 |
\&\fIgvpe.osdep\fR\|(5) for OS-dependent information, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8), |
| 412 |
pcg |
1.6 |
and for a description of the transports, protocol, and routing algorithm, |
| 413 |
|
|
\&\fIgvpe.protocol\fR\|(7). |
| 414 |
pcg |
1.7 |
.PP |
| 415 |
pcg |
1.10 |
The \s-1GVPE\s0 mailing list, at <http://lists.schmorp.de/>, or |
| 416 |
pcg |
1.7 |
\&\f(CW\*(C`gvpe@lists.schmorp.de\*(C'\fR. |
| 417 |
pcg |
1.1 |
.SH "AUTHOR" |
| 418 |
|
|
.IX Header "AUTHOR" |
| 419 |
pcg |
1.7 |
Marc Lehmann <gvpe@schmorp.de> |
| 420 |
pcg |
1.1 |
.SH "COPYRIGHTS AND LICENSES" |
| 421 |
|
|
.IX Header "COPYRIGHTS AND LICENSES" |
| 422 |
root |
1.13 |
\&\s-1GVPE\s0 itself is distributed under the \s-1GENERAL PUBLIC LICENSE \s0(see the file |
| 423 |
pcg |
1.1 |
\&\s-1COPYING\s0 that should be part of your distribution). |
| 424 |
|
|
.PP |
| 425 |
|
|
In some configurations it uses modified versions of the tinc vpn suite, |
| 426 |
root |
1.13 |
which is also available under the \s-1GENERAL PUBLIC LICENSE.\s0 |
