ootp/doc/otp-ov-plugin.1

114 lines
2.6 KiB
Groff
Raw Normal View History

2017-01-03 11:10:10 +00:00
...\" $Header: /usr/src/docbook-to-man/cmd/RCS/docbook-to-man.sh,v 1.3 1996/06/17 03:36:49 fld Exp $
...\"
...\" transcript compatibility for postscript use.
...\"
...\" synopsis: .P! <file.ps>
...\"
.de P!
\\&.
.fl \" force out current output buffer
\\!%PB
\\!/showpage{}def
...\" the following is from Ken Flowers -- it prevents dictionary overflows
\\!/tempdict 200 dict def tempdict begin
.fl \" prolog
.sy cat \\$1\" bring in postscript file
...\" the following line matches the tempdict above
\\!end % tempdict %
\\!PE
\\!.
.sp \\$2u \" move below the image
..
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "\fBotp-ov-plugin\fP" "1"
.SH "NAME"
\fBotp-ov-plugin\fP \(em OpenVPN plug-in authentication module for OTP database\&.
.SH "SYNOPSIS"
.PP
2017-01-03 11:16:53 +00:00
\fBotp-ov-plugin\fP [-?hv] [-o\fI otpdb_fname\fP] [-V\fI service_name\fP] [-w\fI otp_window\fP]
2017-01-03 11:10:10 +00:00
.SH "DESCRIPTION"
.PP
The \fBotp-ov-plugin\fP command is plug-in authentication
module for OpenVPN authenticating to the OTP database\&. The username
and password (challenge response) are passed via environment variables
\fIuser\fP and \fIpass\fP\&.
A successful authentication will set a return code of
\fB0\fR, authentication failure
\fB1\fR, and program failure
\fB-1\fR\&.
.SH "OPTIONS"
2017-01-03 11:16:53 +00:00
.IP "-h, --help" 10
2017-01-03 11:10:10 +00:00
Help
2017-01-03 11:16:53 +00:00
.IP "-o, --otp-db=\fI otpdb_pathname\fP" 10
2017-01-03 11:10:10 +00:00
Pathname of OTP database\&.
2017-01-03 11:16:53 +00:00
.IP "-u, --otp-allow-unknown-user" 10
Allow users which do not exist in the OTP database to successfully
authenticate without using a One Time Password\&.
.IP "-V, --service-name=\fI service_name\fP" 10
Set service name for send-token function\&.
.IP "-v, --verbose" 10
2017-01-03 11:10:10 +00:00
Verbose
2017-01-03 11:16:53 +00:00
.IP "-w, --otp-challenge-window=" 10
2017-01-03 11:14:13 +00:00
Set the OTP challenge window\&.
2017-01-03 11:16:53 +00:00
.IP "--version" 10
Display software version\&.
2017-01-03 11:10:10 +00:00
.SH "EXAMPLES"
.PP
Test the module with user bob\&.
.PP
\fBexport user="bob"\fP
.PP
\fBexport pass="882B0E8410"\fP
.PP
\fBotp-ov-plugin; echo $?\fP
.PP
.nf
1
.fi
.SH "AUTHOR"
.PP
Mark Fullmer maf@splintered\&.net
.SH "SEE ALSO"
.PP
\fBotp-sca\fP(1)
\fBotp-sct\fP(1)
\fBotp-control\fP(1)
\fBpam_otp\fP(1)
\fBhtsoft-downloader\fP(1)
\fBurd\fP(1)
\fBbcload\fP(1)
\fBOpenVPN\fP(8)
spyrus-par2(7)
2017-01-03 11:18:19 +00:00
...\" created by instant / docbook-to-man, Sun 12 Jun 2011, 15:01