/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

Added more header file comments
fixed a small perror bug

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2025-06-27">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "password-request">
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
11
11
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
 
      <year>2020</year>
47
 
      <year>2021</year>
48
 
      <year>2022</year>
49
 
      <year>2023</year>
50
 
      <year>2024</year>
51
 
      <holder>Teddy Hogeborn</holder>
52
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
53
35
    </copyright>
54
 
    <xi:include href="../legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
55
59
  </refentryinfo>
56
 
  
 
60
 
57
61
  <refmeta>
58
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
59
63
    <manvolnum>8mandos</manvolnum>
62
66
  <refnamediv>
63
67
    <refname><command>&COMMANDNAME;</command></refname>
64
68
    <refpurpose>
65
 
      Client for <application>Mandos</application>
 
69
      Client for mandos
66
70
    </refpurpose>
67
71
  </refnamediv>
68
 
  
 
72
 
69
73
  <refsynopsisdiv>
70
74
    <cmdsynopsis>
71
75
      <command>&COMMANDNAME;</command>
72
 
      <group>
73
 
        <arg choice="plain"><option>--connect
74
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
75
 
        ><replaceable>PORT</replaceable></option></arg>
76
 
        <arg choice="plain"><option>-c
77
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
78
 
        ><replaceable>PORT</replaceable></option></arg>
79
 
      </group>
80
 
      <sbr/>
81
 
      <group rep='repeat'>
82
 
        <arg choice="plain"><option>--interface
83
 
        <replaceable>NAME</replaceable><arg rep='repeat'
84
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
85
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
86
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
87
 
        ></option></arg>
88
 
      </group>
89
 
      <sbr/>
90
 
      <group>
91
 
        <arg choice="plain"><option>--pubkey
92
 
        <replaceable>FILE</replaceable></option></arg>
93
 
        <arg choice="plain"><option>-p
94
 
        <replaceable>FILE</replaceable></option></arg>
95
 
      </group>
96
 
      <sbr/>
97
 
      <group>
98
 
        <arg choice="plain"><option>--seckey
99
 
        <replaceable>FILE</replaceable></option></arg>
100
 
        <arg choice="plain"><option>-s
101
 
        <replaceable>FILE</replaceable></option></arg>
102
 
      </group>
103
 
      <sbr/>
104
 
      <group>
105
 
        <arg choice="plain"><option>--tls-privkey
106
 
        <replaceable>FILE</replaceable></option></arg>
107
 
        <arg choice="plain"><option>-t
108
 
        <replaceable>FILE</replaceable></option></arg>
109
 
      </group>
110
 
      <sbr/>
111
 
      <group>
112
 
        <arg choice="plain"><option>--tls-pubkey
113
 
        <replaceable>FILE</replaceable></option></arg>
114
 
        <arg choice="plain"><option>-T
115
 
        <replaceable>FILE</replaceable></option></arg>
116
 
      </group>
117
 
      <sbr/>
118
 
      <arg>
119
 
        <option>--priority <replaceable>STRING</replaceable></option>
120
 
      </arg>
121
 
      <sbr/>
122
 
      <arg>
123
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
124
 
      </arg>
125
 
      <sbr/>
126
 
      <arg>
127
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
128
 
      </arg>
129
 
      <sbr/>
130
 
      <arg>
131
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
132
 
      </arg>
133
 
      <sbr/>
134
 
      <arg>
135
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
136
 
      </arg>
137
 
      <sbr/>
138
 
      <arg>
139
 
        <option>--network-hook-dir
140
 
        <replaceable>DIR</replaceable></option>
141
 
      </arg>
142
 
      <sbr/>
143
 
      <arg>
144
 
        <option>--debug</option>
145
 
      </arg>
146
 
    </cmdsynopsis>
147
 
    <cmdsynopsis>
148
 
      <command>&COMMANDNAME;</command>
149
 
      <group choice="req">
150
 
        <arg choice="plain"><option>--help</option></arg>
151
 
        <arg choice="plain"><option>-?</option></arg>
152
 
      </group>
153
 
    </cmdsynopsis>
154
 
    <cmdsynopsis>
155
 
      <command>&COMMANDNAME;</command>
156
 
      <arg choice="plain"><option>--usage</option></arg>
157
 
    </cmdsynopsis>
158
 
    <cmdsynopsis>
159
 
      <command>&COMMANDNAME;</command>
160
 
      <group choice="req">
161
 
        <arg choice="plain"><option>--version</option></arg>
162
 
        <arg choice="plain"><option>-V</option></arg>
163
 
      </group>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
164
77
    </cmdsynopsis>
165
78
  </refsynopsisdiv>
166
 
  
 
79
 
167
80
  <refsect1 id="description">
168
81
    <title>DESCRIPTION</title>
169
82
    <para>
170
 
      <command>&COMMANDNAME;</command> is a client program that
171
 
      communicates with <citerefentry><refentrytitle
172
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
173
 
      to get a password.  In slightly more detail, this client program
174
 
      brings up network interfaces, uses the interfaces’ IPv6
175
 
      link-local addresses to get network connectivity, uses Zeroconf
176
 
      to find servers on the local network, and communicates with
177
 
      servers using TLS with a raw public key to ensure authenticity
178
 
      and confidentiality.  This client program keeps running, trying
179
 
      all servers on the network, until it receives a satisfactory
180
 
      reply or a TERM signal.  After all servers have been tried, all
181
 
      servers are periodically retried.  If no servers are found it
182
 
      will wait indefinitely for new servers to appear.
183
 
    </para>
184
 
    <para>
185
 
      The network interfaces are selected like this: If any interfaces
186
 
      are specified using the <option>--interface</option> option,
187
 
      those interface are used.  Otherwise,
188
 
      <command>&COMMANDNAME;</command> will use all interfaces that
189
 
      are not loopback interfaces, are not point-to-point interfaces,
190
 
      are capable of broadcasting and do not have the NOARP flag (see
191
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
192
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
193
 
      <option>--connect</option> option is used, point-to-point
194
 
      interfaces and non-broadcast interfaces are accepted.)  If any
195
 
      used interfaces are not up and running, they are first taken up
196
 
      (and later taken down again on program exit).
197
 
    </para>
198
 
    <para>
199
 
      Before network interfaces are selected, all <quote>network
200
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
201
 
    </para>
202
 
    <para>
203
 
      This program is not meant to be run directly; it is really meant
204
 
      to be run by other programs in the initial
205
 
      <acronym>RAM</acronym> disk environment; see <xref
206
 
      linkend="overview"/>.
207
 
    </para>
208
 
  </refsect1>
209
 
  
210
 
  <refsect1 id="purpose">
211
 
    <title>PURPOSE</title>
212
 
    <para>
213
 
      The purpose of this is to enable <emphasis>remote and unattended
214
 
      rebooting</emphasis> of client host computer with an
215
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
216
 
      linkend="overview"/> for details.
217
 
    </para>
218
 
  </refsect1>
219
 
  
220
 
  <refsect1 id="options">
221
 
    <title>OPTIONS</title>
222
 
    <para>
223
 
      This program is commonly not invoked from the command line; it
224
 
      is normally started by another program as described in <xref
225
 
      linkend="description"/>.  Any command line options this program
226
 
      accepts are therefore normally provided by the invoking program,
227
 
      and not directly.
228
 
    </para>
229
 
    
230
 
    <variablelist>
231
 
      <varlistentry>
232
 
        <term><option>--connect=<replaceable
233
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
234
 
        >PORT</replaceable></option></term>
235
 
        <term><option>-c
236
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
237
 
        ><replaceable>PORT</replaceable></option></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Do not use Zeroconf to locate servers.  Connect directly
241
 
            to only one specified <application>Mandos</application>
242
 
            server.  Note that an IPv6 address has colon characters in
243
 
            it, so the <emphasis>last</emphasis> colon character is
244
 
            assumed to separate the address from the port number.
245
 
          </para>
246
 
          <para>
247
 
            Normally, Zeroconf would be used to locate Mandos servers,
248
 
            in which case this option would only be used when testing
249
 
            and debugging.
250
 
          </para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
      
254
 
      <varlistentry>
255
 
        <term><option>--interface=<replaceable
256
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
257
 
        >NAME</replaceable></arg></option></term>
258
 
        <term><option>-i
259
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
260
 
        >NAME</replaceable></arg></option></term>
261
 
        <listitem>
262
 
          <para>
263
 
            Comma separated list of network interfaces that will be
264
 
            brought up and scanned for Mandos servers to connect to.
265
 
            The default is the empty string, which will automatically
266
 
            use all appropriate interfaces.
267
 
          </para>
268
 
          <para>
269
 
            If the <option>--connect</option> option is used, and
270
 
            exactly one interface name is specified (except
271
 
            <quote><literal>none</literal></quote>), this specifies
272
 
            the interface to use to connect to the address given.
273
 
          </para>
274
 
          <para>
275
 
            Note that since this program will normally run in the
276
 
            initial RAM disk environment, the interface must be an
277
 
            interface which exists at that stage.  Thus, the interface
278
 
            can normally not be a pseudo-interface such as
279
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
280
 
            will not exist until much later in the boot process, and
281
 
            can not be used by this program, unless created by a
282
 
            <quote>network hook</quote> — see <xref
283
 
            linkend="network-hooks"/>.
284
 
          </para>
285
 
          <para>
286
 
            <replaceable>NAME</replaceable> can be the string
287
 
            <quote><literal>none</literal></quote>; this will make
288
 
            <command>&COMMANDNAME;</command> only bring up interfaces
289
 
            specified <emphasis>before</emphasis> this string.  This
290
 
            is not recommended, and only meant for advanced users.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--pubkey=<replaceable
297
 
        >FILE</replaceable></option></term>
298
 
        <term><option>-p
299
 
        <replaceable>FILE</replaceable></option></term>
300
 
        <listitem>
301
 
          <para>
302
 
            OpenPGP public key file name.  The default name is
303
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
304
 
            ></quote>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--seckey=<replaceable
311
 
        >FILE</replaceable></option></term>
312
 
        <term><option>-s
313
 
        <replaceable>FILE</replaceable></option></term>
314
 
        <listitem>
315
 
          <para>
316
 
            OpenPGP secret key file name.  The default name is
317
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
318
 
            ></quote>.
319
 
          </para>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
      
323
 
      <varlistentry>
324
 
        <term><option>--tls-pubkey=<replaceable
325
 
        >FILE</replaceable></option></term>
326
 
        <term><option>-T
327
 
        <replaceable>FILE</replaceable></option></term>
328
 
        <listitem>
329
 
          <para>
330
 
            TLS raw public key file name.  The default name is
331
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
332
 
            ></quote>.
333
 
          </para>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
 
337
 
      <varlistentry>
338
 
        <term><option>--tls-privkey=<replaceable
339
 
        >FILE</replaceable></option></term>
340
 
        <term><option>-t
341
 
        <replaceable>FILE</replaceable></option></term>
342
 
        <listitem>
343
 
          <para>
344
 
            TLS secret key file name.  The default name is
345
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
346
 
            ></quote>.
347
 
          </para>
348
 
        </listitem>
349
 
      </varlistentry>
350
 
 
351
 
      <varlistentry>
352
 
        <term><option>--priority=<replaceable
353
 
        >STRING</replaceable></option></term>
354
 
        <listitem>
355
 
          <xi:include href="../mandos-options.xml"
356
 
                      xpointer="priority"/>
357
 
        </listitem>
358
 
      </varlistentry>
359
 
      
360
 
      <varlistentry>
361
 
        <term><option>--dh-bits=<replaceable
362
 
        >BITS</replaceable></option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            Sets the number of bits to use for the prime number in the
366
 
            TLS Diffie-Hellman key exchange.  The default value is
367
 
            selected automatically based on the GnuTLS security
368
 
            profile set in its priority string.  Note that if the
369
 
            <option>--dh-params</option> option is used, the values
370
 
            from that file will be used instead.
371
 
          </para>
372
 
        </listitem>
373
 
      </varlistentry>
374
 
      
375
 
      <varlistentry>
376
 
        <term><option>--dh-params=<replaceable
377
 
        >FILE</replaceable></option></term>
378
 
        <listitem>
379
 
          <para>
380
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
381
 
            needed by the TLS Diffie-Hellman key exchange from.  If
382
 
            this option is not given, or if the file for some reason
383
 
            could not be used, the parameters will be generated on
384
 
            startup, which will take some time and processing power.
385
 
            Those using servers running under time, power or processor
386
 
            constraints may want to generate such a file in advance
387
 
            and use this option.
388
 
          </para>
389
 
        </listitem>
390
 
      </varlistentry>
391
 
 
392
 
      <varlistentry>
393
 
        <term><option>--delay=<replaceable
394
 
        >SECONDS</replaceable></option></term>
395
 
        <listitem>
396
 
          <para>
397
 
            After bringing a network interface up, the program waits
398
 
            for the interface to arrive in a <quote>running</quote>
399
 
            state before proceeding.  During this time, the kernel log
400
 
            level will be lowered to reduce clutter on the system
401
 
            console, alleviating any other plugins which might be
402
 
            using the system console.  This option sets the upper
403
 
            limit of seconds to wait.  The default is 2.5 seconds.
404
 
          </para>
405
 
        </listitem>
406
 
      </varlistentry>
407
 
 
408
 
      <varlistentry>
409
 
        <term><option>--retry=<replaceable
410
 
        >SECONDS</replaceable></option></term>
411
 
        <listitem>
412
 
          <para>
413
 
            All Mandos servers are tried repeatedly until a password
414
 
            is received.  This value specifies, in seconds, how long
415
 
            between each successive try <emphasis>for the same
416
 
            server</emphasis>.  The default is 10 seconds.
417
 
          </para>
418
 
        </listitem>
419
 
      </varlistentry>
420
 
 
421
 
      <varlistentry>
422
 
        <term><option>--network-hook-dir=<replaceable
423
 
        >DIR</replaceable></option></term>
424
 
        <listitem>
425
 
          <para>
426
 
            Network hook directory.  The default directory is
427
 
            <quote><filename class="directory"
428
 
            >/lib/mandos/network-hooks.d</filename></quote>.
429
 
          </para>
430
 
        </listitem>
431
 
      </varlistentry>
432
 
      
433
 
      <varlistentry>
434
 
        <term><option>--debug</option></term>
435
 
        <listitem>
436
 
          <para>
437
 
            Enable debug mode.  This will enable a lot of output to
438
 
            standard error about what the program is doing.  The
439
 
            program will still perform all other functions normally.
440
 
          </para>
441
 
          <para>
442
 
            It will also enable debug mode in the Avahi and GnuTLS
443
 
            libraries, making them print large amounts of debugging
444
 
            output.
445
 
          </para>
446
 
        </listitem>
447
 
      </varlistentry>
448
 
      
449
 
      <varlistentry>
450
 
        <term><option>--help</option></term>
451
 
        <term><option>-?</option></term>
452
 
        <listitem>
453
 
          <para>
454
 
            Gives a help message about options and their meanings.
455
 
          </para>
456
 
        </listitem>
457
 
      </varlistentry>
458
 
      
459
 
      <varlistentry>
460
 
        <term><option>--usage</option></term>
461
 
        <listitem>
462
 
          <para>
463
 
            Gives a short usage message.
464
 
          </para>
465
 
        </listitem>
466
 
      </varlistentry>
467
 
      
468
 
      <varlistentry>
469
 
        <term><option>--version</option></term>
470
 
        <term><option>-V</option></term>
471
 
        <listitem>
472
 
          <para>
473
 
            Prints the program version.
474
 
          </para>
475
 
        </listitem>
476
 
      </varlistentry>
477
 
    </variablelist>
478
 
  </refsect1>
479
 
  
480
 
  <refsect1 id="overview">
481
 
    <title>OVERVIEW</title>
482
 
    <xi:include href="../overview.xml"/>
483
 
    <para>
484
 
      This program is the client part.  It is run automatically in an
485
 
      initial <acronym>RAM</acronym> disk environment.
486
 
    </para>
487
 
    <para>
488
 
      In an initial <acronym>RAM</acronym> disk environment using
489
 
      <citerefentry><refentrytitle>systemd</refentrytitle>
490
 
      <manvolnum>1</manvolnum></citerefentry>, this program is started
491
 
      by the <application>Mandos</application> <citerefentry>
492
 
      <refentrytitle>password-agent</refentrytitle>
493
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
494
 
      started automatically by the <citerefentry>
495
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
 
      </citerefentry> <quote>Password Agent</quote> system.
497
 
    </para>
498
 
    <para>
499
 
      In the case of a non-<citerefentry>
500
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
501
 
      </citerefentry> environment, this program is started as a plugin
502
 
      of the <application>Mandos</application> <citerefentry>
503
 
      <refentrytitle>plugin-runner</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
505
 
      initial <acronym>RAM</acronym> disk environment because it is
506
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
507
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
508
 
      </citerefentry> file.
509
 
    </para>
510
 
    <para>
511
 
      This program could, theoretically, be used as a keyscript in
512
 
      <filename>/etc/crypttab</filename>, but it would then be
513
 
      impossible to enter a password for the encrypted root disk at
514
 
      the console, since this program does not read from the console
515
 
      at all.
516
 
    </para>
517
 
  </refsect1>
518
 
  
519
 
  <refsect1 id="exit_status">
520
 
    <title>EXIT STATUS</title>
521
 
    <para>
522
 
      This program will exit with a successful (zero) exit status if a
523
 
      server could be found and the password received from it could be
524
 
      successfully decrypted and output on standard output.  The
525
 
      program will exit with a non-zero exit status only if a critical
526
 
      error occurs.  Otherwise, it will forever connect to any
527
 
      discovered <application>Mandos</application> servers, trying to
528
 
      get a decryptable password and print it.
529
 
    </para>
530
 
  </refsect1>
531
 
  
532
 
  <refsect1 id="environment">
533
 
    <title>ENVIRONMENT</title>
534
 
    <variablelist>
535
 
      <varlistentry>
536
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
537
 
        <listitem>
538
 
          <para>
539
 
            This environment variable will be assumed to contain the
540
 
            directory containing any helper executables.  The use and
541
 
            nature of these helper executables, if any, is purposely
542
 
            not documented.
543
 
        </para>
544
 
        </listitem>
545
 
      </varlistentry>
546
 
    </variablelist>
547
 
    <para>
548
 
      This program does not use any other environment variables, not
549
 
      even the ones provided by <citerefentry><refentrytitle
550
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
551
 
    </citerefentry>.
552
 
    </para>
553
 
  </refsect1>
554
 
  
555
 
  <refsect1 id="network-hooks">
556
 
    <title>NETWORK HOOKS</title>
557
 
    <para>
558
 
      If a network interface like a bridge or tunnel is required to
559
 
      find a Mandos server, this requires the interface to be up and
560
 
      running before <command>&COMMANDNAME;</command> starts looking
561
 
      for Mandos servers.  This can be accomplished by creating a
562
 
      <quote>network hook</quote> program, and placing it in a special
563
 
      directory.
564
 
    </para>
565
 
    <para>
566
 
      Before the network is used (and again before program exit), any
567
 
      runnable programs found in the network hook directory are run
568
 
      with the argument <quote><literal>start</literal></quote> or
569
 
      <quote><literal>stop</literal></quote>.  This should bring up or
570
 
      down, respectively, any network interface which
571
 
      <command>&COMMANDNAME;</command> should use.
572
 
    </para>
573
 
    <refsect2 id="hook-requirements">
574
 
      <title>REQUIREMENTS</title>
575
 
      <para>
576
 
        A network hook must be an executable file, and its name must
577
 
        consist entirely of upper and lower case letters, digits,
578
 
        underscores, periods, and hyphens.
579
 
      </para>
580
 
      <para>
581
 
        A network hook will receive one argument, which can be one of
582
 
        the following:
583
 
      </para>
584
 
      <variablelist>
585
 
        <varlistentry>
586
 
          <term><literal>start</literal></term>
587
 
          <listitem>
588
 
            <para>
589
 
              This should make the network hook create (if necessary)
590
 
              and bring up a network interface.
591
 
            </para>
592
 
          </listitem>
593
 
        </varlistentry>
594
 
        <varlistentry>
595
 
          <term><literal>stop</literal></term>
596
 
          <listitem>
597
 
            <para>
598
 
              This should make the network hook take down a network
599
 
              interface, and delete it if it did not exist previously.
600
 
            </para>
601
 
          </listitem>
602
 
        </varlistentry>
603
 
        <varlistentry>
604
 
          <term><literal>files</literal></term>
605
 
          <listitem>
606
 
            <para>
607
 
              This should make the network hook print, <emphasis>one
608
 
              file per line</emphasis>, all the files needed for it to
609
 
              run.  (These files will be copied into the initial RAM
610
 
              filesystem.)  Typical use is for a network hook which is
611
 
              a shell script to print its needed binaries.
612
 
            </para>
613
 
            <para>
614
 
              It is not necessary to print any non-executable files
615
 
              already in the network hook directory, these will be
616
 
              copied implicitly if they otherwise satisfy the name
617
 
              requirements.
618
 
            </para>
619
 
          </listitem>
620
 
        </varlistentry>
621
 
        <varlistentry>
622
 
          <term><literal>modules</literal></term>
623
 
          <listitem>
624
 
            <para>
625
 
              This should make the network hook print, <emphasis>on
626
 
              separate lines</emphasis>, all the kernel modules needed
627
 
              for it to run.  (These modules will be copied into the
628
 
              initial RAM filesystem.)  For instance, a tunnel
629
 
              interface needs the
630
 
              <quote><literal>tun</literal></quote> module.
631
 
            </para>
632
 
          </listitem>
633
 
        </varlistentry>
634
 
      </variablelist>
635
 
      <para>
636
 
        The network hook will be provided with a number of environment
637
 
        variables:
638
 
      </para>
639
 
      <variablelist>
640
 
        <varlistentry>
641
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
642
 
          <listitem>
643
 
            <para>
644
 
              The network hook directory, specified to
645
 
              <command>&COMMANDNAME;</command> by the
646
 
              <option>--network-hook-dir</option> option.  Note: this
647
 
              should <emphasis>always</emphasis> be used by the
648
 
              network hook to refer to itself or any files in the hook
649
 
              directory it may require.
650
 
            </para>
651
 
          </listitem>
652
 
        </varlistentry>
653
 
        <varlistentry>
654
 
          <term><envar>DEVICE</envar></term>
655
 
          <listitem>
656
 
            <para>
657
 
              The network interfaces, as specified to
658
 
              <command>&COMMANDNAME;</command> by the
659
 
              <option>--interface</option> option, combined to one
660
 
              string and separated by commas.  If this is set, and
661
 
              does not contain the interface a hook will bring up,
662
 
              there is no reason for a hook to continue.
663
 
            </para>
664
 
          </listitem>
665
 
        </varlistentry>
666
 
        <varlistentry>
667
 
          <term><envar>MODE</envar></term>
668
 
          <listitem>
669
 
            <para>
670
 
              This will be the same as the first argument;
671
 
              i.e. <quote><literal>start</literal></quote>,
672
 
              <quote><literal>stop</literal></quote>,
673
 
              <quote><literal>files</literal></quote>, or
674
 
              <quote><literal>modules</literal></quote>.
675
 
            </para>
676
 
          </listitem>
677
 
        </varlistentry>
678
 
        <varlistentry>
679
 
          <term><envar>VERBOSITY</envar></term>
680
 
          <listitem>
681
 
            <para>
682
 
              This will be the <quote><literal>1</literal></quote> if
683
 
              the <option>--debug</option> option is passed to
684
 
              <command>&COMMANDNAME;</command>, otherwise
685
 
              <quote><literal>0</literal></quote>.
686
 
            </para>
687
 
          </listitem>
688
 
        </varlistentry>
689
 
        <varlistentry>
690
 
          <term><envar>DELAY</envar></term>
691
 
          <listitem>
692
 
            <para>
693
 
              This will be the same as the <option>--delay</option>
694
 
              option passed to <command>&COMMANDNAME;</command>.  Is
695
 
              only set if <envar>MODE</envar> is
696
 
              <quote><literal>start</literal></quote> or
697
 
              <quote><literal>stop</literal></quote>.
698
 
            </para>
699
 
          </listitem>
700
 
        </varlistentry>
701
 
        <varlistentry>
702
 
          <term><envar>CONNECT</envar></term>
703
 
          <listitem>
704
 
            <para>
705
 
              This will be the same as the <option>--connect</option>
706
 
              option passed to <command>&COMMANDNAME;</command>.  Is
707
 
              only set if <option>--connect</option> is passed and
708
 
              <envar>MODE</envar> is
709
 
              <quote><literal>start</literal></quote> or
710
 
              <quote><literal>stop</literal></quote>.
711
 
            </para>
712
 
          </listitem>
713
 
        </varlistentry>
714
 
      </variablelist>
715
 
      <para>
716
 
        A hook may not read from standard input, and should be
717
 
        restrictive in printing to standard output or standard error
718
 
        unless <varname>VERBOSITY</varname> is
719
 
        <quote><literal>1</literal></quote>.
720
 
      </para>
721
 
    </refsect2>
722
 
  </refsect1>
723
 
  
724
 
  <refsect1 id="files">
725
 
    <title>FILES</title>
726
 
    <variablelist>
727
 
      <varlistentry>
728
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
729
 
        ></term>
730
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
731
 
        ></term>
732
 
        <listitem>
733
 
          <para>
734
 
            OpenPGP public and private key files, in <quote>ASCII
735
 
            Armor</quote> format.  These are the default file names,
736
 
            they can be changed with the <option>--pubkey</option> and
737
 
            <option>--seckey</option> options.
738
 
          </para>
739
 
        </listitem>
740
 
      </varlistentry>
741
 
      <varlistentry>
742
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
743
 
        ></term>
744
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
745
 
        ></term>
746
 
        <listitem>
747
 
          <para>
748
 
            Public and private raw key files, in <quote>PEM</quote>
749
 
            format.  These are the default file names, they can be
750
 
            changed with the <option>--tls-pubkey</option> and
751
 
            <option>--tls-privkey</option> options.
752
 
          </para>
753
 
        </listitem>
754
 
      </varlistentry>
755
 
      <varlistentry>
756
 
        <term><filename
757
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
758
 
        <listitem>
759
 
          <para>
760
 
            Directory where network hooks are located.  Change this
761
 
            with the <option>--network-hook-dir</option> option.  See
762
 
            <xref linkend="network-hooks"/>.
763
 
          </para>
764
 
        </listitem>
765
 
      </varlistentry>
766
 
    </variablelist>
767
 
  </refsect1>
768
 
  
769
 
  <refsect1 id="bugs">
770
 
    <title>BUGS</title>
771
 
    <xi:include href="../bugs.xml"/>
772
 
  </refsect1>
773
 
  
774
 
  <refsect1 id="example">
775
 
    <title>EXAMPLE</title>
776
 
    <para>
777
 
      Note that normally, command line options will not be given
778
 
      directly, but passed on via the program responsible for starting
779
 
      this program; see <xref linkend="overview"/>.
780
 
    </para>
781
 
    <informalexample>
782
 
      <para>
783
 
        Normal invocation needs no options, if the network interfaces
784
 
        can be automatically determined:
785
 
      </para>
786
 
      <para>
787
 
        <userinput>&COMMANDNAME;</userinput>
788
 
      </para>
789
 
    </informalexample>
790
 
    <informalexample>
791
 
      <para>
792
 
        Search for Mandos servers (and connect to them) using one
793
 
        specific interface:
794
 
      </para>
795
 
      <para>
796
 
        <!-- do not wrap this line -->
797
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
798
 
      </para>
799
 
    </informalexample>
800
 
    <informalexample>
801
 
      <para>
802
 
        Run in debug mode, and use custom keys:
803
 
      </para>
804
 
      <para>
805
 
 
806
 
<!-- do not wrap this line -->
807
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
808
 
 
809
 
      </para>
810
 
    </informalexample>
811
 
    <informalexample>
812
 
      <para>
813
 
        Run in debug mode, with custom keys, and do not use Zeroconf
814
 
        to locate a server; connect directly to the IPv6 link-local
815
 
        address <quote><systemitem class="ipaddress"
816
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
817
 
        using interface eth2:
818
 
      </para>
819
 
      <para>
820
 
 
821
 
<!-- do not wrap this line -->
822
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
823
 
 
824
 
      </para>
825
 
    </informalexample>
826
 
  </refsect1>
827
 
  
828
 
  <refsect1 id="security">
829
 
    <title>SECURITY</title>
830
 
    <para>
831
 
      This program assumes that it is set-uid to root, and will switch
832
 
      back to the original (and presumably non-privileged) user and
833
 
      group after bringing up the network interface.
834
 
    </para>
835
 
    <para>
836
 
      To use this program for its intended purpose (see <xref
837
 
      linkend="purpose"/>), the password for the root file system will
838
 
      have to be given out to be stored in a server computer, after
839
 
      having been encrypted using an OpenPGP key.  This encrypted data
840
 
      which will be stored in a server can only be decrypted by the
841
 
      OpenPGP key, and the data will only be given out to those
842
 
      clients who can prove they actually have that key.  This key,
843
 
      however, is stored unencrypted on the client side in its initial
844
 
      <acronym>RAM</acronym> disk image file system.  This is normally
845
 
      readable by all, but this is normally fixed during installation
846
 
      of this program; file permissions are set so that no-one is able
847
 
      to read that file.
848
 
    </para>
849
 
    <para>
850
 
      The only remaining weak point is that someone with physical
851
 
      access to the client hard drive might turn off the client
852
 
      computer, read the OpenPGP and TLS keys directly from the hard
853
 
      drive, and communicate with the server.  To safeguard against
854
 
      this, the server is supposed to notice the client disappearing
855
 
      and stop giving out the encrypted data.  Therefore, it is
856
 
      important to set the timeout and checker interval values tightly
857
 
      on the server.  See <citerefentry><refentrytitle
858
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
859
 
    </para>
860
 
    <para>
861
 
      It will also help if the checker program on the server is
862
 
      configured to request something from the client which can not be
863
 
      spoofed by someone else on the network, like SSH server key
864
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
865
 
      echo (<quote>ping</quote>) replies.
866
 
    </para>
867
 
    <para>
868
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
869
 
      have <application >Mandos</application> clients which dual-boot
870
 
      to another operating system which is <emphasis>not</emphasis>
871
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
872
 
      confidential.
873
 
    </para>
874
 
  </refsect1>
875
 
  
876
 
  <refsect1 id="see_also">
877
 
    <title>SEE ALSO</title>
878
 
    <para>
879
 
      <citerefentry><refentrytitle>intro</refentrytitle>
880
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
881
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
882
 
      <manvolnum>8</manvolnum></citerefentry>,
883
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
884
 
      <manvolnum>5</manvolnum></citerefentry>,
885
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
886
 
      <manvolnum>8</manvolnum></citerefentry>,
887
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
888
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
889
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
890
 
      <manvolnum>8mandos</manvolnum></citerefentry>
891
 
    </para>
892
 
    <variablelist>
893
 
      <varlistentry>
894
 
        <term>
895
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
896
 
        </term>
897
 
        <listitem>
898
 
          <para>
899
 
            Zeroconf is the network protocol standard used for finding
900
 
            Mandos servers on the local network.
901
 
          </para>
902
 
        </listitem>
903
 
      </varlistentry>
904
 
      <varlistentry>
905
 
        <term>
906
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
907
 
        </term>
908
 
      <listitem>
909
 
        <para>
910
 
          Avahi is the library this program calls to find Zeroconf
911
 
          services.
912
 
        </para>
913
 
      </listitem>
914
 
      </varlistentry>
915
 
      <varlistentry>
916
 
        <term>
917
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
918
 
        </term>
919
 
      <listitem>
920
 
        <para>
921
 
          GnuTLS is the library this client uses to implement TLS for
922
 
          communicating securely with the server, and at the same time
923
 
          send the public key to the server.
924
 
        </para>
925
 
      </listitem>
926
 
      </varlistentry>
927
 
      <varlistentry>
928
 
        <term>
929
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
930
 
                 >GPGME</ulink>
931
 
        </term>
932
 
        <listitem>
933
 
          <para>
934
 
            GPGME is the library used to decrypt the OpenPGP data sent
935
 
            by the server.
936
 
          </para>
937
 
        </listitem>
938
 
      </varlistentry>
939
 
      <varlistentry>
940
 
        <term>
941
 
          RFC 4291: <citetitle>IP Version 6 Addressing
942
 
          Architecture</citetitle>
943
 
        </term>
944
 
        <listitem>
945
 
          <variablelist>
946
 
            <varlistentry>
947
 
              <term>Section 2.2: <citetitle>Text Representation of
948
 
              Addresses</citetitle></term>
949
 
              <listitem><para/></listitem>
950
 
            </varlistentry>
951
 
            <varlistentry>
952
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
953
 
              Address</citetitle></term>
954
 
              <listitem><para/></listitem>
955
 
            </varlistentry>
956
 
            <varlistentry>
957
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
958
 
            Addresses</citetitle></term>
959
 
            <listitem>
960
 
              <para>
961
 
                This client uses IPv6 link-local addresses, which are
962
 
                immediately usable since a link-local addresses is
963
 
                automatically assigned to a network interface when it
964
 
                is brought up.
965
 
              </para>
966
 
            </listitem>
967
 
            </varlistentry>
968
 
          </variablelist>
969
 
        </listitem>
970
 
      </varlistentry>
971
 
      <varlistentry>
972
 
        <term>
973
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
974
 
          Protocol Version 1.2</citetitle>
975
 
        </term>
976
 
      <listitem>
977
 
        <para>
978
 
          TLS 1.2 is the protocol implemented by GnuTLS.
979
 
        </para>
980
 
      </listitem>
981
 
      </varlistentry>
982
 
      <varlistentry>
983
 
        <term>
984
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
985
 
        </term>
986
 
      <listitem>
987
 
        <para>
988
 
          The data received from the server is binary encrypted
989
 
          OpenPGP data.
990
 
        </para>
991
 
      </listitem>
992
 
      </varlistentry>
993
 
      <varlistentry>
994
 
        <term>
995
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
996
 
          Layer Security (TLS) and Datagram Transport Layer Security
997
 
          (DTLS)</citetitle>
998
 
        </term>
999
 
      <listitem>
1000
 
        <para>
1001
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
1002
 
          present, used by this program so that raw public keys can be
1003
 
          used.
1004
 
        </para>
1005
 
      </listitem>
1006
 
      </varlistentry>
1007
 
      <varlistentry>
1008
 
        <term>
1009
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
1010
 
          Security</citetitle>
1011
 
        </term>
1012
 
      <listitem>
1013
 
        <para>
1014
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1015
 
          if present, used by this program so that OpenPGP keys can be
1016
 
          used.
1017
 
        </para>
1018
 
      </listitem>
1019
 
      </varlistentry>
 
83
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
84
      like a client program that through avahi detects mandos servers,
 
85
      sets up a gnutls connect and request a encrypted password. Any
 
86
      passwords given is automaticly decrypted and passed to
 
87
      cryptsetup.
 
88
    </para>
 
89
 
 
90
    <variablelist>
 
91
      <varlistentry>
 
92
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
93
        IP</replaceable></literal></term>
 
94
        <listitem>
 
95
          <para>
 
96
            Connect directly to a sepcified mandos server
 
97
          </para>
 
98
        </listitem>
 
99
      </varlistentry>
 
100
 
 
101
      <varlistentry>
 
102
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
103
        KEYDIR</replaceable></literal></term>
 
104
        <listitem>
 
105
          <para>
 
106
            Directory where the openpgp keyring is
 
107
          </para>
 
108
        </listitem>
 
109
      </varlistentry>      
 
110
 
 
111
      <varlistentry>
 
112
        <term><literal>-i</literal>, <literal>--interface=
 
113
        <replaceable>INTERFACE</replaceable></literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            Interface that Avahi will conntect through
 
117
          </para>
 
118
        </listitem>
 
119
      </varlistentry>      
 
120
 
 
121
      <varlistentry>
 
122
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
123
        PUBKEY</replaceable></literal></term>
 
124
        <listitem>
 
125
          <para>
 
126
            Public openpgp key for gnutls authentication
 
127
          </para>
 
128
        </listitem>
 
129
      </varlistentry>      
 
130
 
 
131
      <varlistentry>
 
132
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
133
        SECKEY</replaceable></literal></term>
 
134
        <listitem>
 
135
          <para>
 
136
            Secret openpgp key for gnutls authentication
 
137
          </para>
 
138
        </listitem>
 
139
      </varlistentry>            
 
140
      
 
141
      <varlistentry>
 
142
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
143
        </literal></term>
 
144
        <listitem>
 
145
          <para>
 
146
            GNUTLS priority
 
147
          </para>
 
148
        </listitem>
 
149
      </varlistentry>            
 
150
 
 
151
      <varlistentry>
 
152
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
153
        </literal></term>
 
154
        <listitem>
 
155
          <para>
 
156
            dh-bits to use in gnutls communication
 
157
          </para>
 
158
        </listitem>
 
159
      </varlistentry>      
 
160
      
 
161
      <varlistentry>
 
162
        <term><literal>--debug</literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Debug mode
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>
 
169
      
 
170
      <varlistentry>
 
171
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
172
        <listitem>
 
173
          <para>
 
174
            Gives a help message
 
175
          </para>
 
176
        </listitem>
 
177
      </varlistentry>
 
178
      
 
179
      <varlistentry>
 
180
        <term><literal>--usage</literal></term>
 
181
        <listitem>
 
182
          <para>
 
183
            Gives a short usage message
 
184
          </para>
 
185
        </listitem>
 
186
      </varlistentry>
 
187
 
 
188
      <varlistentry>
 
189
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Prints the program version
 
193
          </para>
 
194
        </listitem>
 
195
      </varlistentry>            
1020
196
    </variablelist>
1021
197
  </refsect1>
1022
198
</refentry>
1023
 
 
1024
 
<!-- Local Variables: -->
1025
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
1026
 
<!-- time-stamp-end: "[\"']>" -->
1027
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
1028
 
<!-- End: -->