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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "password-request">
<!ENTITY TIMESTAMP "2008-09-03">
]>
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>Mandos Manual</title>
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
<productname>Mandos</productname>
<productnumber>&VERSION;</productnumber>
<date>&TIMESTAMP;</date>
<authorgroup>
<author>
<firstname>Björn</firstname>
<surname>Påhlsson</surname>
<address>
<email>belorn@fukt.bsnet.se</email>
</address>
</author>
<author>
<firstname>Teddy</firstname>
<surname>Hogeborn</surname>
<address>
<email>teddy@fukt.bsnet.se</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2008</year>
<holder>Teddy Hogeborn</holder>
<holder>Björn Påhlsson</holder>
</copyright>
<xi:include href="../legalnotice.xml"/>
</refentryinfo>
<refmeta>
<refentrytitle>&COMMANDNAME;</refentrytitle>
<manvolnum>8mandos</manvolnum>
</refmeta>
<refnamediv>
<refname><command>&COMMANDNAME;</command></refname>
<refpurpose>
Client for mandos
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group>
<arg choice="plain"><option>--connect
<replaceable>IPADDR</replaceable><literal>:</literal
><replaceable>PORT</replaceable></option></arg>
<arg choice="plain"><option>-c
<replaceable>IPADDR</replaceable><literal>:</literal
><replaceable>PORT</replaceable></option></arg>
</group>
<sbr/>
<group>
<arg choice="plain"><option>--keydir
<replaceable>DIRECTORY</replaceable></option></arg>
<arg choice="plain"><option>-d
<replaceable>DIRECTORY</replaceable></option></arg>
</group>
<sbr/>
<group>
<arg choice="plain"><option>--interface
<replaceable>NAME</replaceable></option></arg>
<arg choice="plain"><option>-i
<replaceable>NAME</replaceable></option></arg>
</group>
<sbr/>
<group>
<arg choice="plain"><option>--pubkey
<replaceable>FILE</replaceable></option></arg>
<arg choice="plain"><option>-p
<replaceable>FILE</replaceable></option></arg>
</group>
<sbr/>
<group>
<arg choice="plain"><option>--seckey
<replaceable>FILE</replaceable></option></arg>
<arg choice="plain"><option>-s
<replaceable>FILE</replaceable></option></arg>
</group>
<sbr/>
<arg>
<option>--priority <replaceable>STRING</replaceable></option>
</arg>
<sbr/>
<arg>
<option>--dh-bits <replaceable>BITS</replaceable></option>
</arg>
<sbr/>
<arg>
<option>--debug</option>
</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group choice="req">
<arg choice="plain"><option>--help</option></arg>
<arg choice="plain"><option>-?</option></arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<arg choice="plain"><option>--usage</option></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>&COMMANDNAME;</command>
<group choice="req">
<arg choice="plain"><option>--version</option></arg>
<arg choice="plain"><option>-V</option></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
<command>&COMMANDNAME;</command> is a client program that
communicates with <citerefentry><refentrytitle
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
to get a password. It uses IPv6 link-local addresses to get
network connectivity, Zeroconf to find the server, and TLS with
an OpenPGP key to ensure authenticity and confidentiality. It
keeps running, trying all servers on the network, until it
receives a satisfactory reply.
</para>
<para>
This program is not meant to be run directly; it is really meant
to run as a plugin of the <application>Mandos</application>
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
initial <acronym>RAM</acronym> disk environment because it is
specified as a <quote>keyscript</quote> in the <citerefentry>
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> file.
</para>
</refsect1>
<refsect1 id="purpose">
<title>PURPOSE</title>
<para>
The purpose of this is to enable <emphasis>remote and unattended
rebooting</emphasis> of client host computer with an
<emphasis>encrypted root file system</emphasis>. See <xref
linkend="overview"/> for details.
</para>
</refsect1>
<refsect1 id="options">
<title>OPTIONS</title>
<para>
This program is commonly not invoked from the command line; it
is normally started by the <application>Mandos</application>
plugin runner, see <citerefentry><refentrytitle
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
</citerefentry>. Any command line options this program accepts
are therefore normally provided by the plugin runner, and not
directly.
</para>
<variablelist>
<varlistentry>
<term><option>--connect=<replaceable
>ADDRESS</replaceable><literal>:</literal><replaceable
>PORT</replaceable></option></term>
<term><option>-c
<replaceable>ADDRESS</replaceable><literal>:</literal
><replaceable>PORT</replaceable></option></term>
<listitem>
<para>
Do not use Zeroconf to locate servers. Connect directly
to only one specified <application>Mandos</application>
server. Note that an IPv6 address has colon characters in
it, so the <emphasis>last</emphasis> colon character is
assumed to separate the address from the port number.
</para>
<para>
This option is normally only useful for testing and
debugging.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--keydir=<replaceable
>DIRECTORY</replaceable></option></term>
<term><option>-d
<replaceable>DIRECTORY</replaceable></option></term>
<listitem>
<para>
Directory to read the OpenPGP key files
<filename>pubkey.txt</filename> and
<filename>seckey.txt</filename> from. The default is
<filename>/conf/conf.d/mandos</filename> (in the initial
<acronym>RAM</acronym> disk environment).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--interface=
<replaceable>NAME</replaceable></option></term>
<term><option>-i
<replaceable>NAME</replaceable></option></term>
<listitem>
<para>
Network interface that will be brought up and scanned for
Mandos servers to connect to. The default it
<quote><literal>eth0</literal></quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--pubkey=<replaceable
>FILE</replaceable></option></term>
<term><option>-p
<replaceable>FILE</replaceable></option></term>
<listitem>
<para>
OpenPGP public key file base name. This will be combined
with the directory from the <option>--keydir</option>
option to form an absolute file name. The default name is
<quote><literal>pubkey.txt</literal></quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--seckey=<replaceable
>FILE</replaceable></option></term>
<term><option>-s
<replaceable>FILE</replaceable></option></term>
<listitem>
<para>
OpenPGP secret key file base name. This will be combined
with the directory from the <option>--keydir</option>
option to form an absolute file name. The default name is
<quote><literal>seckey.txt</literal></quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--priority=<replaceable
>STRING</replaceable></option></term>
<listitem>
<xi:include href="../mandos-options.xml"
xpointer="priority"/>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--dh-bits=<replaceable
>BITS</replaceable></option></term>
<listitem>
<para>
Sets the number of bits to use for the prime number in the
TLS Diffie-Hellman key exchange. Default is 1024.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
<para>
Enable debug mode. This will enable a lot of output to
standard error about what the program is doing. The
program will still perform all other functions normally.
</para>
<para>
It will also enable debug mode in the Avahi and GnuTLS
libraries, making them print large amounts of debugging
output.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option></term>
<term><option>-?</option></term>
<listitem>
<para>
Gives a help message about options and their meanings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--usage</option></term>
<listitem>
<para>
Gives a short usage message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option></term>
<term><option>-V</option></term>
<listitem>
<para>
Prints the program version.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="overview">
<title>OVERVIEW</title>
<xi:include href="../overview.xml"/>
<para>
This program is the client part. It is a plugin started by
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
an initial <acronym>RAM</acronym> disk environment.
</para>
<para>
This program could, theoretically, be used as a keyscript in
<filename>/etc/crypttab</filename>, but it would then be
impossible to enter a password for the encrypted root disk at
the console, since this program does not read from the console
at all. This is why a separate plugin does that, which will be
run in parallell to this one by the plugin runner.
</para>
</refsect1>
<refsect1 id="exit_status">
<title>EXIT STATUS</title>
<para>
This program will exit with a successful (zero) exit status if a
server could be found and the password received from it could be
successfully decrypted and output on standard output. The
program will exit with a non-zero exit status only if a critical
error occurs. Otherwise, it will forever connect to new
<application>Mandos</application> servers as they appear, trying
to get a decryptable password.
</para>
</refsect1>
<refsect1 id="environment">
<title>ENVIRONMENT</title>
<para>
This program does not use any environment variables, not even
the ones provided by <citerefentry><refentrytitle
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>.
</para>
</refsect1>
<refsect1 id="file">
<title>FILES</title>
<para>
</para>
</refsect1>
<refsect1 id="bugs">
<title>BUGS</title>
<para>
</para>
</refsect1>
<refsect1 id="example">
<title>EXAMPLE</title>
<para>
</para>
</refsect1>
<refsect1 id="security">
<title>SECURITY</title>
<para>
</para>
</refsect1>
<refsect1 id="see_also">
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>mandos</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>password-prompt</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
<manvolnum>8mandos</manvolnum></citerefentry>
</para>
<itemizedlist>
<listitem><para>
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.avahi.org/">Avahi</ulink>
</para></listitem>
<listitem><para>
<ulink
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
</para></listitem>
<listitem><para>
<ulink
url="http://www.gnupg.org/related_software/gpgme/"
>GPGME</ulink>
</para></listitem>
<listitem><para>
<citation>RFC 4880: <citetitle>OpenPGP Message
Format</citetitle></citation>
</para></listitem>
<listitem><para>
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
Transport Layer Security</citetitle></citation>
</para></listitem>
<listitem><para>
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
Unicast Addresses</citation>
</para></listitem>
</itemizedlist>
</refsect1>
</refentry>
<!-- Local Variables: -->
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
<!-- time-stamp-end: "[\"']>" -->
<!-- time-stamp-format: "%:y-%02m-%02d" -->
<!-- End: -->
|