[tinc] / doc / tincd.8
1 .Dd 2002-02-07
2 .Dt TINCD 8
3 .\" Manual page created by:
4 .\" Ivo Timmermans <itimmermans@bigfoot.com>
5 .\" Guus Sliepen <guus@sliepen.warande.net>
6 .Sh NAME
7 .Nm tincd
8 .Nd tinc VPN daemon
10 .Nm
11 .Op Fl cdDkKn
12 .Op Fl -bypass-security
13 .Op Fl -config Ns = Ns Ar DIR
14 .Op Fl -debug Ns = Ns Ar LEVEL
15 .Op Fl -generate-keys Ns Op = Ns Ar BITS
16 .Op Fl -help
17 .Op Fl -kill Ns = Ns Ar SIGNAL
18 .Op Fl -net Ns = Ns Ar NETNAME
19 .Op Fl -no-detach
20 .Op Fl -version
22 This is the daemon of tinc, a secure virtual private network (VPN) project.
23 When started,
24 .Nm
25 will read it's configuration file to determine what virtual subnets it has to serve
26 and to what other tinc daemons it should connect.
27 It will connect to the ethertap or tun/tap device
28 and set up a socket for incoming connections.
29 Optionally a script will be executed to further configure the virtual device.
30 If that succeeds,
31 it will detach from the controlling terminal and continue in the background,
32 accepting and setting up connections to other tinc daemons
33 that are part of the virtual private network.
35 .Bl -tag -width indent
36 .It Fl -bypass-security
37 Disables encryption and authentication.
38 Only useful for debugging.
39 .It Fl c, -config Ns = Ns Ar DIR
40 Read configuration options from
41 .Ar DIR .
42 .It Fl d, -debug Ns Op = Ns Ar LEVEL
43 Increase debug level or set it to
44 .Ar LEVEL
45 (see below).
46 .It Fl K, -generate-keys Ns Op = Ns Ar BITS
47 Generate public/private RSA keypair and exit.
48 If
49 .Ar BITS
50 is omitted, the default length will be 1024 bits.
51 .It Fl -help
52 Display short list of options.
53 .It Fl k, -kill Ns Op = Ns Ar SIGNAL
54 Attempt to kill a running
55 .Nm
56 (optionally with the specified
58 instead of SIGQUIT) and exit.
59 .It Fl n, -net Ns = Ns Ar NETNAME
60 Connect to net
61 .Ar NETNAME .
62 .It Fl D, -no-detach
63 Don't fork and detach.
64 This will also disable the automatic restart mechanism for fatal errors.
65 .It Fl -version
66 Output version information and exit.
67 .El
69 .Bl -tag -width indent
70 .It ALRM
71 Forces
72 .Nm
73 to try to connect to all uplinks immediately.
74 Usually
75 .Nm
76 attempts to do this itself,
77 but increases the time it waits between the attempts each time it failed,
78 and if
79 .Nm
80 didn't succeed to connect to an uplink the first time after it started,
81 it defaults to the maximum time of 15 minutes.
82 .It HUP
83 Closes all connections, rereads the configuration file and restarts the daemon.
84 .It INT
85 Temporarily increases debug level to 5.
86 Send this signal again to revert to the original level.
87 .It USR1
88 Dumps the connection list to syslog.
89 .It USR2
90 Dumps virtual network device statistics, all known nodes, edges and subnets to syslog.
91 .It WINCH
92 Purges all information remembered about unreachable nodes.
93 .El
95 The tinc daemon can send a lot of messages to the syslog.
96 The higher the debug level,
97 the more messages it will log.
98 Each level inherits all messages of the previous level:
99 .Bl -tag -width indent
100 .It 0
101 This will log a message indicating
102 .Nm
103 has started along with a version number.
104 It will also any serious error.
105 .It 1
106 This will log all connections that are made with other tinc daemons.
107 .It 2
108 This will log status and error messages from other tinc daemons.
109 .It 3
110 This will log all requests that are exchanged with other tinc daemons. These include
111 authentication, key exchange and connection list updates.
112 .It 4
113 This will log a copy of everything received on the meta socket.
114 .It 5
115 This will log all network traffic over the virtual private network.
116 .El
117 .Sh FILES
118 .Bl -tag -width indent
119 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc.conf
120 The configuration file for
121 .Nm .
122 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-up
123 Script which is executed as soon as the virtual network device has been allocated.
124 Purpose is to further configure that device.
125 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /tinc-down
126 Script which is executed when
127 .Nm
128 exits.
129 Purpose is to cleanly shut down the virtual network device before it will be deallocated.
130 .It Pa /etc/tinc/ Ns Ar NETNAME Ns Pa /hosts/*
131 The directory containing the host configuration files
132 used to authenticate other tinc daemons.
133 .It Pa /var/run/tinc. Ns Ar NETNAME Ns Pa .pid
134 The PID of the currently running
135 .Nm
136 is stored in this file.
137 .El
138 .Sh BUGS
139 The
140 .Va BindToInterface ,
141 .Va BindToIP ,
142 .Va IndirectData
143 and
144 .Va TCPOnly
145 options may not work correctly.
146 .Pp
147 .Sy The cryptography in tinc is not well tested yet. Use it at your own risk!
148 .Pp
149 If you find any bugs, report them to tinc@nl.linux.org.
150 .Sh TODO
151 A lot, especially security auditing.
152 .Sh SEE ALSO
153 .Xr tinc.conf 5 ,
154 .Pa http://tinc.nl.linux.org/ ,
155 .Pa http://www.cabal.org/ .
156 .Pp
157 The full documentation for tinc is maintained as a Texinfo manual.
158 If the info and tinc programs are properly installed at your site,
159 the command
160 .Ic info tinc
161 should give you access to the complete manual.
162 .Pp
163 tinc comes with ABSOLUTELY NO WARRANTY.
164 This is free software, and you are welcome to redistribute it under certain conditions;
165 see the file COPYING for details.
167 .An "Ivo Timmermans" Aq itimmermans@bigfoot.com
168 .An "Guus Sliepen" Aq guus@sliepen.warande.net
169 .Pp
170 And thanks to many others for their contributions to tinc!