ootp/doc/otp-sct.sgml

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">

<!-- $Id: otp-sct.sgml 126 2010-06-15 14:23:02Z maf $ -->

<refentry>

<refmeta>
<refentrytitle>
<application>otp-sct</application>
</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>
<application>otp-sct</application>
</refname>
<refpurpose>
Smart Card Terminal for One Time Password package.
</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
<command>otp-sct</command>
<arg>-1hlpv?</arg>
<arg>-c<replaceable> count</replaceable></arg>
<arg>-d<replaceable> debug_level</replaceable></arg>
<arg>-i<replaceable> index</replaceable></arg>
<arg>-r<replaceable> reader</replaceable></arg>
<arg>-v<replaceable> firmware_api_version</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>DESCRIPTION</title>
<para>
The <command>otp-sct</command> command is a user interface to generating
One Time Passwords with a Smart Card loaded with OTP software.
</para>
</refsect1>

<refsect1>
<title>OPTIONS</title>
<variablelist>

<varlistentry>
<term>-c, --sc-count=<replaceable> count</replaceable></term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-d, --debug=<replaceable> debug_level</replaceable></term>
<listitem>
<para>
Set debug level.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-h, --help</term>
<listitem>
<para>
Help.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-i, --sc-index=<replaceable> index</replaceable></term>
<listitem>
<para>
Set the 8 bit index.  The Smart Card contains numerically indexed records
for each host system.  Use the -l option to list hostnames associated with
the index.  The default index is 0.
</para>
</listitem>

<varlistentry>
<term>-l, --list-readers</term>
<listitem>
<para>
List SC Readers
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-L, --sc-list-hostnames</term>
<listitem>
<para>
List host systems configured on the Smart Card.  The index is used with the -i option.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-p, --sc-reset-pin</term>
<listitem>
<para>
Set new PIN.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-r, --reader=<replaceable> reader</replaceable></term>
<listitem>
<para>
Set Smart Card reader.  Use -l to list available readers.  A reader
is defined as class:reader:<optional>option</optional>.  PCSC and embedded
are the two available classes.  The embedded class contains the acr30s driver
which is specified as embedded:acr30s:<optional>serial_port</optional>.
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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-v, --sc-version=<replaceable> card_api_version</replaceable></term>
<listitem>
<para>
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
above.  The default version is 3.  Configuring version 2 will allow
maintenance of Smart Card with version 2 firmware.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-V, --sc-list-version</term>
<listitem>
<para>
List the Smart Card firmware version.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>-1, --sc-get-hostp-v1</term>
<listitem>
<para>
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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>--version</term>
<listitem>
<para>
Display software version.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>EXAMPLES</title>

<informalexample>
<para>
Generate a HOTP for the first system on the first PCSC reader found.
</para>
<screen>
<command>otp-sct -r PCSC:</command>

<computeroutput>Enter PIN: 12345
HOTP: dev1.eng 2A5AB4B78D</computeroutput>

</screen>
</informalexample>

<informalexample>
<para>
List systems configured on Smart Card in default reader.  Generate HOTP
for dev3.eng with count 32.
</para>
<screen>
<command>otp-sct -L</command>

<computeroutput>Enter PIN: 12345
00:dev1.eng
01:dev2.eng
02:dev3.eng
03:vpn1.eng</computeroutput>

<command>otp-sct -i 2 -c 32</command>

<computeroutput>Enter PIN: 12345
HOTP: dev3.eng 2A9BE3F142</computeroutput>

</screen>
</informalexample>

<para>
Note that hosts with the READERKEY flag set will not be displayed.
<command>otp-sct</command> can not set the reader key.
</para>

</refsect1>

<refsect1>
<title>AUTHOR</title>
<para>
<author>
<firstname>Mark</firstname>
<surname>Fullmer</surname>
</author>
<email>maf@splintered.net</email>
</para>
</refsect1>

<refsect1>
<title>SEE ALSO</title>
<para>
<application>otp-sca</application>(1)
<application>otp-control</application>(1)
<application>pam_otp</application>(1)
<application>htsoft-downloader</application>(1)
<application>otp-ov-plugin</application>(1)
<application>bcload</application>(1)
<application>urd</application>(1)
<hardware>spyrus-par2</hardware>(7)
</para>
</refsect1>

</refentry>