File: README

package info (click to toggle)
anytun 0.3.6-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,424 kB
  • sloc: cpp: 9,149; sh: 708; makefile: 396
file content (213 lines) | stat: -rw-r--r-- 5,225 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
Dependencies
============

Anytun can be built by using either libgcrypt, libnettle or the openssl-crypto
library. The latter is more performant in most cases but there are some license
issues when using this library.

Linux
-----
(this includes Debian with FreeBSD Kernel)

using libgcrypt:
  libgcrypt11-dev

using ssl crypto library:
  libssl-dev

using nettle crypto library:
  nettle-dev

common:
  build-essential
  libboost-serialization-dev
  libboost-thread-dev
  libboost-system-dev
  libboost-regex-dev

if you want clang as compiler
  clang

if you want to rebuild the manpage:
  asciidoc


Freebsd
-------

using libgcrypt:
   security/libgcrypt

using ssl crypto lib:
   <nothing here>

common:
   devel/boost (boost-libs on newer versions of the ports tree)
   devel/gmake

if you want to rebuild the manpage:
 textproc/asciidoc
 textproc/libxslt
 textproc/docbook-xsl
 sysutils/readlink
 misc/getopt



Windows
-------

 Crosscompiling with MinGW under Debian/Ubuntu:
 ----------------------------------------------

  # sudo apt-get install mingw-w64
  # cd contrib/
  # ./build-boost-mingw-cross.sh
  # ./build-openssl-mingw-cross.sh
  # ./build-anytun-mingw-cross.sh

  The compiled binaries can be found in anytun-w32 and anytun-w64 (32 and 64Bit).
  You can create a ZIP archive containing all needed files by calling:

  # ./make-mingw-release.sh


 Using MS Visual C++:
 --------------------
  OpenSSL
   Developer:
    http://www.slproweb.com/download/Win32OpenSSL-1_0_1h.exe

   Runtime Only:
    http://www.slproweb.com/download/Win32OpenSSL_Light-1_0_1h.exe

  Boost
    http://sourceforge.net/projects/boost/files/boost-binaries/

    As it can take some time to install everything from boost here is a
    complete list of libraries which have to be installed in order to build anytun:

     * Serialization
     * Thread
     * date_time
     * System
     * regex

  Microsoft Visual C++ 2008 Redistributable Package (x86):
    http://www.microsoft.com/downloads/details.aspx?familyid=9B2DA534-3E03-4391-8A4D-074B9F2BC1BF




Installation
============

Getting the source via GIT:
---------------------------

git clone https://git.spreadspace.org/anytun/anytun.git
cd anytun

Building from source
--------------------

using libgcrypt:

 # cd src
 # ./configure
 # make

using ssl crypto library:

 # cd src
 # ./configure --use-ssl-crypto
 # make


Notes:
  - try './configure --help' for further information
  - if using openssl pre 0.9.8 you have to disable passphrase
    because openssl had no SHA256 implementation prior to this
    version
  - on FreeBSD you have to use gmake instead of make
  - the FreeBSD port has some issues concering daemonizing and signal handling

Installing
----------

# sudo make install

This will install anytun under the --prefix defined with configure.


Uninstalling
------------

# sudo make remove

This removes everything except for the config files

# sudo make purge

This also removes the config files



Usage:
======

init.d script
-------------

The init.d script can be used to start anytun at boot time. It searches for
configuration files which reside at $CONFIG_DIR. For each instance of anytun
which should be started there must be a directory containing at least a file
named config. This file must contain all command line parameter which should
be used when starting the daemon. One line for each parameter. Empty lines and
lines starting with # are ignored. Besides the config file there may be a script
named post-up.sh which will be called when the tun/tap device comes up.
Furthermore there may be a directory called conf.d containing config files for
anytun-config. The syntax of this files is quite the same as those for anytun.
These files are used to configure a multi connection setup using anytun-config
and anytun-controld
This is an example of how the script can be used to start anytun:

# /etc/init.d/anytun start client1 p2p-a

In this case the script will start 2 instances of anytun using the config files
$CONFIG_DIR/client1/config and $CONFIG_DIR/p2p-a/config.
If no instance name is specified the script will use the file $CONFIG_DIR/autostart
to determine which instances to start or stop. This file must contain a list
of instance names which should be used when no names are specified at the command
line. One line for each name. Empty lines and lines starting with # are ignored.


systemd usage
-------------

Using the provided service units, anytun can now be started and managed via Systemd.
As with the init.d script, each VPN or anytun instance, identified by it's $vpnname,
 needs it's own configuration subdirectory. E.g.:  ${PREFIX}/etc/anytun/${vpnname}/.
For each such CLIENT instance, use the following command to enable it:

# systemctl enable anytun@${vpnname}.service

Manually start and stop instances by replacing enable with start or stop.


Errors:
=======

Note: Cannot open TUN/TAP dev /dev/net/tun: No such file or directory (errno=2)
Cannot open TUN/TAP dev /dev/anytun0: No such file or directory (errno=2)

Solution: Enabling tun/tap device
------------------------------------

modprobe tun
cd /dev
./MAKEDEV tun

edit /etc/modules and add the line
tun
to load the module automatically