1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
@node p11tool Invocation
@subsection Invoking p11tool
@pindex p11tool
@ignore
# -*- buffer-read-only: t -*- vi: set ro:
#
# DO NOT EDIT THIS FILE (invoke-p11tool.texi)
#
# It has been AutoGen-ed January 1, 2013 at 09:07:59 PM by AutoGen 5.16
# From the definitions ../src/p11tool-args.def
# and the template file agtexi-cmd.tpl
@end ignore
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'.
This section was generated by @strong{AutoGen},
using the @code{agtexi-cmd} template and the option descriptions for the @code{p11tool} program.
This software is released under the GNU General Public License, version 3 or later.
@anchor{p11tool usage}
@subsubheading p11tool help/usage (-h)
@cindex p11tool help
This is the automatically generated usage text for p11tool.
The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!). @code{more-help} will print
the usage text by passing it through a pager program.
@code{more-help} is disabled on platforms without a working
@code{fork(2)} function. The @code{PAGER} environment variable is
used to select the program, defaulting to @file{more}. Both will exit
with a status code of 0.
@exampleindent 0
@example
p11tool - GnuTLS PKCS #11 tool - Ver. @@VERSION@@
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
--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-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-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 login to token
- disabled as --no-login
--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 This is an alias for 'inder'
--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'.
please send bug reports to: bug-gnutls@@gnu.org
@end example
@exampleindent 4
@anchor{p11tool debug}
@subsubheading debug option (-d)
This is the ``enable debugging.'' option.
This option takes an argument number.
Specifies the debug level.
@anchor{p11tool write}
@subsubheading 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.
@anchor{p11tool generate-rsa}
@subsubheading 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.
@anchor{p11tool generate-dsa}
@subsubheading 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.
@anchor{p11tool generate-ecc}
@subsubheading 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.
@anchor{p11tool private}
@subsubheading private option
This is the ``marks the object to be written as private'' option.
@noindent
This option has some usage constraints. It:
@itemize @bullet
@item
is enabled by default.
@end itemize
The written object will require a PIN to be used.
@anchor{p11tool sec-param}
@subsubheading sec-param option
This is the ``specify the security level'' option.
This option takes an argument string @file{Security parameter}.
This is alternative to the bits option. Available options are [low, legacy, normal, high, ultra].
@anchor{p11tool inder}
@subsubheading inder option
This is the ``use der/raw format for input'' option.
Use DER/RAW format for input certificates and private keys.
@anchor{p11tool inraw}
@subsubheading inraw option
This is an alias for the inder option,
@pxref{p11tool inder, the inder option documentation}.
@anchor{p11tool provider}
@subsubheading provider option
This is the ``specify the pkcs #11 provider library'' option.
This option takes an argument file.
This will override the default options in /etc/gnutls/pkcs11.conf
@anchor{p11tool exit status}
@subsubheading p11tool exit status
One of the following exit values will be returned:
@table @samp
@item 0 (EXIT_SUCCESS)
Successful program execution.
@item 1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid.
@end table
@anchor{p11tool See Also}
@subsubheading p11tool See Also
certtool (1)
@anchor{p11tool Examples}
@subsubheading p11tool Examples
To view all tokens in your system use:
@example
$ p11tool --list-tokens
@end example
To view all objects in a token use:
@example
$ p11tool --login --list-all "pkcs11:TOKEN-URL"
@end example
To store a private key and a certificate in a token run:
@example
$ p11tool --login --write "pkcs11:URL" --load-privkey key.pem \
--label "Mykey"
$ p11tool --login --write "pkcs11:URL" --load-certificate cert.pem \
--label "Mykey"
@end example
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:
@example
$ p11tool --login --generate-rsa --bits 1024 --label "MyNewKey" \
--outfile MyNewKey.pub "pkcs11:TOKEN-URL"
@end example
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.
@example
certtool --generate-request --load-privkey "pkcs11:KEY-URL" \
--load-pubkey MyNewKey.pub --outfile request.pem
@end example
|
