pkcs15-tool (1) - Linux Manuals

pkcs15-tool: utility for manipulating PKCS #15 data structures on smart cards and similar security tokens

NAME

pkcs15-tool - utility for manipulating PKCS #15 data structures on smart cards and similar security tokens

SYNOPSIS

pkcs15-tool [OPTIONS]

DESCRIPTION

The pkcs15-tool utility is used to manipulate the PKCS #15 data structures on smart cards and similar security tokens. Users can list and read PINs, keys and certificates stored on the token. User PIN authentication is performed for those operations that require it.

OPTIONS

--learn-card, -L

Cache PKCS #15 token data to the local filesystem. Subsequent operations are performed on the cached data where possible. If the cache becomes out-of-sync with the token state (eg. new key is generated and stored on the token), the cache should be updated or operations may show stale results.

--read-certificate cert, -r cert

Reads the certificate with the given id.

--list-certificates, -c

Lists all certificates stored on the token.

--list-pins

Lists all PINs stored on the token. General information about each PIN is listed (eg. PIN name). Actual PIN values are not shown.

--change-pin

Changes a PIN stored on the token. User authentication is required for this operation.

--unblock-pin, -u

Unblocks a PIN stored on the token. Knowledge of the Pin Unblock Key (PUK) is required for this operation.

--list-keys, -k

Lists all private keys stored on the token. General information about each private key is listed (eg. key name, id and algorithm). Actual private key values are not displayed.

--list-public-keys

Lists all public keys stored on the token, including key name, id, algorithm and length information.

--read-public-key id

Reads the public key with id id, allowing the user to extract and store or use the public key.

--read-ssh-key id

Reads the public key with id id, writing the output in format suitable for $HOME/.ssh/authorized_keys.

--output filename, -o filename

Specifies where key output should be written. If filename already exists, it will be overwritten. If this option is not given, keys will be printed to standard output.

--no-cache

Disables token data caching.

--pin-id pin, -a pin

Specifies the auth id of the PIN to use for the operation. This is useful with the --change-pin operation.

--reader num

Forces pkcs15-tool to use reader number num for operations. The default is to use reader number 0, the first reader in the system.

--verbose, -v

Causes pkcs15-tool to be more verbose. Specify this flag several times to enable debug output in the OpenSC library.

SEE ALSO

opensc(7), pkcs15-init(1), pkcs15-crypt(1)