File: openpgp-tool.1.xml

package info (click to toggle)
opensc 0.16.0-3%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 10,552 kB
  • sloc: ansic: 131,429; sh: 12,276; xml: 3,646; makefile: 566; cpp: 187; lex: 92
file content (188 lines) | stat: -rw-r--r-- 4,697 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8"?>
<refentry id="openpgp-tool">
	<refmeta>
		<refentrytitle>openpgp-tool</refentrytitle>
		<manvolnum>1</manvolnum>
		<refmiscinfo class="productname">OpenSC</refmiscinfo>
		<refmiscinfo class="manual">OpenSC Tools</refmiscinfo>
		<refmiscinfo class="source">opensc</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>openpgp-tool</refname>
		<refpurpose>utility for accessing visible data OpenPGP smart cards
		and compatible tokens</refpurpose>
	</refnamediv>

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

	<refsect1>
		<title>Description</title>
		<para>
			The <command>openpgp-tool</command> utility is used for
			accessing data from the OpenPGP v1.1 and v2.0 smart cards
			and compatible tokens like e.g. GPF CryptoStick v1.x,
			which might not be present in
			PKCS#15 objects but available in custom files on the
			card. The data can be printed on screen or used by
			other programs via environment variables.
		</para>
	</refsect1>

	<refsect1>
		<title>Options</title>
		<para>
			<variablelist>
				<varlistentry>
					<term>
						<option>--exec</option> <replaceable>prog</replaceable>,
						<option>-x</option> <replaceable>prog</replaceable>
					</term>
					<listitem><para>
					Execute the given program with data in environment variables.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--help</option>,
						<option>-h</option>
					</term>
					<listitem><para>
					Print help message on screen.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--raw</option>
					</term>
					<listitem><para>
					Print values in raw format, as they are stored on the card.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--pretty</option>
					</term>
					<listitem><para>
					Print values in pretty format.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--user-info</option>,
						<option>-U</option>
					</term>
					<listitem><para>
					Show card holder information.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--reader</option> <replaceable>num</replaceable>,
						<option>-r</option> <replaceable>num</replaceable>
					</term>
					<listitem><para>
					Use the given reader.  The default is the first reader with a card.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--verify</option> <replaceable>pintype</replaceable>
					</term>
					<listitem>
						<para>
						Verify PIN (CHV1, CHV2 or CHV3).
						</para>
					</listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--pin</option> <replaceable>string</replaceable>
					</term>
					<listitem>
						<para>
						The PIN text to verify. If set to
						env:<replaceable>VARIABLE</replaceable>, the value of
						the environment variable
						<replaceable>VARIABLE</replaceable> is used.
						</para>
					</listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--gen-key</option> <replaceable>ID</replaceable>,
						<option>-G</option> <replaceable>ID</replaceable>
					</term>
					<listitem>
						<para>
						Generate key. Specify key ID (1, 2 or 3) to generate.
						</para>
					</listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--key-length</option> <replaceable>bitlength</replaceable>,
						<option>-L</option> <replaceable>bitlength</replaceable>
					</term>
					<listitem>
						<para>
						Length (default 2048 bit) of the key to be generated.
						</para>
					</listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--version</option>,
						<option>-V</option>
					</term>
					<listitem><para>
					Print the version of the utility and exit.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--verbose</option>,
						<option>-v</option>
					</term>
					<listitem><para>
					Verbose operation. Use several times to enable debug output.
					</para></listitem>
				</varlistentry>

				<varlistentry>
					<term>
						<option>--wait</option>,
						<option>-w</option>
					</term>
					<listitem><para>
					Wait for a card to be inserted.
					</para></listitem>
				</varlistentry>

			</variablelist>
		</para>
	</refsect1>

	<refsect1>
		<title>Authors</title>
		<para><command>openpgp-tool</command> utility was written by
		Peter Marschall <email>peter@adpm.de</email>.</para>
	</refsect1>

</refentry>