giomba
/
opensc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

westcos-tool.1.xml: slight rewording

This commit is contained in:
Peter Marschall 2011-08-21 13:05:46 +02:00
parent 9f09113ab7
commit ca0343de42
1 changed files with 31 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doc/tools/westcos-tool.1.xml
View File

@ -25,8 +25,8 @@
<title>Description</title>
<para>
The <command>westcos-tool</command> utility is used to manipulate
the westcos data structures on 2 Ko smart cards. Users can create PINs,
keys and certificates stored on the token. User PIN authentication is
the westcos data structures on 2 Ko smart cards / tokens. Users can create PINs,
keys and certificates stored on the card / token. User PIN authentication is
performed for those operations that require it.
</para>
</refsect1>
@ -50,7 +50,7 @@
<option>--wait</option>,
<option>-w</option>
</term>
<listitem><para>Wait for a card to be inserted</para></listitem>
<listitem><para>Wait for a card to be inserted.</para></listitem>
</varlistentry>
<varlistentry>
@ -58,9 +58,10 @@
<option>--generate-key</option>,
<option>-g</option>
</term>
<listitem><para>Generate a private key on smart card. The smart card must be
not finalized and a PIN must be installed (ie. file for PIN must be created, see option
-i). By default key length is 1536 bits. User authentication is required for
<listitem><para>Generate a private key on the card. The card must not have
been finalized and a PIN must be installed (ie. the file for ithe PIN must
havei been created, see option <option>-i</option>).
By default the key length is 1536 bits. User authentication is required for
this operation. </para></listitem>
</varlistentry>
@ -69,7 +70,7 @@
<option>--overwrite-key</option>,
<option>-o</option>
</term>
<listitem><para>Overwrite the key if there is already a key on card.</para></listitem>
<listitem><para>Overwrite the key if there is already a key on the card.</para></listitem>
</varlistentry>
<varlistentry>
@ -77,8 +78,8 @@
<option>--key-length</option> <replaceable>length</replaceable>,
<option>-l</option> <replaceable>length</replaceable>
</term>
<listitem><para>Change the length of private key, use with <option>-g</option>.
</para></listitem>
<listitem><para>Change the length of private key.
Use with <option>-g</option>.</para></listitem>
</varlistentry>
<varlistentry>
@ -86,8 +87,8 @@
<option>--install-pin</option>,
<option>-i</option>
</term>
<listitem><para>Install PIN file in token, you must provide PIN value
with <option>-x</option>.</para></listitem>
<listitem><para>Install PIN file in on the card.
You must provide a PIN value with <option>-x</option>.</para></listitem>
</varlistentry>
<varlistentry>
@ -95,7 +96,7 @@
<option>--pin-value</option> <replaceable>value</replaceable>,
<option>-x</option> <replaceable>value</replaceable>
</term>
<listitem><para>set value of PIN.</para></listitem>
<listitem><para>Set value of PIN.</para></listitem>
</varlistentry>
<varlistentry>
@ -112,8 +113,8 @@
<option>--change-pin</option>,
<option>-n</option>
</term>
<listitem><para>Changes a PIN stored on the token. User authentication
is required for this operation.</para></listitem>
<listitem><para>Changes a PIN stored on the card.
User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
@ -121,7 +122,7 @@
<option>--unblock-pin</option>,
<option>-u</option>
</term>
<listitem><para>Unblocks a PIN stored on the token. Knowledge of the
<listitem><para>Unblocks a PIN stored on the card. Knowledge of the
PIN Unblock Key (PUK) is required for this operation.</para></listitem>
</varlistentry>
@ -130,8 +131,9 @@
<option>--certificate</option> <replaceable>file</replaceable>,
<option>-t</option> <replaceable>file</replaceable>
</term>
<listitem><para>Write certificate file in PEM format to the
card. User authentication is required for this operation.</para></listitem>
<listitem><para>Write certificate file <replaceable>file</replaceable>
in PEM format to the card.
User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
@ -139,9 +141,11 @@
<option>--finalize</option>,
<option>-f</option>
</term>
<listitem><para>Finalize the card. Once finalized the default key is invalidated so PIN and PUK
can't be changed anymore without user authentication. Warning,
un-finalized are insecure because PIN can be changed without user authentication (knowledge of default key
<listitem><para>Finalize the card. Once finalized the default key is
invalidated, so PIN and PUK cannot be changed anymore without user
authentication.</para>
<para>Warning, un-finalized are insecure because PIN can be changed
without user authentication (knowledge of default key
is enough).</para></listitem>
</varlistentry>
@ -150,9 +154,9 @@
<option>--read-file</option> <replaceable>path</replaceable>,
<option>-j</option> <replaceable>path</replaceable>
</term>
<listitem><para>Get the file path the file is written
on disk with path name. User authentication
is required for this operation.</para></listitem>
<listitem><para>Read the file <replaceable>path</replaceable> from the card.
The file is written on disk with name <replaceable>path</replaceable>.
User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>
@ -160,9 +164,10 @@
<option>--write-file</option> <replaceable>path</replaceable>,
<option>-k</option> <replaceable>path</replaceable>
</term>
<listitem><para>Put the file with name path from disk
to card the file is written in path. User authentication
is required for this operation.</para></listitem>
<listitem><para>Put the file with name <replaceable>path</replaceable>
from disk to card.
On the card the file is written in <replaceable>path</replaceable>.
User authentication is required for this operation.</para></listitem>
</varlistentry>
<varlistentry>