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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is last updated 1 January 2014 for version
3.2.10 of GnuTLS.
Copyright (C) 2001-2013 Free Software Foundation, Inc.\\
Copyright (C) 2001-2013 Nikos Mavrogiannopoulos
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GnuTLS 3.2.10: p11tool Invocation</title>
<meta name="description" content="GnuTLS 3.2.10: p11tool Invocation">
<meta name="keywords" content="GnuTLS 3.2.10: p11tool Invocation">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-and-Data-Index.html#Function-and-Data-Index" rel="index" title="Function and Data Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Smart-cards-and-HSMs.html#Smart-cards-and-HSMs" rel="up" title="Smart cards and HSMs">
<link href="Trusted-Platform-Module.html#Trusted-Platform-Module" rel="next" title="Trusted Platform Module">
<link href="Using-a-PKCS11-token-with-TLS.html#Using-a-PKCS11-token-with-TLS" rel="prev" title="Using a PKCS11 token with TLS">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
body {
margin: 2%;
padding: 0 5%;
background: #ffffff;
}
h1,h2,h3,h4,h5 {
font-weight: bold;
padding: 5px 5px 5px 5px;
background-color: #c2e0ff;
color: #336699;
}
h1 {
padding: 2em 2em 2em 5%;
color: white;
background: #336699;
text-align: center;
letter-spacing: 3px;
}
h2 { text-decoration: underline; }
pre {
margin: 0 5%;
padding: 0.5em;
}
pre.example,pre.verbatim {
padding-bottom: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 1px 1px 1px 5px;
margin: 1em auto;
width: 90%;
}
div.node {
margin: 0 -5% 0 -2%;
padding: 0.5em 0.5em;
margin-top: 0.5em;
margin-bottom: 0.5em;
font-weight: bold;
}
dd, li {
padding-top: 0.1em;
padding-bottom: 0.1em;
}
div.float {
margin-bottom: 0.5em;
text-align: center;
}
table {
text-align: left;
margin-left:auto;
margin-right:auto;
width: 50%;
}
th {
padding: 0;
color: #336699;
background-color: #c2e0ff;
border: solid #000000;
border-width: 0px;
margin: 1em auto;
text-align: center;
margin-left:auto;
margin-right:auto;
}
td {
padding: 0;
border: solid #000000;
background-color: #f0faff;
border-width: 0px;
margin: 1em auto;
text-align: left;
margin-left:auto;
margin-right:auto;
padding-left: 1em;
}
dl {
text-align: left;
margin-left:auto;
margin-right:auto;
width: 50%;
padding-left: 1em;
border: solid #c2e0ff;
background: #f0faff;
border-width: 5px 1px 1px 1px;
margin: 1em auto;
}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="p11tool-Invocation"></a>
<div class="header">
<p>
Previous: <a href="Using-a-PKCS11-token-with-TLS.html#Using-a-PKCS11-token-with-TLS" accesskey="p" rel="prev">Using a PKCS11 token with TLS</a>, Up: <a href="Smart-cards-and-HSMs.html#Smart-cards-and-HSMs" accesskey="u" rel="up">Smart cards and HSMs</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Invoking-p11tool"></a>
<h4 class="subsection">5.2.6 Invoking p11tool</h4>
<a name="index-p11tool"></a>
<p>Program that allows handling data from PKCS #11 smart cards
and security modules.
</p>
<p>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.
</p>
<p>To provide the PIN for all the operations below use the environment variable
GNUTLS_PIN.
</p>
<p>This section was generated by <strong>AutoGen</strong>,
using the <code>agtexi-cmd</code> template and the option descriptions for the <code>p11tool</code> program.
This software is released under the GNU General Public License, version 3 or later.
</p>
<a name="p11tool-usage"></a><a name="p11tool-help_002fusage-_0028_002d_002dhelp_0029"></a>
<h4 class="subsubheading">p11tool help/usage (<samp>--help</samp>)</h4>
<a name="index-p11tool-help"></a>
<p>This is the automatically generated usage text for p11tool.
</p>
<p>The text printed is the same whether selected with the <code>help</code> option
(<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
the usage text by passing it through a pager program.
<code>more-help</code> is disabled on platforms without a working
<code>fork(2)</code> function. The <code>PAGER</code> environment variable is
used to select the program, defaulting to <samp>more</samp>. Both will exit
with a status code of 0.
</p>
<div class="example">
<pre class="example">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@>
</pre></div>
<a name="p11tool-debug"></a><a name="debug-option-_0028_002dd_0029-5"></a>
<h4 class="subsubheading">debug option (-d)</h4>
<p>This is the “enable debugging” option.
This option takes a number argument.
Specifies the debug level.
<a name="p11tool-export_002dchain"></a></p><a name="export_002dchain-option"></a>
<h4 class="subsubheading">export-chain option</h4>
<p>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.
<a name="p11tool-list_002dall_002dprivkeys"></a></p><a name="list_002dall_002dprivkeys-option"></a>
<h4 class="subsubheading">list-all-privkeys option</h4>
<p>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.
<a name="p11tool-list_002dprivkeys"></a></p><a name="list_002dprivkeys-option"></a>
<h4 class="subsubheading">list-privkeys option</h4>
<p>This is an alias for the <code>list-all-privkeys</code> option,
see <a href="#p11tool-list_002dall_002dprivkeys">the list-all-privkeys option documentation</a>.
</p>
<a name="p11tool-list_002dkeys"></a><a name="list_002dkeys-option"></a>
<h4 class="subsubheading">list-keys option</h4>
<p>This is an alias for the <code>list-all-privkeys</code> option,
see <a href="#p11tool-list_002dall_002dprivkeys">the list-all-privkeys option documentation</a>.
</p>
<a name="p11tool-write"></a><a name="write-option"></a>
<h4 class="subsubheading">write option</h4>
<p>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.
<a name="p11tool-generate_002drandom"></a></p><a name="generate_002drandom-option"></a>
<h4 class="subsubheading">generate-random option</h4>
<p>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.
<a name="p11tool-generate_002drsa"></a></p><a name="generate_002drsa-option"></a>
<h4 class="subsubheading">generate-rsa option</h4>
<p>This is the “generate an rsa private-public key pair” option.
Generates an RSA private-public key pair on the specified token.
<a name="p11tool-generate_002ddsa"></a></p><a name="generate_002ddsa-option"></a>
<h4 class="subsubheading">generate-dsa option</h4>
<p>This is the “generate an rsa private-public key pair” option.
Generates an RSA private-public key pair on the specified token.
<a name="p11tool-generate_002decc"></a></p><a name="generate_002decc-option"></a>
<h4 class="subsubheading">generate-ecc option</h4>
<p>This is the “generate an rsa private-public key pair” option.
Generates an RSA private-public key pair on the specified token.
<a name="p11tool-private"></a></p><a name="private-option"></a>
<h4 class="subsubheading">private option</h4>
<p>This is the “marks the object to be written as private” option.
</p>
<p>This option has some usage constraints. It:
</p><ul>
<li> can be disabled with –no-private.
</li><li> It is enabled by default.
</li></ul>
<p>The written object will require a PIN to be used.
<a name="p11tool-so_002dlogin"></a></p><a name="so_002dlogin-option"></a>
<h4 class="subsubheading">so-login option</h4>
<p>This is the “force security officer login to token” option.
</p>
<p>This option has some usage constraints. It:
</p><ul>
<li> can be disabled with –no-so-login.
</li></ul>
<p>Forces login to the token as security officer (admin).
<a name="p11tool-admin_002dlogin"></a></p><a name="admin_002dlogin-option"></a>
<h4 class="subsubheading">admin-login option</h4>
<p>This is an alias for the <code>so-login</code> option,
see <a href="#p11tool-so_002dlogin">the so-login option documentation</a>.
</p>
<a name="p11tool-sec_002dparam"></a><a name="sec_002dparam-option-1"></a>
<h4 class="subsubheading">sec-param option</h4>
<p>This is the “specify the security level” option.
This option takes a string argument <samp>Security parameter</samp>.
This is alternative to the bits option. Available options are [low, legacy, normal, high, ultra].
<a name="p11tool-inder"></a></p><a name="inder-option-2"></a>
<h4 class="subsubheading">inder option</h4>
<p>This is the “use der/raw format for input” option.
</p>
<p>This option has some usage constraints. It:
</p><ul>
<li> can be disabled with –no-inder.
</li></ul>
<p>Use DER/RAW format for input certificates and private keys.
<a name="p11tool-inraw"></a></p><a name="inraw-option-2"></a>
<h4 class="subsubheading">inraw option</h4>
<p>This is an alias for the <code>inder</code> option,
see <a href="#p11tool-inder">the inder option documentation</a>.
</p>
<a name="p11tool-outder"></a><a name="outder-option-1"></a>
<h4 class="subsubheading">outder option</h4>
<p>This is the “use der format for output certificates, private keys, and dh parameters” option.
</p>
<p>This option has some usage constraints. It:
</p><ul>
<li> can be disabled with –no-outder.
</li></ul>
<p>The output will be in DER or RAW format.
<a name="p11tool-outraw"></a></p><a name="outraw-option-1"></a>
<h4 class="subsubheading">outraw option</h4>
<p>This is an alias for the <code>outder</code> option,
see <a href="#p11tool-outder">the outder option documentation</a>.
</p>
<a name="p11tool-provider"></a><a name="provider-option"></a>
<h4 class="subsubheading">provider option</h4>
<p>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
<a name="p11tool-exit-status"></a></p><a name="p11tool-exit-status-1"></a>
<h4 class="subsubheading">p11tool exit status</h4>
<p>One of the following exit values will be returned:
</p><dl compact="compact">
<dt>‘<samp>0 (EXIT_SUCCESS)</samp>’</dt>
<dd><p>Successful program execution.
</p></dd>
<dt>‘<samp>1 (EXIT_FAILURE)</samp>’</dt>
<dd><p>The operation failed or the command syntax was not valid.
</p></dd>
</dl>
<a name="p11tool-See-Also"></a><a name="p11tool-See-Also-1"></a>
<h4 class="subsubheading">p11tool See Also</h4>
<p>certtool (1)
<a name="p11tool-Examples"></a></p><a name="p11tool-Examples-1"></a>
<h4 class="subsubheading">p11tool Examples</h4>
<p>To view all tokens in your system use:
</p><div class="example">
<pre class="example">$ p11tool --list-tokens
</pre></div>
<p>To view all objects in a token use:
</p><div class="example">
<pre class="example">$ p11tool --login --list-all "pkcs11:TOKEN-URL"
</pre></div>
<p>To store a private key and a certificate in a token run:
</p><div class="example">
<pre class="example">$ p11tool --login --write "pkcs11:URL" --load-privkey key.pem \
--label "Mykey"
$ p11tool --login --write "pkcs11:URL" --load-certificate cert.pem \
--label "Mykey"
</pre></div>
<p>Note that some tokens require the same label to be used for the certificate
and its corresponding private key.
</p>
<p>To generate an RSA private key inside the token use:
</p><div class="example">
<pre class="example">$ p11tool --login --generate-rsa --bits 1024 --label "MyNewKey" \
--outfile MyNewKey.pub "pkcs11:TOKEN-URL"
</pre></div>
<p>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.
</p><div class="example">
<pre class="example">certtool --generate-request --load-privkey "pkcs11:KEY-URL" \
--load-pubkey MyNewKey.pub --outfile request.pem
</pre></div>
<hr>
<div class="header">
<p>
Previous: <a href="Using-a-PKCS11-token-with-TLS.html#Using-a-PKCS11-token-with-TLS" accesskey="p" rel="prev">Using a PKCS11 token with TLS</a>, Up: <a href="Smart-cards-and-HSMs.html#Smart-cards-and-HSMs" accesskey="u" rel="up">Smart cards and HSMs</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-and-Data-Index.html#Function-and-Data-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
