| 1 |
=head1 NAME |
| 2 |
|
| 3 |
C<gvpe> - GNU Virtual Private Ethernet Daemon |
| 4 |
=head1 SYNOPSIS |
| 5 |
|
| 6 |
C<gvpe> [B<-cDlL>] [B<--config=>I<DIR>] [B<--no-detach>] [B<-l=>I<LEVEL]>] |
| 7 |
[B<--kill>[B<=>I<SIGNAL>]] [B<--mlock>] [B<--help>] [B<--version>] |
| 8 |
I<NODENAME> |
| 9 |
|
| 10 |
=head1 DESCRIPTION |
| 11 |
|
| 12 |
See the gvpe(5) manpage for an introduction to the gvpe suite. |
| 13 |
|
| 14 |
This is the manual page for gvpe, the virtual private ethernet daemon. |
| 15 |
When started, C<gvpe> will read it's configuration file to determine the |
| 16 |
network topology, and other configuration information, assuming the role |
| 17 |
of node I<NODENAME>. It will then connect to the tun/tap device and set |
| 18 |
up a socket for incoming connections. Then a script will be executed to |
| 19 |
further configure the virtual device. If that succeeds, it will detach |
| 20 |
from the controlling terminal and continue in the background, accepting |
| 21 |
and setting up connections to other gvpe daemons that are part of the |
| 22 |
virtual private ethernet. |
| 23 |
|
| 24 |
=head1 OPTIONS |
| 25 |
|
| 26 |
=over 4 |
| 27 |
|
| 28 |
=item B<-c>, B<--config=>I<DIR> |
| 29 |
|
| 30 |
Read configuration options from I<DIR> |
| 31 |
|
| 32 |
=item B<-d>, B<--l=>I<LEVEL> |
| 33 |
|
| 34 |
Set logging level to I<LEVEL> (one of: noise, trace, debug, info, notice, |
| 35 |
warn, error, critical). |
| 36 |
|
| 37 |
=item B<--help> |
| 38 |
|
| 39 |
Display short list of options. |
| 40 |
|
| 41 |
=item B<-D>, B<--no-detach> |
| 42 |
|
| 43 |
Don't fork and detach but stay in foreground and log messages to stderr in |
| 44 |
addition to syslog. |
| 45 |
|
| 46 |
=item B<-L>, B<--mlock> |
| 47 |
|
| 48 |
Lock C<gvpe> into main memory. This will prevent sensitive data like |
| 49 |
shared private keys to be written to the system swap files/partitions. |
| 50 |
|
| 51 |
=item B<--version> |
| 52 |
|
| 53 |
Output version information and exit. |
| 54 |
|
| 55 |
=back |
| 56 |
|
| 57 |
=head1 SIGNALS |
| 58 |
|
| 59 |
=over 4 |
| 60 |
|
| 61 |
=item HUP |
| 62 |
|
| 63 |
Closes/resets all connections, resets the retry time and will start connecting |
| 64 |
again (it will NOT re-read the config file). This is useful e.g. in a |
| 65 |
C</etc/ppp/if-up> script. |
| 66 |
|
| 67 |
=item TERM |
| 68 |
|
| 69 |
Closes/resets all connections and exits. |
| 70 |
|
| 71 |
=item USR1 |
| 72 |
|
| 73 |
Dump current network status into the syslog (at loglevel C<notice>, so make |
| 74 |
sure your loglevel allows this). |
| 75 |
|
| 76 |
=back |
| 77 |
|
| 78 |
=head1 FILES |
| 79 |
|
| 80 |
=over 4 |
| 81 |
|
| 82 |
=item C</etc/gvpe/gvpe.conf> |
| 83 |
|
| 84 |
The configuration file for C<gvpe>. |
| 85 |
|
| 86 |
=item C</etc/gvpe/if-up> |
| 87 |
|
| 88 |
Script which is executed as soon as the virtual network device has been |
| 89 |
allocated. Purpose is to further configure that device. |
| 90 |
|
| 91 |
=item C</etc/gvpe/node-up> |
| 92 |
|
| 93 |
Script which is executed whenever a node connects to this node. This can |
| 94 |
be used for example to run nsupdate. |
| 95 |
|
| 96 |
=item C</etc/gvpe/node-down> |
| 97 |
|
| 98 |
Script which is executed whenever a conenction to another node is lost. |
| 99 |
for example to run nsupdate. |
| 100 |
|
| 101 |
=item C</etc/gvpe/pubkey/*> |
| 102 |
|
| 103 |
The directory containing the public keys for every node, usually |
| 104 |
autogenerated by executing C<gvpectrl --generate-keys>. |
| 105 |
|
| 106 |
=item C</var/run/gvpe.pid> |
| 107 |
|
| 108 |
The PID of the currently running C<gvpe> is stored in this file. |
| 109 |
|
| 110 |
=back |
| 111 |
|
| 112 |
=head1 BUGS |
| 113 |
|
| 114 |
The cryptography in gvpe has not been thoroughly checked by many people |
| 115 |
yet. Use it at your own risk! |
| 116 |
|
| 117 |
If you find any bugs, report them to C<vpe@plan9.de>. |
| 118 |
|
| 119 |
=head1 TODO |
| 120 |
|
| 121 |
A lot. |
| 122 |
|
| 123 |
=head1 SEE ALSO |
| 124 |
|
| 125 |
gvpe(5) for an introduction, gvpe.conf(5), gvpectrl(8). |
| 126 |
|
| 127 |
gvpe comes with ABSOLUTELY NO WARRANTY. This is free software, and you are |
| 128 |
welcome to redistribute it under certain conditions; see the file COPYING |
| 129 |
for details. |
| 130 |
|
| 131 |
=head1 AUTHORS |
| 132 |
|
| 133 |
Marc Lehmann C<< <gvpe@plan9.de> >>. |
| 134 |
|
| 135 |
And thanks to many others for their contributions to gvpe, especially the |
| 136 |
tincd authors, who inspired me to write this program (after scavenging |
| 137 |
their sourcecode ;). |
| 138 |
|
