diff options
Diffstat (limited to 'usr/src/man/man1m')
| -rw-r--r-- | usr/src/man/man1m/ccidadm.1m | 90 |
1 files changed, 80 insertions, 10 deletions
diff --git a/usr/src/man/man1m/ccidadm.1m b/usr/src/man/man1m/ccidadm.1m index 686db8cb46..d1a09e25cf 100644 --- a/usr/src/man/man1m/ccidadm.1m +++ b/usr/src/man/man1m/ccidadm.1m @@ -18,14 +18,14 @@ .Nm ccidadm .Nd CCID administration utility .Sh SYNOPSIS -.Nm /usr/lib/ccid/ccidadm -.Ar list -.Nm /usr/lib/ccid/ccidadm -.Ar atr +.Nm +.Cm list +.Nm +.Cm atr .Op Fl pvx .Op Ar device -.Nm /usr/lib/ccid/ccidadm -.Ar reader +.Nm +.Cm reader .Op Ar device .Sh DESCRIPTION The @@ -48,7 +48,8 @@ Any command .Nm understands. See section -.Sx COMMANDS . +.Sx COMMANDS +for more information. .It Ar device Specifies a CCID reader or a slot, either as absolute path to the device node or in a short-hand form. @@ -85,11 +86,11 @@ in the system. A human-readable summary of the ATR data is printed when no flags are given. The following options can be used to alter the output of the .Cm atr -command:: +command: .Bl -tag -width Ds .It Fl v Verbose output, the individual bytes of the ATR are printed and decoded -bit-by-bit in a human-readable form. +in a human-readable form. Additionally the historic data in the ATR is printed as a hexadecimal dump. .It Fl x The complete ATR is printed as a hexadecimal dump. @@ -105,7 +106,75 @@ If no device is given, the command will print the capabilities of all attached CCID readers. .El .Sh EXIT STATUS -.Ex -std +The +.Nm +utility exits 0 on success, 1 on any error opening or accessing the device, and +2 if no command or an unknown command are given. +.Sh EXAMPLES +.Bl -tag -width "" +.It Sy Example 1: List all CCID devices +.Bd -literal +# ccidadm list +PRODUCT DEVICE CARD STATE TRANSPORT SUPPORTED +Yubikey 4 OTP+U2F+CCID ccid0/slot0 activated APDU (T=1) supported +Yubikey 4 OTP+U2F+CCID ccid1/slot0 unactivated APDU supported +Smart Card Reader USB ccid2/slot0 missing TPDU unsupported +Smart Card Reader USB ccid3/slot0 unactivated TPDU unsupported +.Ed +.It Sy Example 2: Get the ATR of a Yubikey +.Bd -literal +# ccidadm atr ccid0/slot0 +ATR for ccid0/slot0 (18 bytes): +ICC supports protocol(s): T=1 +Card protocol is negotiable; starts with default T=1 parameters +Reader will run ICC at ICC's Di/Fi values +T=1 properties that would be negotiated: + + Fi/Fmax Index: 1 (Fi 372/Fmax 5 MHz) + + Di Index: 3 (Di 4) + + Checksum: LRC + + Extra Guardtime: 0 + + BWI: 1 + + CWI: 5 + + Clock Stop: 0 (disallowed) + + IFSC: 254 + + CCID Supports NAD: no +.Ed +.It Sy Example 2: Get capabilities of a Smart Card Reader +.Bd -literal +# ccidadm reader ccid3 +Reader ccid3, CCID class v1.0 device: + Product: Smart Card Reader USB + Serial: <unknown> + Slots Present: 1 + Maximum Busy Slots: 1 + Supported Voltages: + + 5.0 V + + 3.0 V + + 1.8 V + Supported Protocols: + + T=0 + + T=1 + Default Clock: 3.69 MHz + Maximum Clock: 3.69 MHz + Supported Clock Rates: 1 + Default Data Rate: 9.92 Kbps + Maximum Data Rate: 318 Kbps + Supported Data Rates: 19 + Maximum IFSD (T=1 only): 254 + Synchronous Protocols Supported: + + 2-Wire Support + + 3-Wire Support + + I2C Support + Device Features: + + Automatic ICC clock frequency change + + Automatic baud rate change + + Automatic PPS made by CCID + + CCID can set ICC in clock stop mode + + NAD value other than zero accepted + + TPDU support + Maximum Message Length: 271 bytes +.Ed +.El .Sh INTERFACE STABILITY The command line interface of .Nm @@ -117,4 +186,5 @@ is .Sy Not-an-Interface and may change any time. .Sh SEE ALSO +.Xr cfgadm 1M , .Xr ccid 7D |