ootp/doc/otp-sct.html

358 lines
5.3 KiB
HTML
Raw Permalink Normal View History

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-sct</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-sct</SPAN
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN6"
></A
><H2
>Name</H2
><SPAN
CLASS="APPLICATION"
>otp-sct</SPAN
>&nbsp;--&nbsp;Smart Card Terminal for One Time Password package.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN10"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>otp-sct</B
> [-1hlpv?] [-c<TT
CLASS="REPLACEABLE"
><I
> count</I
></TT
>] [-d<TT
CLASS="REPLACEABLE"
><I
> debug_level</I
></TT
>] [-i<TT
CLASS="REPLACEABLE"
><I
> index</I
></TT
>] [-r<TT
CLASS="REPLACEABLE"
><I
> reader</I
></TT
>] [-v<TT
CLASS="REPLACEABLE"
><I
> firmware_api_version</I
></TT
>]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN24"
></A
><H2
>DESCRIPTION</H2
><P
>The <B
CLASS="COMMAND"
>otp-sct</B
> command is a user interface to generating
2017-01-03 11:14:13 +00:00
One Time Passwords with a Smart Card loaded with OTP software.</P
2017-01-03 11:10:10 +00:00
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN28"
></A
><H2
>OPTIONS</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
2017-01-03 11:16:53 +00:00
>-c, --sc-count=<TT
2017-01-03 11:10:10 +00:00
CLASS="REPLACEABLE"
><I
> count</I
></TT
></DT
><DD
><P
2017-01-03 11:16:53 +00:00
>Configure the optional count parameter to sync a Smart Card to a challenge.
A count value of 0 indicates the HOTP value is to be calculated with the
current stored count.</P
2017-01-03 11:10:10 +00:00
></DD
><DT
2017-01-03 11:16:53 +00:00
>-d, --debug=<TT
2017-01-03 11:10:10 +00:00
CLASS="REPLACEABLE"
><I
> debug_level</I
></TT
></DT
><DD
><P
>Set debug level.</P
></DD
><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
>-i, --sc-index=<TT
2017-01-03 11:10:10 +00:00
CLASS="REPLACEABLE"
><I
> index</I
></TT
></DT
><DD
><P
2017-01-03 11:14:13 +00:00
>Set the 8 bit index. The Smart Card contains numerically indexed records
2017-01-03 11:10:10 +00:00
for each host system. Use the -l option to list hostnames associated with
the index. The default index is 0.</P
></DD
><DT
2017-01-03 11:16:53 +00:00
>-l, --list-readers</DT
2017-01-03 11:10:10 +00:00
><DD
><P
>List SC Readers</P
></DD
><DT
2017-01-03 11:16:53 +00:00
>-L, --sc-list-hostnames</DT
2017-01-03 11:10:10 +00:00
><DD
><P
2017-01-03 11:14:13 +00:00
>List host systems configured on the Smart Card. The index is used with the -i option.</P
2017-01-03 11:10:10 +00:00
></DD
><DT
2017-01-03 11:16:53 +00:00
>-p, --sc-reset-pin</DT
2017-01-03 11:10:10 +00:00
><DD
><P
>Set new PIN.</P
></DD
><DT
2017-01-03 11:16:53 +00:00
>-r, --reader=<TT
2017-01-03 11:10:10 +00:00
CLASS="REPLACEABLE"
><I
> reader</I
></TT
></DT
><DD
><P
2017-01-03 11:14:13 +00:00
>Set Smart Card reader. Use -l to list available readers. A reader
is defined as class:reader:[<SPAN
CLASS="OPTIONAL"
>option</SPAN
>]. PCSC and embedded
are the two available classes. The embedded class contains the acr30s driver
which is specified as embedded:acr30s:[<SPAN
CLASS="OPTIONAL"
>serial_port</SPAN
>].
If pcscd is running the first PC/SC reader will be the default followed by
the embedded acr30s driver. Use PCSC: for the first available PC/SC
reader. Use embedded:acr30s:/dev/cuaU0 for the embedded acr30s driver
with serial port /dev/cuaU0.</P
2017-01-03 11:10:10 +00:00
></DD
><DT
2017-01-03 11:16:53 +00:00
>-v, --sc-version=<TT
2017-01-03 11:10:10 +00:00
CLASS="REPLACEABLE"
><I
> card_api_version</I
></TT
></DT
><DD
><P
2017-01-03 11:14:13 +00:00
>Set the Smart Card API version. The binary API between the terminal
and Smart Card changed between version 2 and 3. See command mode notes
2017-01-03 11:10:10 +00:00
above. The default version is 3. Configuring version 2 will allow
2017-01-03 11:14:13 +00:00
maintenance of Smart Card with version 2 firmware.</P
2017-01-03 11:10:10 +00:00
></DD
><DT
2017-01-03 11:16:53 +00:00
>-V, --sc-list-version</DT
2017-01-03 11:10:10 +00:00
><DD
><P
2017-01-03 11:14:13 +00:00
>List the Smart Card firmware version.</P
2017-01-03 11:10:10 +00:00
></DD
><DT
2017-01-03 11:16:53 +00:00
>-1, --sc-get-hostp-v1</DT
2017-01-03 11:10:10 +00:00
><DD
><P
>Use the version 1 GetHOTP command instead of the default GetHOTPHostCount32.
The latter is not available on firmware revision 1. GetHOTP may be conditionally
compiled out of newer firmware.</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="AEN86"
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="AEN88"
2017-01-03 11:10:10 +00:00
></A
><P
>Generate a HOTP for the first system on the first PCSC reader found.</P
><PRE
CLASS="SCREEN"
><B
CLASS="COMMAND"
>otp-sct -r PCSC:</B
>
<SAMP
CLASS="COMPUTEROUTPUT"
>Enter PIN: 12345
HOTP: dev1.eng 2A5AB4B78D</SAMP
>&#13;</PRE
><P
></P
></DIV
><DIV
CLASS="INFORMALEXAMPLE"
><P
></P
><A
2017-01-03 11:16:53 +00:00
NAME="AEN93"
2017-01-03 11:10:10 +00:00
></A
><P
2017-01-03 11:14:13 +00:00
>List systems configured on Smart Card in default reader. Generate HOTP
2017-01-03 11:10:10 +00:00
for dev3.eng with count 32.</P
><PRE
CLASS="SCREEN"
><B
CLASS="COMMAND"
>otp-sct -L</B
>
<SAMP
CLASS="COMPUTEROUTPUT"
>Enter PIN: 12345
00:dev1.eng
01:dev2.eng
02:dev3.eng
03:vpn1.eng</SAMP
>
<B
CLASS="COMMAND"
>otp-sct -i 2 -c 32</B
>
<SAMP
CLASS="COMPUTEROUTPUT"
>Enter PIN: 12345
HOTP: dev3.eng 2A9BE3F142</SAMP
>&#13;</PRE
><P
></P
></DIV
><P
>Note that hosts with the READERKEY flag set will not be displayed.
<B
CLASS="COMMAND"
>otp-sct</B
> can not set the reader key.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
2017-01-03 11:16:53 +00:00
NAME="AEN102"
2017-01-03 11:10:10 +00:00
></A
><H2
>AUTHOR</H2
><P
>Mark Fullmer
<CODE
CLASS="EMAIL"
>&#60;<A
HREF="mailto:maf@splintered.net"
>maf@splintered.net</A
>&#62;</CODE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
2017-01-03 11:16:53 +00:00
NAME="AEN109"
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-control</SPAN
>(1)
<SPAN
CLASS="APPLICATION"
>pam_otp</SPAN
>(1)
<SPAN
CLASS="APPLICATION"
>htsoft-downloader</SPAN
>(1)
<SPAN
CLASS="APPLICATION"
>otp-ov-plugin</SPAN
>(1)
<SPAN
CLASS="APPLICATION"
>bcload</SPAN
>(1)
<SPAN
CLASS="APPLICATION"
>urd</SPAN
>(1)
<SPAN
CLASS="HARDWARE"
>spyrus-par2</SPAN
>(7)</P
></DIV
></BODY
></HTML
>