1PKCS11-TOOL(1) OpenSC Tools PKCS11-TOOL(1)
2
6 pkcs11-tool - utility for managing and using PKCS #11 security tokens
7
9 pkcs11-tool [OPTIONS]
10
12 The pkcs11-tool utility is used to manage the data objects on smart
13 cards and similar PKCS #11 security tokens. Users can list and read
14 PINs, keys and certificates stored on the token. User PIN
15 authentication is performed for those operations that require it.
16
18 --attr-from path
19 Extract information from path (DER-encoded certificate file) and
20 create the corresponding attributes when writing an object to the
21 token. Example: the certificate subject name is used to create the
22 CKA_SUBJECT attribute.
23 --change-pin, -c
25 Change the user PIN on the token
26 --unlock-pin
28 Unlock User PIN (without --login unlock in logged in session;
29 otherwise --login-type has to be 'context-specific').
30 --hash, -h
32 Hash some data.
33 --id id, -d id
35 Specify the id of the object to operate on.
36 --init-pin
38 Initializes the user PIN. This option differs from --change-pin in
39 that it sets the user PIN for the first time. Once set, the user
40 PIN can be changed using --change-pin.
41 --init-token
43 Initialize a token: set the token label as well as a Security
44 Officer PIN (the label must be specified using --label).
45 --input-file path, -i path
47 Specify the path to a file for input.
48 --keypairgen, -k
50 Generate a new key pair (public and private pair.)
51 --key-type <replacement>specification</replacement>
53 Specify the type and length of the key to create, for example
54 rsa:1024 or EC:prime256v1.
55 --usage-sign
57 Specify 'sign' key usage flag (sets SIGN in privkey, sets VERIFY in
58 pubkey).
59 --usage-decrypt
61 Specify 'decrypt' key usage flag (RSA only, set DECRYPT privkey,
62 ENCRYPT in pubkey).
63 --usage-derive
65 Specify 'derive' key usage flag (EC only).
66 --label name, -a name
68 Specify the name of the object to operate on (or the token label
69 when --init-token is used).
70 --list-mechanisms, -M
72 Display a list of mechanisms supported by the token.
73 --list-objects, -O
75 Display a list of objects.
76 --list-slots, -L
78 Display a list of available slots on the token.
79 --list-token-slots, -T
81 List slots with tokens.
82 --login, -l
84 Authenticate to the token before performing other operations. This
85 option is not needed if a PIN is provided on the command line.
86 --login-type
88 Specify login type ('so', 'user', 'context-specific';
89 default:'user').
90 --mechanism mechanism, -m mechanism
92 Use the specified mechanism for token operations. See -M for a list
93 of mechanisms supported by your token. The mechanism can also be
94 specified in hexadecimal, e.g., 0x80001234.
95 --module mod
97 Specify a PKCS#11 module (or library) to load.
98 --moz-cert path, -z path
100 Test a Mozilla-like keypair generation and certificate request.
101 Specify the path to the certificate file.
102 --output-file path, -o path
104 Specify the path to a file for output.
105 --pin pin, -p pin
107 Use the given pin for token operations. If set to env:VARIABLE, the
108 value of the environment variable VARIABLE is used. WARNING: Be
109 careful using this option as other users may be able to read the
110 command line from the system or if it is embedded in a script. If
111 set to env:VARIABLE, the value of the environment variable VARIABLE
112 is used.
113 This option will also set the --login option.
115 --puk puk
117 Supply User PUK on the command line.
118 --new-pin pin
120 Supply new User PIN on the command line.
121 --set-id id, -e id
123 Set the CKA_ID of the object.
124 --show-info, -I
126 Display general token information.
127 --sign, -s
129 Sign some data.
130 --decrypt,
132 Decrypt some data.
133 --derive,
135 Derive a secret key using another key and some data.
136 --slot id
138 Specify the id of the slot to use.
139 --slot-description description
141 Specify the description of the slot to use.
142 --slot-index index
144 Specify the index of the slot to use.
145 --token-label label
147 Specify the label of token. Will be used the first slot, that has
148 the inserted token with this label.
149 --so-pin pin
151 Use the given pin as the Security Officer PIN for some token
152 operations (token initialization, user PIN initialization, etc). If
153 set to env:VARIABLE, the value of the environment variable VARIABLE
154 is used. The same warning as --pin also applies here.
155 --test, -t
157 Perform some tests on the token. This option is most useful when
158 used with either --login or --pin.
159 --test-hotplug
161 Test hotplug capabilities (C_GetSlotList + C_WaitForSlotEvent).
162 --private
164 Set the CKA_PRIVATE attribute (object is only viewable after a
165 login).
166 --test-ec
168 Test EC (best used with the --login or --pin option).
169 --test-fork
171 Test forking and calling C_Initialize() in the child.
172 --type type, -y type
174 Specify the type of object to operate on. Examples are cert,
175 privkey and pubkey.
176 --verbose, -v
178 Cause pkcs11-tool to be more verbose.
179 NB! This does not affect OpenSC debugging level! To set OpenSC
181 PKCS#11 module into debug mode, set the OPENSC_DEBUG environment
182 variable to a non-zero number.
183 --read-object, -r
185 Get object's CKA_VALUE attribute (use with --type).
186 --delete-object, -b
188 Delete an object.
189 --application-label label
191 Specify the application label of the data object (use with --type
192 data).
193 --application-id id
195 Specify the application ID of the data object (use with --type
196 data).
197 --issuer data
199 Specify the issuer in hexadecimal format (use with --type cert).
200 --subject data
202 Specify the subject in hexadecimal format (use with --type
203 cert/privkey/pubkey).
204 --signature-format format
206 Format for ECDSA signature: 'rs' (default), 'sequence', 'openssl'.
207 --write-object id, -w path
209 Write a key or certificate object to the token. path points to the
210 DER-encoded certificate or key file.
211opensc 10/30/2018 PKCS11-TOOL(1)