| [ << ] | [ < ] | [ Up ] | [ > ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
5.2.6 Invoking p11tool
Program that allows handling data from PKCS #11 smart cards and security modules.
To use PKCS #11 tokens with gnutls the configuration file /etc/gnutls/pkcs11.conf has to exist and contain a number of lines of the form ’load=/usr/lib/opensc-pkcs11.so’. Alternatively the p11-kit configuration files have to be setup.
To provide the PIN for all the operations below use the environment variable GNUTLS_PIN.
This section was generated by AutoGen,
using the agtexi-cmd template and the option descriptions for the p11tool program.
This software is released under the GNU General Public License, version 3 or later.
p11tool help/usage (‘--help’)
This is the automatically generated usage text for p11tool.
The text printed is the same whether selected with the help option
(‘--help’) or the more-help option (‘--more-help’). more-help will print
the usage text by passing it through a pager program.
more-help is disabled on platforms without a working
fork(2) function. The PAGER environment variable is
used to select the program, defaulting to ‘more’. Both will exit
with a status code of 0.
p11tool - GnuTLS PKCS #11 tool
Usage: p11tool [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [url]
-d, --debug=num Enable debugging
- it must be in the range:
0 to 9999
--outfile=str Output file
--list-tokens List all available tokens
--export Export the object specified by the URL
--export-chain Export the certificate specified by the URL and its chain of trust
--list-mechanisms List all available mechanisms in a token
--list-all List all available objects in a token
--list-all-certs List all available certificates in a token
--list-certs List all certificates that have an associated private key
--list-all-privkeys List all available private keys in a token
--list-privkeys an alias for the 'list-all-privkeys' option
--list-keys an alias for the 'list-all-privkeys' option
--list-all-trusted List all available certificates marked as trusted
--initialize Initializes a PKCS #11 token
--write Writes the loaded objects to a PKCS #11 token
--delete Deletes the objects matching the PKCS #11 URL
--generate-random=num Generate random data
--generate-rsa Generate an RSA private-public key pair
--generate-dsa Generate an RSA private-public key pair
--generate-ecc Generate an RSA private-public key pair
--label=str Sets a label for the write operation
--trusted Marks the object to be written as trusted
- disabled as '--no-trusted'
--private Marks the object to be written as private
- disabled as '--no-private'
- enabled by default
--login Force (user) login to token
- disabled as '--no-login'
--so-login Force security officer login to token
- disabled as '--no-so-login'
--admin-login an alias for the 'so-login' option
--detailed-url Print detailed URLs
- disabled as '--no-detailed-url'
--secret-key=str Provide a hex encoded secret key
--load-privkey=file Private key file to use
- file must pre-exist
--load-pubkey=file Public key file to use
- file must pre-exist
--load-certificate=file Certificate file to use
- file must pre-exist
-8, --pkcs8 Use PKCS #8 format for private keys
--bits=num Specify the number of bits for key generate
--sec-param=str Specify the security level
-!, --inder Use DER/RAW format for input
- disabled as '--no-inder'
-", --inraw an alias for the 'inder' option
-#, --outder Use DER format for output certificates, private keys, and DH parameters
- disabled as '--no-outder'
-$, --outraw an alias for the 'outder' option
-%, --provider=file Specify the PKCS #11 provider library
- file must pre-exist
-v, --version[=arg] output version information and exit
-h, --help display extended usage information and exit
-!, --more-help extended usage information passed thru pager
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
Operands and options may be intermixed. They will be reordered.
Program that allows handling data from PKCS #11 smart cards and security
modules.
To use PKCS #11 tokens with gnutls the configuration file
/etc/gnutls/pkcs11.conf has to exist and contain a number of lines of the
form 'load=/usr/lib/opensc-pkcs11.so'. Alternatively the p11-kit
configuration files have to be setup.
To provide the PIN for all the operations below use the environment
variable GNUTLS_PIN.
Please send bug reports to: <@PACKAGE_BUGREPORT@>
debug option (-d)
This is the “enable debugging” option. This option takes a number argument. Specifies the debug level.
export-chain option
This is the “export the certificate specified by the url and its chain of trust” option. Exports the certificate specified by the URL and generates its chain of trust based on the stored certificates in the module.
list-all-privkeys option
This is the “list all available private keys in a token” option. Lists all the private keys in a token that match the specified URL.
list-privkeys option
This is an alias for the list-all-privkeys option,
see the list-all-privkeys option documentation.
list-keys option
This is an alias for the list-all-privkeys option,
see the list-all-privkeys option documentation.
write option
This is the “writes the loaded objects to a pkcs #11 token” option. It can be used to write private keys, certificates or secret keys to a token.
generate-random option
This is the “generate random data” option. This option takes a number argument. Asks the token to generate a number of bytes of random bytes.
generate-rsa option
This is the “generate an rsa private-public key pair” option. Generates an RSA private-public key pair on the specified token.
generate-dsa option
This is the “generate an rsa private-public key pair” option. Generates an RSA private-public key pair on the specified token.
generate-ecc option
This is the “generate an rsa private-public key pair” option. Generates an RSA private-public key pair on the specified token.
private option
This is the “marks the object to be written as private” option.
This option has some usage constraints. It:
- can be disabled with –no-private.
- It is enabled by default.
The written object will require a PIN to be used.
so-login option
This is the “force security officer login to token” option.
This option has some usage constraints. It:
- can be disabled with –no-so-login.
Forces login to the token as security officer (admin).
admin-login option
This is an alias for the so-login option,
see the so-login option documentation.
sec-param option
This is the “specify the security level” option. This option takes a string argument ‘Security parameter’. This is alternative to the bits option. Available options are [low, legacy, normal, high, ultra].
inder option
This is the “use der/raw format for input” option.
This option has some usage constraints. It:
- can be disabled with –no-inder.
Use DER/RAW format for input certificates and private keys.
inraw option
This is an alias for the inder option,
see the inder option documentation.
outder option
This is the “use der format for output certificates, private keys, and dh parameters” option.
This option has some usage constraints. It:
- can be disabled with –no-outder.
The output will be in DER or RAW format.
outraw option
This is an alias for the outder option,
see the outder option documentation.
provider option
This is the “specify the pkcs #11 provider library” option. This option takes a file argument. This will override the default options in /etc/gnutls/pkcs11.conf
p11tool exit status
One of the following exit values will be returned:
- ‘0 (EXIT_SUCCESS)’
Successful program execution.
- ‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid.
p11tool See Also
p11tool Examples
To view all tokens in your system use:
$ p11tool --list-tokens
To view all objects in a token use:
$ p11tool --login --list-all "pkcs11:TOKEN-URL"
To store a private key and a certificate in a token run:
$ p11tool --login --write "pkcs11:URL" --load-privkey key.pem \
--label "Mykey"
$ p11tool --login --write "pkcs11:URL" --load-certificate cert.pem \
--label "Mykey"
Note that some tokens require the same label to be used for the certificate and its corresponding private key.
To generate an RSA private key inside the token use:
$ p11tool --login --generate-rsa --bits 1024 --label "MyNewKey" \
--outfile MyNewKey.pub "pkcs11:TOKEN-URL"
The bits parameter in the above example is explicitly set because some tokens only support a limited number of bits. The output file is the corresponding public key. This key can be used to general a certificate request with certtool.
certtool --generate-request --load-privkey "pkcs11:KEY-URL" \ --load-pubkey MyNewKey.pub --outfile request.pem
| [ << ] | [ < ] | [ Up ] | [ > ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This document was generated on February 9, 2014 using texi2html 5.0.