X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=doc%2Fexample.texi;h=688898a76bf350e646fac90b3ef7f702a5c40aa1;hb=a11b0bda178937e6891770f40f800d69b5640313;hp=c26284650498e9b2a7e5ff290dc3799bdf0a93e0;hpb=4a58ee4c1365408452e03535ca68146aa9cf3540;p=govpn.git diff --git a/doc/example.texi b/doc/example.texi index c262846..688898a 100644 --- a/doc/example.texi +++ b/doc/example.texi @@ -4,100 +4,92 @@ Let's assume that there is some insecure link between your computer and WiFi-reachable gateway. -@itemize @bullet +@itemize @item You have got @code{wlan0} NIC with 192.168.0/24 network on it. @item You want to create virtual encrypted and authenticated 172.16.0/24 network and use it as a default transport. -@item @code{wlan0} MTU is 1500, 20 bytes overhead per IPv4. So MTU for -GoVPN is 1500 - 20 - 8 = 1472. -@item During startup client and server will say that TAP interface MTU -is 1432. +@item Assume that outgoing GoVPN packets can be fragmented, so we do not +bother configuring MTU of TUN/TAP interfaces. For better performance just +lower it and check that no fragmentation of outgoing UDP packets occurs. @end itemize @strong{Install}. At first you must @ref{Installation, install} this software: download, @ref{Integrity, check the signature}, compile. -@strong{Prepare the client}. Generate client's identity and verifier for -Alice as an example: +@strong{Prepare the client}. Generate client's verifier for Alice as an +example: + + @verbatim client% ./utils/newclient.sh Alice -Enter passphrase: -Your id is: 7012df29deee2170594119df5091d4a2 +Passphrase: +Your client verifier is: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg -Place the following JSON configuration entry on the server's side: +Place the following YAML configuration entry on the server's side: - "7012df29deee2170594119df5091d4a2": { - "name": "Alice", - "up": "/path/to/up.sh", - "verifier": "fb43255ca3fe5bd884e364e5eae0cd37ad14774930a027fd38d8938fd0b57425" - } + Alice: + up: /path/to/up.sh + iface: or TUN/TAP interface name + verifier: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10 +@end verbatim -Verifier was generated with: +@strong{Prepare the server}. Add this entry to @file{peers.yaml} +configuration file: - ./utils/storekey.sh /tmp/passphrase - govpn-verifier -id 7012df29deee2170594119df5091d4a2 -key /tmp/passphrase +@verbatim +Alice: + iface: tap10 + verifier: $balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg$KCNIqfS4DGsBTtVytamAzcISgrlEWvNxan1UfBrFu10 @end verbatim -@strong{Prepare the server}. Add this entry to @code{peers.json} -configuration file. - @strong{Prepare network on GNU/Linux IPv4 server}: -@example -server% umask 077 -server% echo "#!/bin/sh" > /path/to/up.sh -server% echo "echo tap10" >> /path/to/up.sh +@verbatim server% ip addr add 192.168.0.1/24 dev wlan0 -server% tunctl -t tap10 -server% ip link set mtu 1432 dev tap10 +server% ip tuntap add dev tap10 mode tap server% ip addr add 172.16.0.1/24 dev tap10 server% ip link set up dev tap10 -@end example +@end verbatim @strong{Run server daemon itself}: -@example -server% govpn-server -bind 192.168.0.1:1194 -mtu 1472 -@end example +@verbatim +server% govpn-server -bind 192.168.0.1:1194 +@end verbatim @strong{Prepare network on GNU/Linux IPv4 client}: -@example -client% umask 066 -client% utils/storekey.sh key.txt +@verbatim client% ip addr add 192.168.0.2/24 dev wlan0 -client% tunctl -t tap10 -client% ip link set mtu 1432 dev tap10 +client% ip tuntap add dev tap10 mode tap client% ip addr add 172.16.0.2/24 dev tap10 client% ip link set up dev tap10 -client% ip route add default via 172.16.0.1 -@end example +client% ip route add 0/1 via 172.16.0.1 +client% ip route add 128/1 via 172.16.0.1 +@end verbatim @strong{Run client daemon itself}: -@example +@verbatim client% govpn-client \ - -key key.txt \ - -id 906e34b98750c4f686d6c5489508763c \ + -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \ -iface tap10 \ - -remote 192.168.0.1:1194 \ - -mtu 1472 -@end example + -remote 192.168.0.1:1194 +@end verbatim @strong{FreeBSD IPv6 similar client-server example}: -@example +@verbatim server% ifconfig em0 inet6 fe80::1/64 server% govpn-server -bind "fe80::1%em0" -@end example +@end verbatim -@example +@verbatim client% ifconfig me0 inet6 -ifdisabled auto_linklocal client% ifconfig tap10 -client% ifconfig tap10 inet6 fc00::2/96 mtu 1412 up +client% ifconfig tap10 inet6 fc00::2/96 up client% route -6 add default fc00::1 client% govpn-client \ - -key key.txt \ - -id 906e34b98750c4f686d6c5489508763c \ + -verifier '$balloon$s=32768,t=16,p=2$bwR5VjeCYIQaa8SeaI3rqg' \ -iface tap10 \ -remote "[fe80::1%me0]":1194 -@end example +@end verbatim