/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2025-10-27 20:41:11 UTC
  • Revision ID: teddy@recompile.se-20251027204111-kj8ighpkb6e2ei4f
http://bugs.debian.org/1118977
From: Carles Pina i Estany <carles@pina.cat>

Add Catalan debconf translation

* debian/po/ca.po: New.

Closes: #1118977
Acked-by: Teddy Hogeborn <teddy@recompile.se>

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <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>
34
51
      <holder>Teddy Hogeborn</holder>
35
52
      <holder>Björn Påhlsson</holder>
36
53
    </copyright>
37
54
    <xi:include href="../legalnotice.xml"/>
38
55
  </refentryinfo>
39
 
 
 
56
  
40
57
  <refmeta>
41
58
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
59
    <manvolnum>8mandos</manvolnum>
45
62
  <refnamediv>
46
63
    <refname><command>&COMMANDNAME;</command></refname>
47
64
    <refpurpose>
48
 
      Client for mandos
 
65
      Client for <application>Mandos</application>
49
66
    </refpurpose>
50
67
  </refnamediv>
51
 
 
 
68
  
52
69
  <refsynopsisdiv>
53
70
    <cmdsynopsis>
54
71
      <command>&COMMANDNAME;</command>
55
72
      <group>
56
73
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
74
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
75
        ><replaceable>PORT</replaceable></option></arg>
59
76
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
77
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
78
        ><replaceable>PORT</replaceable></option></arg>
62
79
      </group>
63
80
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--keydir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
 
81
      <group rep='repeat'>
72
82
        <arg choice="plain"><option>--interface
73
 
        <replaceable>NAME</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-i
75
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
76
88
      </group>
77
89
      <sbr/>
78
90
      <group>
89
101
        <replaceable>FILE</replaceable></option></arg>
90
102
      </group>
91
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/>
92
118
      <arg>
93
119
        <option>--priority <replaceable>STRING</replaceable></option>
94
120
      </arg>
98
124
      </arg>
99
125
      <sbr/>
100
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>
101
144
        <option>--debug</option>
102
145
      </arg>
103
146
    </cmdsynopsis>
120
163
      </group>
121
164
    </cmdsynopsis>
122
165
  </refsynopsisdiv>
123
 
 
 
166
  
124
167
  <refsect1 id="description">
125
168
    <title>DESCRIPTION</title>
126
169
    <para>
127
 
      <command>&COMMANDNAME;</command> is a mandos plugin that works
128
 
      like a client program that through avahi detects mandos servers,
129
 
      sets up a gnutls connect and request a encrypted password. Any
130
 
      passwords given is automaticly decrypted and passed to
131
 
      cryptsetup.
 
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.
132
217
    </para>
133
218
  </refsect1>
134
219
  
135
220
  <refsect1 id="options">
136
221
    <title>OPTIONS</title>
137
222
    <para>
138
 
      Commonly not invoked as command lines but from configuration
139
 
      file of plugin runner.
 
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.
140
228
    </para>
141
 
 
 
229
    
142
230
    <variablelist>
143
231
      <varlistentry>
144
232
        <term><option>--connect=<replaceable
145
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
233
        >ADDRESS</replaceable><literal>:</literal><replaceable
146
234
        >PORT</replaceable></option></term>
147
235
        <term><option>-c
148
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
236
        <replaceable>ADDRESS</replaceable><literal>:</literal
149
237
        ><replaceable>PORT</replaceable></option></term>
150
238
        <listitem>
151
239
          <para>
152
 
            Connect directly to a specified mandos server
 
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.
153
245
          </para>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
 
157
 
      <varlistentry>
158
 
        <term><option>--keydir=<replaceable
159
 
        >DIRECTORY</replaceable></option></term>
160
 
        <term><option>-d
161
 
        <replaceable>DIRECTORY</replaceable></option></term>
162
 
        <listitem>
163
246
          <para>
164
 
            Directory where the openpgp keyring is
 
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.
165
250
          </para>
166
251
        </listitem>
167
252
      </varlistentry>
168
 
 
 
253
      
169
254
      <varlistentry>
170
 
        <term><option>--interface=
171
 
        <replaceable>NAME</replaceable></option></term>
 
255
        <term><option>--interface=<replaceable
 
256
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
257
        >NAME</replaceable></arg></option></term>
172
258
        <term><option>-i
173
 
        <replaceable>NAME</replaceable></option></term>
 
259
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
260
        >NAME</replaceable></arg></option></term>
174
261
        <listitem>
175
262
          <para>
176
 
            Interface that Avahi will connect through
 
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.
177
291
          </para>
178
292
        </listitem>
179
293
      </varlistentry>
180
 
 
 
294
      
181
295
      <varlistentry>
182
296
        <term><option>--pubkey=<replaceable
183
297
        >FILE</replaceable></option></term>
185
299
        <replaceable>FILE</replaceable></option></term>
186
300
        <listitem>
187
301
          <para>
188
 
            Public openpgp key for gnutls authentication
 
302
            OpenPGP public key file name.  The default name is
 
303
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
304
            ></quote>.
189
305
          </para>
190
306
        </listitem>
191
307
      </varlistentry>
192
 
 
 
308
      
193
309
      <varlistentry>
194
310
        <term><option>--seckey=<replaceable
195
311
        >FILE</replaceable></option></term>
197
313
        <replaceable>FILE</replaceable></option></term>
198
314
        <listitem>
199
315
          <para>
200
 
            Secret OpenPGP key for GnuTLS authentication
 
316
            OpenPGP secret key file name.  The default name is
 
317
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
318
            ></quote>.
201
319
          </para>
202
320
        </listitem>
203
321
      </varlistentry>
204
322
      
205
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>
206
352
        <term><option>--priority=<replaceable
207
353
        >STRING</replaceable></option></term>
208
354
        <listitem>
209
 
          <para>
210
 
            GnuTLS priority
211
 
          </para>
 
355
          <xi:include href="../mandos-options.xml"
 
356
                      xpointer="priority"/>
212
357
        </listitem>
213
358
      </varlistentry>
214
 
 
 
359
      
215
360
      <varlistentry>
216
361
        <term><option>--dh-bits=<replaceable
217
362
        >BITS</replaceable></option></term>
218
363
        <listitem>
219
364
          <para>
220
 
            DH bits to use in gnutls communication
 
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>.
221
429
          </para>
222
430
        </listitem>
223
431
      </varlistentry>
226
434
        <term><option>--debug</option></term>
227
435
        <listitem>
228
436
          <para>
229
 
            Debug mode
 
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.
230
445
          </para>
231
446
        </listitem>
232
447
      </varlistentry>
236
451
        <term><option>-?</option></term>
237
452
        <listitem>
238
453
          <para>
239
 
            Gives a help message
 
454
            Gives a help message about options and their meanings.
240
455
          </para>
241
456
        </listitem>
242
457
      </varlistentry>
245
460
        <term><option>--usage</option></term>
246
461
        <listitem>
247
462
          <para>
248
 
            Gives a short usage message
 
463
            Gives a short usage message.
249
464
          </para>
250
465
        </listitem>
251
466
      </varlistentry>
252
 
 
 
467
      
253
468
      <varlistentry>
254
469
        <term><option>--version</option></term>
255
470
        <term><option>-V</option></term>
256
471
        <listitem>
257
472
          <para>
258
 
            Prints the program version
 
473
            Prints the program version.
259
474
          </para>
260
475
        </listitem>
261
476
      </varlistentry>
262
477
    </variablelist>
263
478
  </refsect1>
264
 
 
 
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
  
265
519
  <refsect1 id="exit_status">
266
520
    <title>EXIT STATUS</title>
267
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.
268
529
    </para>
269
530
  </refsect1>
270
 
 
 
531
  
271
532
  <refsect1 id="environment">
272
533
    <title>ENVIRONMENT</title>
273
 
    <para>
274
 
    </para>
275
 
  </refsect1>
276
 
 
277
 
  <refsect1 id="file">
 
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">
278
725
    <title>FILES</title>
279
 
    <para>
280
 
    </para>
 
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>
281
767
  </refsect1>
282
768
  
283
769
  <refsect1 id="bugs">
284
770
    <title>BUGS</title>
285
 
    <para>
286
 
    </para>
 
771
    <xi:include href="../bugs.xml"/>
287
772
  </refsect1>
288
 
 
 
773
  
289
774
  <refsect1 id="example">
290
775
    <title>EXAMPLE</title>
291
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"/>.
292
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>
293
826
  </refsect1>
294
 
 
 
827
  
295
828
  <refsect1 id="security">
296
829
    <title>SECURITY</title>
297
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.
298
873
    </para>
299
874
  </refsect1>
300
 
 
 
875
  
301
876
  <refsect1 id="see_also">
302
877
    <title>SEE ALSO</title>
303
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>,
304
885
      <citerefentry><refentrytitle>mandos</refentrytitle>
305
886
      <manvolnum>8</manvolnum></citerefentry>,
306
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
887
      <citerefentry><refentrytitle>password-agent</refentrytitle>
307
888
      <manvolnum>8mandos</manvolnum></citerefentry>,
308
889
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
309
890
      <manvolnum>8mandos</manvolnum></citerefentry>
310
891
    </para>
311
 
    <itemizedlist>
312
 
      <listitem><para>
313
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
314
 
      </para></listitem>
315
 
      
316
 
      <listitem><para>
317
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
318
 
      </para></listitem>
319
 
      
320
 
      <listitem><para>
321
 
        <ulink
322
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
323
 
      </para></listitem>
324
 
      
325
 
      <listitem><para>
326
 
        <ulink
327
 
        url="http://www.gnupg.org/related_software/gpgme/">
328
 
        GPGME</ulink>
329
 
      </para></listitem>
330
 
      
331
 
      <listitem><para>
332
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
333
 
        Format</citetitle></citation>
334
 
      </para></listitem>
335
 
      
336
 
      <listitem><para>
337
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
338
 
        Transport Layer Security</citetitle></citation>
339
 
      </para></listitem>
340
 
      
341
 
      <listitem><para>
342
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
343
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
344
 
        Unicast Addresses</citation>
345
 
      </para></listitem>
346
 
    </itemizedlist>
 
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>
 
1020
    </variablelist>
347
1021
  </refsect1>
348
 
 
349
1022
</refentry>
 
1023
 
350
1024
<!-- Local Variables: -->
351
1025
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
352
1026
<!-- time-stamp-end: "[\"']>" -->