From 6701d063c30db9a5c44e38cae1f98e9bbacd0eec Mon Sep 17 00:00:00 2001 From: dengert Date: Tue, 29 Mar 2011 18:08:22 +0000 Subject: [PATCH] Add a piv-tool.xml for man page. See #338 git-svn-id: https://www.opensc-project.org/svnp/opensc/trunk@5274 c6295689-39f2-0310-b995-f0e70906c6a9 --- doc/tools/piv-tool.xml | 130 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 doc/tools/piv-tool.xml diff --git a/doc/tools/piv-tool.xml b/doc/tools/piv-tool.xml new file mode 100644 index 00000000..a702fe4e --- /dev/null +++ b/doc/tools/piv-tool.xml @@ -0,0 +1,130 @@ + + + + piv-tool + 1 + opensc + + + + piv-tool + smart card utility for HSPD-12 PIV cards + + + + Synopsis + + piv-tool [OPTIONS] + + + + + + The piv-tool utility can be used from the command line to perform + miscellaneous smart card operations on a HSPD-12 PIV smart card as defined in NIST 800-73-3. + It is intened for use with test cards only. It can be used to load objects, and generate + key pairs, as well as send arbitrary APDU commands to a card after having authenticated + to the card using the card key provided by the card vendor. + + + + + Options + + + + + Print the derived card serial number from the CHUID object if any. + output is in hex byte format. + + + + Print the name of the inserted card (driver) + + + argument, arguement + Authenticate to the card using a 2DES or 3DES key. + An arguement {A|M}:{ref}:{alg} is required, were A uses "EXTERNAL AUTHENTICATION" + and M uses "MUTUAL AUTHENTICATION". ref is normally 9B, and alg is 03 for + 3DES. The key is provided by card vendor, and the environment variable + PIV_EXT_AUTH_KEY must point to a text file with the key in the format: + XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX:XX + + + + + Authenticate to the card using the user pin. + + + + + argument, argument + Generate a key pair on the card and output the public key. + An argument {ref}:{alg} is required, where ref is 9A, 9C, 9D or 9E and alg is + 06, 07, 11 or 14 for RSA 1024, RSA 2048, ECC 256 or ECC 384. + + + + ContainerID, ContainerID + Load an object on to the card. The ContainerID is defined + in NIST 800-73-n without leading 0x. Example: CHUID object is 3000 + + + + + ref, ref + Load a certificate on to the card. ref is 9A, 9C, 9D or 9E + + + + ref, ref + Load a certificate that has been gziped on to the card. + ref is 9A, 9C, 9D or 9E + + + + file, file + Output file for any operation that produces output. + + + + + file, file + Input file for any operation that requires an input file. + + + + + apdu, apdu + Sends an arbitrary APDU to the card in the format AA:BB:CC:DD:EE:FF... + This option may be repeated. + + + + num + Use the given reader number. The default is 0, + the first reader in the system. + + + driver, driver + Use the given card driver. The default is auto-detected. + + + + Wait for a card to be inserted + + + + Causes piv-tool to be more verbose. + Specify this flag several times to enable debug output in the opensc library. + + + + + + + See also + opensc-tool(1) + + +