ootp/doc/otp-sct.1

145 lines
4.2 KiB
Groff
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

...\" $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-sct\fP" "1"
.SH "NAME"
\fBotp-sct\fP \(em Smart Card Terminal for One Time Password package\&.
.SH "SYNOPSIS"
.PP
\fBotp-sct\fP [-1hlpv?] [-c\fI count\fP] [-d\fI debug_level\fP] [-i\fI index\fP] [-r\fI reader\fP] [-v\fI firmware_api_version\fP]
.SH "DESCRIPTION"
.PP
The \fBotp-sct\fP command is a user interface to generating
One Time Passwords with a Smart Card loaded with OTP software\&.
.SH "OPTIONS"
.IP "-c, --sc-count=\fI count\fP" 10
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\&.
.IP "-d, --debug=\fI debug_level\fP" 10
Set debug level\&.
.IP "-h, --help" 10
Help\&.
.IP "-i, --sc-index=\fI index\fP" 10
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\&.
.IP "-l, --list-readers" 10
List SC Readers
.IP "-L, --sc-list-hostnames" 10
List host systems configured on the Smart Card\&. The index is used with the -i option\&.
.IP "-p, --sc-reset-pin" 10
Set new PIN\&.
.IP "-r, --reader=\fI reader\fP" 10
Set Smart Card reader\&. Use -l to list available readers\&. A reader
is defined as class:reader:[option]\&. PCSC and embedded
are the two available classes\&. The embedded class contains the acr30s driver
which is specified as embedded:acr30s:[serial_port]\&.
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\&.
.IP "-v, --sc-version=\fI card_api_version\fP" 10
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\&.
.IP "-V, --sc-list-version" 10
List the Smart Card firmware version\&.
.IP "-1, --sc-get-hostp-v1" 10
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\&.
.IP "--version" 10
Display software version\&.
.SH "EXAMPLES"
.PP
Generate a HOTP for the first system on the first PCSC reader found\&.
.PP
.nf
\fBotp-sct -r PCSC:\fP
\f(CWEnter PIN: 12345
HOTP: dev1\&.eng 2A5AB4B78D\fP
.fi
.PP
List systems configured on Smart Card in default reader\&. Generate HOTP
for dev3\&.eng with count 32\&.
.PP
.nf
\fBotp-sct -L\fP
\f(CWEnter PIN: 12345
00:dev1\&.eng
01:dev2\&.eng
02:dev3\&.eng
03:vpn1\&.eng\fP
\fBotp-sct -i 2 -c 32\fP
\f(CWEnter PIN: 12345
HOTP: dev3\&.eng 2A9BE3F142\fP
.fi
.PP
Note that hosts with the READERKEY flag set will not be displayed\&.
\fBotp-sct\fP can not set the reader key\&.
.SH "AUTHOR"
.PP
Mark Fullmer maf@splintered\&.net
.SH "SEE ALSO"
.PP
\fBotp-sca\fP(1)
\fBotp-control\fP(1)
\fBpam_otp\fP(1)
\fBhtsoft-downloader\fP(1)
\fBotp-ov-plugin\fP(1)
\fBbcload\fP(1)
\fBurd\fP(1)
spyrus-par2(7)
...\" created by instant / docbook-to-man, Thu 12 Dec 2013, 10:40