2017-01-03 11:10:10 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
|
|
<HTML
|
|
|
|
|
><HEAD
|
|
|
|
|
><TITLE
|
|
|
|
|
>otp-ov-plugin</TITLE
|
|
|
|
|
><META
|
|
|
|
|
NAME="GENERATOR"
|
|
|
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
|
|
|
|
|
><BODY
|
|
|
|
|
CLASS="REFENTRY"
|
|
|
|
|
BGCOLOR="#FFFFFF"
|
|
|
|
|
TEXT="#000000"
|
|
|
|
|
LINK="#0000FF"
|
|
|
|
|
VLINK="#840084"
|
|
|
|
|
ALINK="#0000FF"
|
|
|
|
|
><H1
|
|
|
|
|
><A
|
|
|
|
|
NAME="AEN1"
|
|
|
|
|
></A
|
|
|
|
|
><SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>otp-ov-plugin</SPAN
|
|
|
|
|
></H1
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFNAMEDIV"
|
|
|
|
|
><A
|
|
|
|
|
NAME="AEN6"
|
|
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>Name</H2
|
|
|
|
|
><SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>otp-ov-plugin</SPAN
|
|
|
|
|
> -- OpenVPN plug-in authentication module for OTP database.</DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSYNOPSISDIV"
|
|
|
|
|
><A
|
|
|
|
|
NAME="AEN10"
|
|
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>Synopsis</H2
|
|
|
|
|
><P
|
|
|
|
|
><B
|
|
|
|
|
CLASS="COMMAND"
|
|
|
|
|
>otp-ov-plugin</B
|
|
|
|
|
> [-?hv] [-o<TT
|
|
|
|
|
CLASS="REPLACEABLE"
|
|
|
|
|
><I
|
|
|
|
|
> otpdb_fname</I
|
|
|
|
|
></TT
|
2017-01-03 11:16:53 +00:00
|
|
|
>] [-V<TT
|
|
|
|
|
CLASS="REPLACEABLE"
|
|
|
|
|
><I
|
|
|
|
|
> service_name</I
|
|
|
|
|
></TT
|
2017-01-03 11:14:13 +00:00
|
|
|
>] [-w<TT
|
|
|
|
|
CLASS="REPLACEABLE"
|
|
|
|
|
><I
|
|
|
|
|
> otp_window</I
|
|
|
|
|
></TT
|
2017-01-03 11:10:10 +00:00
|
|
|
>]</P
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSECT1"
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN20"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>DESCRIPTION</H2
|
|
|
|
|
><P
|
|
|
|
|
>The <B
|
|
|
|
|
CLASS="COMMAND"
|
|
|
|
|
>otp-ov-plugin</B
|
|
|
|
|
> command is plug-in authentication
|
|
|
|
|
module for OpenVPN authenticating to the OTP database. The username
|
|
|
|
|
and password (challenge response) are passed via environment variables
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="emphasis"
|
|
|
|
|
><I
|
|
|
|
|
CLASS="EMPHASIS"
|
|
|
|
|
>user</I
|
|
|
|
|
></SPAN
|
|
|
|
|
> and <SPAN
|
|
|
|
|
CLASS="emphasis"
|
|
|
|
|
><I
|
|
|
|
|
CLASS="EMPHASIS"
|
|
|
|
|
>pass</I
|
|
|
|
|
></SPAN
|
|
|
|
|
>.
|
|
|
|
|
A successful authentication will set a return code of
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="RETURNVALUE"
|
|
|
|
|
>0</SPAN
|
|
|
|
|
>, authentication failure
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="RETURNVALUE"
|
|
|
|
|
>1</SPAN
|
|
|
|
|
>, and program failure
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="RETURNVALUE"
|
|
|
|
|
>-1</SPAN
|
|
|
|
|
>.</P
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSECT1"
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN29"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>OPTIONS</H2
|
|
|
|
|
><P
|
|
|
|
|
></P
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="VARIABLELIST"
|
|
|
|
|
><DL
|
|
|
|
|
><DT
|
2017-01-03 11:16:53 +00:00
|
|
|
>-h, --help</DT
|
2017-01-03 11:10:10 +00:00
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Help</P
|
|
|
|
|
></DD
|
|
|
|
|
><DT
|
2017-01-03 11:16:53 +00:00
|
|
|
>-o, --otp-db=<TT
|
2017-01-03 11:10:10 +00:00
|
|
|
CLASS="REPLACEABLE"
|
|
|
|
|
><I
|
|
|
|
|
> otpdb_pathname</I
|
|
|
|
|
></TT
|
|
|
|
|
></DT
|
|
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Pathname of OTP database.</P
|
|
|
|
|
></DD
|
|
|
|
|
><DT
|
2017-01-03 11:16:53 +00:00
|
|
|
>-u, --otp-allow-unknown-user</DT
|
|
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Allow users which do not exist in the OTP database to successfully
|
|
|
|
|
authenticate without using a One Time Password.</P
|
|
|
|
|
></DD
|
|
|
|
|
><DT
|
|
|
|
|
>-V, --service-name=<TT
|
|
|
|
|
CLASS="REPLACEABLE"
|
|
|
|
|
><I
|
|
|
|
|
> service_name</I
|
|
|
|
|
></TT
|
|
|
|
|
></DT
|
|
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Set service name for send-token function.</P
|
|
|
|
|
></DD
|
|
|
|
|
><DT
|
|
|
|
|
>-v, --verbose</DT
|
2017-01-03 11:10:10 +00:00
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Verbose</P
|
|
|
|
|
></DD
|
2017-01-03 11:14:13 +00:00
|
|
|
><DT
|
2017-01-03 11:16:53 +00:00
|
|
|
>-w, --otp-challenge-window=</DT
|
2017-01-03 11:14:13 +00:00
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Set the OTP challenge window.</P
|
|
|
|
|
></DD
|
2017-01-03 11:16:53 +00:00
|
|
|
><DT
|
|
|
|
|
>--version</DT
|
|
|
|
|
><DD
|
|
|
|
|
><P
|
|
|
|
|
>Display software version.</P
|
|
|
|
|
></DD
|
2017-01-03 11:10:10 +00:00
|
|
|
></DL
|
|
|
|
|
></DIV
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSECT1"
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN62"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>EXAMPLES</H2
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="INFORMALEXAMPLE"
|
|
|
|
|
><P
|
|
|
|
|
></P
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN64"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><P
|
|
|
|
|
>Test the module with user bob.</P
|
|
|
|
|
><P
|
|
|
|
|
> <B
|
|
|
|
|
CLASS="COMMAND"
|
|
|
|
|
>export user="bob"</B
|
|
|
|
|
></P
|
|
|
|
|
><P
|
|
|
|
|
> <B
|
|
|
|
|
CLASS="COMMAND"
|
|
|
|
|
>export pass="882B0E8410"</B
|
|
|
|
|
></P
|
|
|
|
|
><P
|
|
|
|
|
> <B
|
|
|
|
|
CLASS="COMMAND"
|
|
|
|
|
>otp-ov-plugin; echo $?</B
|
|
|
|
|
></P
|
|
|
|
|
><PRE
|
|
|
|
|
CLASS="SCREEN"
|
|
|
|
|
>1</PRE
|
|
|
|
|
><P
|
|
|
|
|
></P
|
|
|
|
|
></DIV
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSECT1"
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN73"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>AUTHOR</H2
|
|
|
|
|
><P
|
|
|
|
|
>Mark Fullmer
|
|
|
|
|
<CODE
|
|
|
|
|
CLASS="EMAIL"
|
|
|
|
|
><<A
|
|
|
|
|
HREF="mailto:maf@splintered.net"
|
|
|
|
|
>maf@splintered.net</A
|
|
|
|
|
>></CODE
|
|
|
|
|
></P
|
|
|
|
|
></DIV
|
|
|
|
|
><DIV
|
|
|
|
|
CLASS="REFSECT1"
|
|
|
|
|
><A
|
2017-01-03 11:16:53 +00:00
|
|
|
NAME="AEN80"
|
2017-01-03 11:10:10 +00:00
|
|
|
></A
|
|
|
|
|
><H2
|
|
|
|
|
>SEE ALSO</H2
|
|
|
|
|
><P
|
|
|
|
|
><SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>otp-sca</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>otp-sct</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>otp-control</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>pam_otp</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>htsoft-downloader</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>urd</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>bcload</SPAN
|
|
|
|
|
>(1)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="APPLICATION"
|
|
|
|
|
>OpenVPN</SPAN
|
|
|
|
|
>(8)
|
|
|
|
|
<SPAN
|
|
|
|
|
CLASS="HARDWARE"
|
|
|
|
|
>spyrus-par2</SPAN
|
|
|
|
|
>(7)</P
|
|
|
|
|
></DIV
|
|
|
|
|
></BODY
|
|
|
|
|
></HTML
|
|
|
|
|
>
|
