.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` 
.    ds C' 
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "GVPE 5"
.TH GVPE 5 "2016-11-02" "2.25" "GNU Virtual Private Ethernet"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
GNU\-VPE \- Overview of the GNU Virtual Private Ethernet suite.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1GVPE\s0 is a suite designed to provide a virtual private network for multiple
nodes over an untrusted network. This document first gives an introduction
to VPNs in general and then describes the specific implementation of \s-1GVPE.\s0
.SS "\s-1WHAT IS A VPN\s0?"
.IX Subsection "WHAT IS A VPN?"
\&\s-1VPN\s0 is an acronym, it stands for:
.IP "Virtual" 4
.IX Item "Virtual"
Virtual means that no physical network is created (of course), but a
network is \fIemulated\fR by creating multiple tunnels between the member
nodes by encapsulating and sending data over another transport network.
.Sp
Usually the emulated network is a normal \s-1IP\s0 or Ethernet, and the transport
network is the Internet. However, using a \s-1VPN\s0 system like \s-1GVPE\s0 to connect
nodes over other untrusted networks such as Wireless \s-1LAN\s0 is not uncommon.
.IP "Private" 4
.IX Item "Private"
Private means that non-participating nodes cannot decode (\*(L"sniff)\*(R" nor
inject (\*(L"spoof\*(R") packets. This means that nodes can be connected over
untrusted networks such as the public Internet without fear of being
eavesdropped while at the same time being able to trust data sent by other
nodes.
.Sp
In the case of \s-1GVPE,\s0 even participating nodes cannot sniff packets
send to other nodes or spoof packets as if sent from other nodes, so
communications between any two nodes is private to those two nodes.
.IP "Network" 4
.IX Item "Network"
Network means that more than two parties can participate in the network,
so for instance it's possible to connect multiple branches of a company
into a single network. Many so-called \*(L"\s-1VPN\*(R"\s0 solutions only create
point-to-point tunnels, which in turn can be used to build larger
networks.
.Sp
\&\s-1GVPE\s0 provides a true multi-point network in which any number of nodes (at
least a few dozen in practise, the theoretical limit is 4095 nodes) can
participate.
.SS "\s-1GVPE DESIGN GOALS\s0"
.IX Subsection "GVPE DESIGN GOALS"
.IP "\s-1SIMPLE DESIGN\s0" 4
.IX Item "SIMPLE DESIGN"
Cipher, \s-1HMAC\s0 algorithms and other key parameters must be selected
at compile time \- this makes it possible to only link in algorithms
you actually need. It also makes the crypto part of the source very
transparent and easy to inspect, and last not least this makes it possible
to hardcode the layout of all packets into the binary. \s-1GVPE\s0 goes a step
further and internally reserves blocks of the same length for all packets,
which virtually removes all possibilities of buffer overflows, as there is
only a single type of buffer and it's always of fixed length.
.IP "\s-1EASY TO SETUP\s0" 4
.IX Item "EASY TO SETUP"
A few lines of config (the config file is shared unmodified between all
hosts) and generating an \s-1RSA\s0 key-pair on each node suffices to make it
work.
.IP "MAC-BASED \s-1SECURITY\s0" 4
.IX Item "MAC-BASED SECURITY"
Since every host has it's own private key, other hosts cannot spoof
traffic from this host. That makes it possible to filter packet by \s-1MAC\s0
address, e.g. to ensure that packets from a specific \s-1IP\s0 address come, in
fact, from a specific host that is associated with that \s-1IP\s0 and not from
another host.
.SH "PROGRAMS"
.IX Header "PROGRAMS"
Gvpe comes with two programs: one daemon (\f(CW\*(C`gvpe\*(C'\fR) and one control program
(\f(CW\*(C`gvpectrl\*(C'\fR).
.IP "gvpectrl" 4
.IX Item "gvpectrl"
This program is used to generate the keys, check and give an overview of of the
configuration and to control the daemon (restarting etc.).
.IP "gvpe" 4
.IX Item "gvpe"
This is the daemon used to establish and maintain connections to the other
network nodes. It should be run on the gateway of each \s-1VPN\s0 subnet.
.SH "COMPILETIME CONFIGURATION"
.IX Header "COMPILETIME CONFIGURATION"
Please have a look at the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific
information.
.PP
Gvpe hardcodes most encryption parameters. While this reduces flexibility,
it makes the program much simpler and helps making buffer overflows
impossible under most circumstances.
.PP
Here are a few recipes for compiling your gvpe, showing the extremes
(fast, small, insecure \s-1OR\s0 slow, large, more secure), between which you
should choose:
.SS "\s-1AS LOW PACKET OVERHEAD AS POSSIBLE\s0"
.IX Subsection "AS LOW PACKET OVERHEAD AS POSSIBLE"
.Vb 1
\&   ./configure \-\-enable\-hmac\-length=4 \-\-enable\-rand\-length=0
.Ve
.PP
Minimize the header overhead of \s-1VPN\s0 packets (the above will result in
only 4 bytes of overhead over the raw ethernet frame). This is a insecure
configuration because a \s-1HMAC\s0 length of 4 makes collision attacks almost
trivial.
.SS "\s-1MINIMIZE CPU TIME REQUIRED\s0"
.IX Subsection "MINIMIZE CPU TIME REQUIRED"
.Vb 1
\&   ./configure \-\-enable\-cipher=bf \-\-enable\-digest=md4
.Ve
.PP
Use the fastest cipher and digest algorithms currently available in
gvpe. \s-1MD4\s0 has been broken and is quite insecure, though, so using another
digest algorithm is recommended.
.SS "\s-1MAXIMIZE SECURITY\s0"
.IX Subsection "MAXIMIZE SECURITY"
.Vb 1
\&   ./configure \-\-enable\-hmac\-length=16 \-\-enable\-rand\-length=12 \-\-enable\-digest=ripemd610
.Ve
.PP
This uses a 16 byte \s-1HMAC\s0 checksum to authenticate packets (I guess 8\-12
would also be pretty secure ;) and will additionally prefix each packet
with 12 bytes of random data.
.PP
In general, remember that \s-1AES\-128\s0 seems to be as secure but faster than
\&\s-1AES\-192\s0 or \s-1AES\-256,\s0 more randomness helps against sniffing and a longer
\&\s-1HMAC\s0 helps against spoofing. \s-1MD4\s0 is a fast digest, \s-1SHA1, RIPEMD160, SHA256\s0
are consecutively better, and Blowfish is a fast cipher (and also quite
secure).
.SH "HOW TO SET UP A SIMPLE VPN"
.IX Header "HOW TO SET UP A SIMPLE VPN"
In this section I will describe how to get a simple \s-1VPN\s0 consisting of
three hosts up and running.
.SS "\s-1STEP 1:\s0 configuration"
.IX Subsection "STEP 1: configuration"
First you have to create a daemon configuration file and put it into the
configuration directory. This is usually \f(CW\*(C`/etc/gvpe\*(C'\fR, depending on how you
configured gvpe, and can be overwritten using the \f(CW\*(C`\-c\*(C'\fR command line switch.
.PP
Put the following lines into \f(CW\*(C`/etc/gvpe/gvpe.conf\*(C'\fR:
.PP
.Vb 3
\&   udp\-port = 50000 # the external port to listen on (configure your firewall)
\&   mtu = 1400       # minimum MTU of all outgoing interfaces on all hosts
\&   ifname = vpn0    # the local network device name
\&
\&   node = first     # just a nickname
\&   hostname = first.example.net # the DNS name or IP address of the host
\&
\&   node = second
\&   hostname = 133.55.82.9
\&
\&   node = third
\&   hostname = third.example.net
.Ve
.PP
The only other file necessary is the \f(CW\*(C`if\-up\*(C'\fR script that initializes the
virtual ethernet interface on the local host. Put the following lines into
\&\f(CW\*(C`/etc/gvpe/if\-up\*(C'\fR and make it executable (\f(CW\*(C`chmod 755 /etc/gvpe/if\-up\*(C'\fR):
.PP
.Vb 6
\&   #!/bin/sh
\&   ip link set $IFNAME address $MAC mtu $MTU up
\&   [ $NODENAME = first  ] && ip addr add 10.0.1.1 dev $IFNAME
\&   [ $NODENAME = second ] && ip addr add 10.0.2.1 dev $IFNAME
\&   [ $NODENAME = third  ] && ip addr add 10.0.3.1 dev $IFNAME
\&   ip route add 10.0.0.0/16 dev $IFNAME
.Ve
.PP
This script will give each node a different \s-1IP\s0 address in the \f(CW\*(C`10.0/16\*(C'\fR
network.  The internal network (if gvpe runs on a router) should then be
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,
\&\f(CW\*(C`10.0.2.0/24\*(C'\fR on node \f(CW\*(C`second\*(C'\fR, and so on.
.PP
By enabling routing on the gateway host that runs \f(CW\*(C`gvpe\*(C'\fR all nodes will
be able to reach the other nodes. You can, of course, also use proxy \s-1ARP\s0
or other means of pseudo-bridging, or (best) full routing \- the choice is
yours.
.SS "\s-1STEP 2:\s0 create the \s-1RSA\s0 key pair for each node"
.IX Subsection "STEP 2: create the RSA key pair for each node"
Next you have to generate the \s-1RSA\s0 keys for the nodes. While you can set
up \s-1GVPE\s0 so you can generate all keys on a single host and centrally
distribute all keys, it is safer to generate the key for each node on the
node, so that the secret/private key does not have to be copied over the
network.
.PP
To do so, run the following command to generate a key pair:
.PP
.Vb 1
\&   gvpectrl \-c /etc/gvpe \-g nodekey
.Ve
.PP
This will create two files, \fInodekey\fR and \fInodekey.privkey\fR. The former
should be copied to \fI/etc/gvpe/pubkey/\fInodename\fI\fR on the host where
your config file is (you will have to create the \fIpubkey\fR directory
first):
.PP
.Vb 1
\&   scp nodekey confighost:/etc/gvpe/pubkey/nodename
.Ve
.PP
The private key \fInodekey.privkey\fR should be moved to \fI/etc/gvpe/hostkey\fR:
.PP
.Vb 2
\&   mkdir \-p /etc/gvpe
\&   mv nodekey.privkey /etc/gvpe/hostkey
.Ve
.SS "\s-1STEP 3:\s0 distribute the config files to all nodes"
.IX Subsection "STEP 3: distribute the config files to all nodes"
Now distribute the config files and public keys to the other nodes.
.PP
The example uses rsync-over-ssh to copy the config file and all the public
keys:
.PP
.Vb 3
\&   rsync \-avzessh /etc/gvpe first.example.net:/etc/. \-\-exclude hostkey
\&   rsync \-avzessh /etc/gvpe 133.55.82.9:/etc/.       \-\-exclude hostkey
\&   rsync \-avzessh /etc/gvpe third.example.net:/etc/. \-\-exclude hostkey
.Ve
.PP
You should now check the configuration by issuing the command \f(CW\*(C`gvpectrl
\&\-c /etc/gvpe \-s\*(C'\fR on each node and verify it's output.
.SS "\s-1STEP 4:\s0 starting gvpe"
.IX Subsection "STEP 4: starting gvpe"
You should then start gvpe on each node by issuing a command like:
.PP
.Vb 1
\&   gvpe \-D \-l info first # first is the nodename
.Ve
.PP
This will make the gvpe daemon stay in foreground. You should then see
\&\*(L"connection established\*(R" messages. If you don't see them check your
firewall and routing (use tcpdump ;).
.PP
If this works you should check your networking setup by pinging various
endpoints.
.PP
To make gvpe run more permanently you can either run it as a daemon (by
starting it without the \f(CW\*(C`\-D\*(C'\fR switch), or, much better, from your inittab
or equivalent. I use a line like this on all my systems:
.PP
.Vb 1
\&   t1:2345:respawn:/opt/gvpe/sbin/gvpe \-D \-L first >/dev/null 2>&1
.Ve
.SS "\s-1STEP 5:\s0 enjoy"
.IX Subsection "STEP 5: enjoy"
\&... and play around. Sending a \-HUP (\f(CW\*(C`gvpectrl \-kHUP\*(C'\fR) to the daemon
will make it try to connect to all other nodes again. If you run it from
inittab \f(CW\*(C`gvpectrl \-k\*(C'\fR (or simply \f(CW\*(C`killall gvpe\*(C'\fR) will kill the daemon,
start it again, making it read it's configuration files again.
.PP
To run the \s-1GVPE\s0 daemon permanently from your SysV init, you can add it to
your \fIinittab\fR, e.g.:
.PP
.Vb 1
\&   t1:2345:respawn:/bin/sh \-c "exec nice \-n\-20 /path/to/gvpe \-D node >/var/log/gvpe.log 2>&1"
.Ve
.PP
For systems using systemd, you can use a unit file similar to this one:
.PP
.Vb 4
\&   [Unit]
\&   Description=gvpe
\&   After=network.target
\&   Before=remote\-fs.target
\&
\&   [Service]
\&   ExecStart=/path/to/gvpe \-D node
\&   KillMode=process
\&   Restart=always
\&
\&   [Install]
\&   WantedBy=multi\-user.target
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIgvpe.osdep\fR\|(5) for OS-dependent information, \fIgvpe.conf\fR\|(5), \fIgvpectrl\fR\|(8),
and for a description of the transports, protocol, and routing algorithm,
\&\fIgvpe.protocol\fR\|(7).
.PP
The \s-1GVPE\s0 mailing list, at <http://lists.schmorp.de/>, or
\&\f(CW\*(C`gvpe@lists.schmorp.de\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Lehmann <gvpe@schmorp.de>
.SH "COPYRIGHTS AND LICENSES"
.IX Header "COPYRIGHTS AND LICENSES"
\&\s-1GVPE\s0 itself is distributed under the \s-1GENERAL PUBLIC LICENSE \s0(see the file
\&\s-1COPYING\s0 that should be part of your distribution).
.PP
In some configurations it uses modified versions of the tinc vpn suite,
which is also available under the \s-1GENERAL PUBLIC LICENSE.\s0