Skip to content

Commit 96a8b14

Browse files
Revise documentation of the object and profile sub-commands
Signed-off-by: Zoltan Fridrich <zfridric@redhat.com>
1 parent bd75edd commit 96a8b14

File tree

1 file changed

+65
-34
lines changed

1 file changed

+65
-34
lines changed

doc/manual/p11-kit.xml

Lines changed: 65 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ $ p11-kit list-modules
117117
<para>List all tokens available in system configured PKCS#11 modules.</para>
118118

119119
<programlisting>
120-
$ p11-kit list-tokens pkcs11:token
121-
$ p11-kit list-tokens --only-uris pkcs11:token
120+
$ p11-kit list-tokens &lsqb;--only-uris&rsqb; pkcs11:token
122121
</programlisting>
123122

124123
<para>This retrieves all tokens and displays some of their
@@ -130,28 +129,41 @@ $ p11-kit list-tokens --only-uris pkcs11:token
130129
<refsect1 id="p11-kit-list-objects">
131130
<title>List Objects</title>
132131

133-
<para>List objects of a token.</para>
132+
<para>List objects matching given PKCS#11 URI.</para>
134133

135134
<programlisting>
136-
$ p11-kit list-objects pkcs11:token
135+
$ p11-kit list-objects &lsqb;--login&rsqb; pkcs11:object_on_token
137136
</programlisting>
138137

139-
<para>This retrieves all objects of the given token and displays
140-
some of their common attributes.</para>
138+
<para>This retrieves all objects that match given PKCS#11 URI and displays
139+
some of their common attributes. Storage objects also have their PKCS#11 URI
140+
displayed.</para>
141141

142142
</refsect1>
143143

144144
<refsect1 id="p11-kit-import-object">
145145
<title>Import Object</title>
146146

147-
<para>Import object into a PKCS#11 token.</para>
147+
<para>Import object into PKCS#11 token.</para>
148148

149149
<programlisting>
150150
$ p11-kit import-object --file=file.pem &lsqb;--label=label&rsqb; &lsqb;--login&rsqb; pkcs11:token
151151
</programlisting>
152152

153-
<para>This takes either a X.509 certificate or a public key in form of a PEM file
154-
and imports it into PKCS#11 token that matches given URI.</para>
153+
<para>Takes either an X.509 certificate or a public key in the form of a PEM file
154+
and imports it into the first token matched by given PKCS#11 URI.</para>
155+
156+
<variablelist>
157+
<varlistentry>
158+
<term><option>--file=&lt;file.pem&gt;</option></term>
159+
<listitem><para>File containing either an X.509 certificate
160+
or a public key in PEM format. This option is required.</para></listitem>
161+
</varlistentry>
162+
<varlistentry>
163+
<term><option>--label=&lt;label&gt;</option></term>
164+
<listitem><para>Assigns label to the imported object.</para></listitem>
165+
</varlistentry>
166+
</variablelist>
155167

156168
</refsect1>
157169

@@ -161,24 +173,24 @@ $ p11-kit import-object --file=file.pem &lsqb;--label=label&rsqb; &lsqb;--login&
161173
<para>Export object matching PKCS#11 URI.</para>
162174

163175
<programlisting>
164-
$ p11-kit export-object pkcs11:token
176+
$ p11-kit export-object &lsqb;--login&rsqb; pkcs11:object_on_token
165177
</programlisting>
166178

167-
<para>If a given URI references a storage object that is a X.509 certificate,
168-
it displays the concents of the certificate in PEM format.</para>
179+
<para>Displays PEM formatted contents of the first object matched by given PKCS#11 URI.
180+
The matched object has to either be an X.509 certificate or a public key.</para>
169181

170182
</refsect1>
171183

172184
<refsect1 id="p11-kit-delete-object">
173185
<title>Delete Object</title>
174186

175-
<para>Delete objects matching PKCS#11 URI.</para>
187+
<para>Delete object matching PKCS#11 URI.</para>
176188

177189
<programlisting>
178-
$ p11-kit delete-object pkcs11:token
190+
$ p11-kit delete-object &lsqb;--login&rsqb; pkcs11:object_on_token
179191
</programlisting>
180192

181-
<para>This destroys every storage object matching given PKCS#11 URI.</para>
193+
<para>Destroys the first object matched by given PKCS#11 URI.</para>
182194

183195
</refsect1>
184196

@@ -188,21 +200,18 @@ $ p11-kit delete-object pkcs11:token
188200
<para>Generate key-pair on a PKCS#11 token.</para>
189201

190202
<programlisting>
191-
$ p11-kit generate-keypair &lsqb;--label=label&rsqb; --type=algorithm &lcub;--bits=n|--curve=name&rcub; pkcs11:token
203+
$ p11-kit generate-keypair --type=algorithm &lcub;--bits=n|--curve=name&rcub; &lsqb;--label=label&rsqb; &lsqb;--login&rsqb; pkcs11:token
192204
</programlisting>
193205

194-
<para>Generate private-public key-pair of given type on specified PKCS#11 token.
195-
Should be used together with --type option and one of --bits or --curve options.</para>
206+
<para>Generate private-public key-pair of given type on the first
207+
token matched by given PKCS#11 URI. This command should be used
208+
together with --type option and one of --bits or --curve options.</para>
196209

197210
<variablelist>
198-
<varlistentry>
199-
<term><option>--label=&lt;label&gt;</option></term>
200-
<listitem><para>Assigns label to the generated key-pair objects.</para></listitem>
201-
</varlistentry>
202211
<varlistentry>
203212
<term><option>--type=&lt;algorithm&gt;</option></term>
204213
<listitem><para>Specify the type of keys to generate.
205-
Supported values are rsa, ecdsa, ed25519.
214+
Supported values are rsa, ecdsa and ed25519.
206215
This option is required.</para></listitem>
207216
</varlistentry>
208217
<varlistentry>
@@ -213,9 +222,13 @@ $ p11-kit generate-keypair &lsqb;--label=label&rsqb; --type=algorithm &lcub;--bi
213222
<varlistentry>
214223
<term><option>--curve=&lt;name&gt;</option></term>
215224
<listitem><para>Specify an elliptic curve for the key-pair generation.
216-
Supported values are secp256r1, secp384r1, secp521r1.
225+
Supported values are secp256r1, secp384r1, secp521r1, ed25519 and ed448.
217226
Cannot be used together with --bits option.</para></listitem>
218227
</varlistentry>
228+
<varlistentry>
229+
<term><option>--label=&lt;label&gt;</option></term>
230+
<listitem><para>Assigns label to the generated key-pair objects.</para></listitem>
231+
</varlistentry>
219232
</variablelist>
220233

221234
</refsect1>
@@ -226,38 +239,56 @@ $ p11-kit generate-keypair &lsqb;--label=label&rsqb; --type=algorithm &lcub;--bi
226239
<para>List PKCS#11 profiles supported by the token.</para>
227240

228241
<programlisting>
229-
$ p11-kit list-profiles pkcs11:token
242+
$ p11-kit list-profiles &lsqb;--login&rsqb; pkcs11:token
230243
</programlisting>
231244

232-
<para>This searches the given token for profile objects that contain profile IDs
233-
which are then displayed in human-readable form.</para>
245+
<para>Displays profile IDs of the first token matched by given
246+
PKCS#11 URI in human-readable form.</para>
234247

235248
</refsect1>
236249

237250
<refsect1 id="p11-kit-add-profile">
238251
<title>Add Profile</title>
239252

240-
<para>Add PKCS#11 profile to the token.</para>
253+
<para>Add PKCS#11 profile to a token.</para>
241254

242255
<programlisting>
243-
$ p11-kit add-profile --profile profile pkcs11:token
256+
$ p11-kit add-profile --profile=profile &lsqb;--login&rsqb; pkcs11:token
244257
</programlisting>
245258

246-
<para>Creates a new PKCS#11 profile object on the token if it doesn't already exist.</para>
259+
<para>Creates new profile object with given profile ID on the
260+
first token matched by given PKCS#11 URI. This command fails
261+
if the profile ID already exists on the token.</para>
262+
263+
<variablelist>
264+
<varlistentry>
265+
<term><option>--profile=&lt;profile&gt;</option></term>
266+
<listitem><para>Profile ID to add. Value can either
267+
be numerical or textual. This option is required.</para></listitem>
268+
</varlistentry>
269+
</variablelist>
247270

248271
</refsect1>
249272

250273
<refsect1 id="p11-kit-delete-profile">
251274
<title>Delete Profile</title>
252275

253-
<para>Delete PKCS#11 profile from the token.</para>
276+
<para>Delete PKCS#11 profile from a token.</para>
254277

255278
<programlisting>
256-
$ p11-kit delete-profile --profile profile pkcs11:token
279+
$ p11-kit delete-profile --profile=profile &lsqb;--login&rsqb; pkcs11:token
257280
</programlisting>
258281

259-
<para>Searches the token for profile object that matches given PKCS#11
260-
profile ID and attempts to destroy it.</para>
282+
<para>Destroys all profile objects with given profile ID from
283+
the first token matched by given PKCS#11 URI.</para>
284+
285+
<variablelist>
286+
<varlistentry>
287+
<term><option>--profile=&lt;profile&gt;</option></term>
288+
<listitem><para>Profile ID to delete. Value can either
289+
be numerical or textual. This option is required.</para></listitem>
290+
</varlistentry>
291+
</variablelist>
261292

262293
</refsect1>
263294

0 commit comments

Comments
 (0)