File: goid-tool.1.xml

package info (click to toggle)
opensc 0.26.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,420 kB
  • sloc: ansic: 178,823; xml: 6,327; sh: 2,115; makefile: 1,023; cpp: 304; lex: 92
file content (265 lines) | stat: -rw-r--r-- 8,069 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="goid-tool">
	<refmeta>
		<refentrytitle>goid-tool</refentrytitle>
		<manvolnum>1</manvolnum>
		<refmiscinfo class="productname">OpenSC</refmiscinfo>
		<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
		<refmiscinfo class="source">opensc</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>goid-tool</refname>
		<refpurpose>smart card utility for GoID fingerprint card</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>goid-tool</command>
			<arg choice="opt"><replaceable class="option">OPTIONS</replaceable></arg>
			<arg><replaceable class="option">mode</replaceable></arg>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>Description</title>
		<para>
			The <command>goid-tool</command> utility can be used from
            the command line to read and write data of the
            <ulink url="https://github.com/OpenSC/OpenSC/wiki/GoID-fingerprint-card">
            GoID fingerprint card</ulink>.
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
						<option>--help</option>,
						<option>-h</option>
					</term>
					<listitem><para>Print help message on screen.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--version</option>,
						<option>-V</option>
					</term>
					<listitem><para>Print the OpenSC package release version.</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--reader</option> <replaceable>string</replaceable>,
						<option>-r</option> <replaceable>string</replaceable>
					</term>
					<listitem><para>
						Specify the number of the reader to use. By default, the
						first reader with present card is used. If
						the argument is an ATR, the reader with a
						matching card will be chosen.
					</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--verbose</option>,
						<option>-v</option>
					</term>
					<listitem><para>
						Cause <command>goid-tool</command> to be
						more verbose. Use it multiple times to be even more
						verbose.
					</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--verify-pin</option>,
						<option>-p</option>
					</term>
					<listitem><para>
						Verify PIN.
					</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--verify-bio</option>,
						<option>-b</option>
					</term>
					<listitem><para>
						Verify finger print.
					</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--verify-pin-or-bio</option>
					</term>
					<listitem><para>
						Verify PIN or finger print (user's choice).
					</para></listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>

	<refsect1>
		<title>Options for SoCManager Applet</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
						<option>--new-pin</option>
					</term>
					<listitem><para>Change PIN</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-bio</option>
					</term>
					<listitem><para>Use (several times) to change one or more biometric templates</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--info</option>
					</term>
					<listitem><para>Dump Information about the SoCManager's configuration</para></listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>

	<refsect1>
		<title>Options for PAccess Applet</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
						<option>--certificate</option> <replaceable>filename</replaceable>,
						<option>-c</option> <replaceable>filename</replaceable>
					</term>
					<listitem><para>Use (several times) to pass CV certificates</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--key</option>,
						<option>-k</option>,
					</term>
					<listitem><para>Private key for the CV certificate</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--print-cardid</option>
					</term>
					<listitem><para>Print the card ID</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--write-cardid</option> <replaceable>data</replaceable>
					</term>
					<listitem><para>Write the specified card ID</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--print-paccessid</option>
					</term>
					<listitem><para>Print the PAccess ID</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--write-paccessid</option> <replaceable>data</replaceable>
					</term>
					<listitem><para>Write the specified PAccess ID</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--read-dg</option> <replaceable>id</replaceable>
					</term>
					<listitem><para>Read the specified data group; use several times to read out multiple files</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--out-file</option> <replaceable>filename</replaceable>
					</term>
					<listitem><para>Write output to a file instead of printing it; use once for each use of <option>--read-dg</option></para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--write-dg</option> <replaceable>id</replaceable>
					</term>
					<listitem><para>Write the specified data group; use several times to write multiple files</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--in-file</option> <replaceable>filename</replaceable>
					</term>
					<listitem><para>Read input from a file; use once for each use of <option>--write-dg</option></para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--delete-dg</option> <replaceable>id</replaceable>
					</term>
					<listitem><para>Delete the specified data group; use several times to delete multiple files</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--create-dg</option> <replaceable>id</replaceable>
					</term>
					<listitem><para>Create the specified data group; use several times to create multiple files</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-size</option> <replaceable>size</replaceable>
					</term>
					<listitem><para>File size of newly created DGs</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-read-ac</option> <replaceable>condition</replaceable>
					</term>
					<listitem><para>Access condition for reading newly created DGs</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-read-ac</option> <replaceable>condition</replaceable>
					</term>
					<listitem><para>Access condition for reading newly created DGs</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-read-ac-chatbit</option> <replaceable>index</replaceable>
					</term>
					<listitem><para>Required access bit in certificate's CHAT for reading newly created DGs</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-write-ac</option> <replaceable>condition</replaceable>
					</term>
					<listitem><para>Access condition for writing newly created DGs</para></listitem>
				</varlistentry>
				<varlistentry>
					<term>
						<option>--new-write-ac-chatbit</option> <replaceable>index</replaceable>
					</term>
					<listitem><para>Required access bit in certificate's CHAT for writing newly created DGs</para></listitem>
				</varlistentry>
			</variablelist>
		</para>
	</refsect1>

	<refsect1>
		<title>See also</title>
		<para>
			<citerefentry>
				<refentrytitle>opensc.conf</refentrytitle>
				<manvolnum>5</manvolnum>
			</citerefentry>
		</para>
	</refsect1>

	<refsect1>
		<title>Authors</title>
		<para><command>goid-tool</command> was written by
		Frank Morgner <email>frankmorgner@gmail.com</email>.</para>
	</refsect1>

</refentry>