Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation #419

Merged
merged 3 commits into from
Dec 19, 2018
Merged

update documentation #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc0a6b9
update documentation
mrbaseman Dec 18, 2018
5acc2b2
further split long string of help_options
mrbaseman Dec 18, 2018
00285c1
update date of man page
mrbaseman Dec 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions doc/openfortivpn.1.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.TH OPENFORTIVPN 1 "October 23, 2017" ""
.TH OPENFORTIVPN 1 "December 18, 2018" ""

.SH NAME
openfortivpn \- Client for PPP+SSL VPN tunnel services

.SH SYNOPSIS
.B openfortivpn
[\fI<host>\fR:\fI<port>\fR]
[\fI<host>\fR[:\fI<port>\fR]]
[\fB\-u\fR \fI<user>\fR]
[\fB\-p\fR \fI<pass>\fR]
[\fB\-\-otp=\fI<otp>\fR]
Expand Down Expand Up @@ -46,7 +46,7 @@ connects to a VPN by setting up a tunnel to the gateway at
.SH OPTIONS
.TP
\fB\-\-help\fR
Show this help message and exit.
Show the help message and exit.
.TP
\fB\-\-version\fR
Show version and exit.
Expand Down Expand Up @@ -80,6 +80,10 @@ higher priority instead of replacing the default route.
\fB\-\-set-dns=\fI<bool>\fR, \fB\-\-no-dns\fR
Set if openfortivpn should add VPN nameservers in /etc/resolv.conf when
tunnel is up. If used multiple times, the last one takes priority.
This option requires that the dns entries are requested from the peer.
So, \fB\-\-pppd-no-peerdns\fR conflicts with \fB\-\-set-dns=\fI1\fR.
Note that there may be other mechanisms to update /etc/resolv.conf
which may require that openfortivpn is called with \fB\-\-no-dns\fR.

\fB\-\-no-dns\fR is the same as \fB\-\-set-dns=\fI0\fR.
.TP
Expand Down Expand Up @@ -120,7 +124,11 @@ $ openssl s_client -connect \fI<host:port>\fR
.TP
\fB\-\-pppd-no-peerdns\fR
Do not ask peer ppp server for DNS server addresses and do not make pppd
rewrite /etc/resolv.conf.
rewrite /etc/resolv.conf. If the DNS server addresses are not requested,
also \fB\-\-set-dns=\fI1\fR has no effect. On the other hand, with
\fB\-\-set-dns=\fI0\fR, when pppd requests DNS server addresses, there
may be othter mechanisms, such as an pppd-ip-up-script that do the update
of /etc/resolv.conf.
.TP
\fB\-\-pppd-log=\fI<file>\fR
Set pppd in debug mode and save its logs into \fI<file>\fR.
Expand All @@ -144,8 +152,12 @@ This can be useful on Debian and Ubuntu, where unprivileged users in
group `dip' can invoke `pppd call <name>' to make pppd read and apply
options from /etc/ppp/peers/<name> (including privileged ones).
.TP
\fB\-\-ppp-system=\fI<string>\fR
Only available if compiled for ppp user space client (e.g. on FreeBSD).
Connect to the specified system as defined in /etc/ppp/ppp.conf
.TP
\fB\-\-persistent\=\fI<interval>\fR
Runs the vpn persistently in an endless loop and tries to reconnect forever.
Run the vpn persistently in an endless loop and try to reconnect forever.
The reconnect interval may be specified in seconds, where 0 means
no reconnect is done (this is the default).
.TP
Expand All @@ -157,7 +169,7 @@ Decrease verbosity. Can be used multiple times to be even less verbose.

.SH ENVIRONMENT and proxy support
.B openfortivpn
can be run behind a http that supports the http connect command.
can be run behind a http proxy that supports the http connect command.
It checks if one of the environment variables
.B https_proxy HTTPS_PROXY all_proxy ALL_PROXY
is set which are supposed to contain a string of the format
Expand Down Expand Up @@ -195,6 +207,9 @@ VPN_ROUTE_MASK_... the network mask for this route
.br
VPN_ROUTE_GATEWAY_... the gateway for the current route entry

If not compiled for pppd the pppd options and features that rely on them are not
available. On FreeBSD \fB\-\-ppp-system\fR is available instead.

.SH CONFIG FILE
Options can be taken from a configuration file. Options passed in the command
line will override those from the config file, though. The default config file
Expand Down Expand Up @@ -246,9 +261,13 @@ pppd-use-peerdns = 1
.br
# pppd-log = /var/log/pppd.log
.br
# pass an ipparam string to pppd
# pass ppp interface name to pppd (if supported by a patched pppd)
.br
# pppd-ifname = ppp1
.br
# pass an ipparam string to pppd, e.g. the device name (a similar use case)
.br
# pppd-ipparam = somestringtopasstopppd
# pppd-ipparam = 'device=$DEVICE'
.br
insecure-ssl = 0
.br
Expand Down
15 changes: 7 additions & 8 deletions src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

#define PWD_BUFSIZ 4096


#if HAVE_USR_SBIN_PPPD
#define PPPD_USAGE \
" [--pppd-no-peerdns] [--pppd-log=<file>]\n" \
Expand All @@ -38,7 +37,8 @@

#define PPPD_HELP \
" --pppd-no-peerdns Do not ask peer ppp server for DNS server addresses\n" \
" and do not make pppd rewrite /etc/resolv.conf\n" \
" and do not make pppd rewrite /etc/resolv.conf,\n" \
" nor openfortivpn will modify DNS resolution then.\n" \
" --pppd-log=<file> Set pppd in debug mode and save its logs into\n" \
" <file>.\n" \
" --pppd-plugin=<file> Use specified pppd plugin instead of configuring\n" \
Expand Down Expand Up @@ -78,7 +78,6 @@ PPPD_USAGE \
"the gateway and this process.\n" \
"\n"


#define help_options \
"Options:\n" \
" -h --help Show this help message and exit.\n" \
Expand All @@ -96,7 +95,7 @@ PPPD_USAGE \
" --half-internet-routes=[01] Add two 0.0.0.0/1 and 128.0.0.0/1 routes with higher\n" \
" priority instead of replacing the default route.\n" \
" --set-dns=[01] Set if openfortivpn should add VPN name servers in\n" \
" /etc/resolv.conf\n" \
" /etc/resolv.conf, pppd must provide the DNS servers.\n" \
" --no-dns Do not reconfigure DNS, same as --set-dns=0\n" \
" --ca-file=<file> Use specified PEM-encoded certificate bundle\n" \
" instead of system-wide store to verify the gateway\n" \
Expand All @@ -119,17 +118,16 @@ PPPD_USAGE \
" you can try with the cipher suggested in the output\n" \
" of 'openssl s_client -connect <host:port>'\n" \
" (e.g. AES256-GCM-SHA384)\n" \
PPPD_HELP \
" --persistent=<interval> Run the vpn persistently in a loop and try to re-\n" \
" connect every <interval> seconds when dropping out\n" \
" -v Increase verbosity. Can be used multiple times\n" \
" to be even more verbose.\n" \
" -q Decrease verbosity. Can be used multiple times\n" \
" to be even less verbose.\n" \
"\n"
" to be even less verbose.\n"


#define help_config \
"\n" \
"Config file:\n" \
" Options can be taken from a configuration file. Options passed in the\n" \
" command line will override those from the config file, though. The default\n" \
Expand Down Expand Up @@ -362,7 +360,8 @@ int main(int argc, char **argv)
}
goto user_error;
case 'h':
printf("%s%s%s%s", usage, summary, help_options, help_config);
printf("%s%s%s%s%s", usage, summary, help_options,
PPPD_HELP, help_config);
ret = EXIT_SUCCESS;
goto exit;
case 'v':
Expand Down