/mandos/release

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

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

* network-hooks.d: New directory.
* network-hooks.d/bridge: New example hook.
* network-hooks.d/bridge.conf: Config file for bridge example hook.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
4
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
 
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>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="../legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8mandos</manvolnum>
48
51
      Client for <application>Mandos</application>
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
91
94
      </arg>
92
95
      <sbr/>
93
96
      <arg>
 
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
98
      </arg>
 
99
      <sbr/>
 
100
      <arg>
 
101
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
102
      </arg>
 
103
      <sbr/>
 
104
      <arg>
 
105
        <option>--network-hook-dir<replaceable>DIR</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
94
109
        <option>--debug</option>
95
110
      </arg>
96
111
    </cmdsynopsis>
113
128
      </group>
114
129
    </cmdsynopsis>
115
130
  </refsynopsisdiv>
116
 
 
 
131
  
117
132
  <refsect1 id="description">
118
133
    <title>DESCRIPTION</title>
119
134
    <para>
120
135
      <command>&COMMANDNAME;</command> is a client program that
121
136
      communicates with <citerefentry><refentrytitle
122
137
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
 
      to get a password.  It uses IPv6 link-local addresses to get
124
 
      network connectivity, Zeroconf to find servers, and TLS with an
125
 
      OpenPGP key to ensure authenticity and confidentiality.  It
126
 
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
 
138
      to get a password.  In slightly more detail, this client program
 
139
      brings up a network interface, uses the interface’s IPv6
 
140
      link-local address to get network connectivity, uses Zeroconf to
 
141
      find servers on the local network, and communicates with servers
 
142
      using TLS with an OpenPGP key to ensure authenticity and
 
143
      confidentiality.  This client program keeps running, trying all
 
144
      servers on the network, until it receives a satisfactory reply
 
145
      or a TERM signal.  After all servers have been tried, all
 
146
      servers are periodically retried.  If no servers are found it
 
147
      will wait indefinitely for new servers to appear.
128
148
    </para>
129
149
    <para>
130
150
      This program is not meant to be run directly; it is really meant
184
204
      </varlistentry>
185
205
      
186
206
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><option>--interface=<replaceable
 
208
        >NAME</replaceable></option></term>
189
209
        <term><option>-i
190
210
        <replaceable>NAME</replaceable></option></term>
191
211
        <listitem>
192
212
          <para>
193
213
            Network interface that will be brought up and scanned for
194
 
            Mandos servers to connect to.  The default it
195
 
            <quote><literal>eth0</literal></quote>.
 
214
            Mandos servers to connect to.  The default is the empty
 
215
            string, which will automatically choose an appropriate
 
216
            interface.
196
217
          </para>
197
218
          <para>
198
219
            If the <option>--connect</option> option is used, this
199
220
            specifies the interface to use to connect to the address
200
221
            given.
201
222
          </para>
 
223
          <para>
 
224
            Note that since this program will normally run in the
 
225
            initial RAM disk environment, the interface must be an
 
226
            interface which exists at that stage.  Thus, the interface
 
227
            can not be a pseudo-interface such as <quote>br0</quote>
 
228
            or <quote>tun0</quote>; such interfaces will not exist
 
229
            until much later in the boot process, and can not be used
 
230
            by this program.
 
231
          </para>
 
232
          <para>
 
233
            <replaceable>NAME</replaceable> can be the string
 
234
            <quote><literal>none</literal></quote>; this will not use
 
235
            any specific interface, and will not bring up an interface
 
236
            on startup.  This is not recommended, and only meant for
 
237
            advanced users.
 
238
          </para>
202
239
        </listitem>
203
240
      </varlistentry>
204
241
      
215
252
          </para>
216
253
        </listitem>
217
254
      </varlistentry>
218
 
 
 
255
      
219
256
      <varlistentry>
220
257
        <term><option>--seckey=<replaceable
221
258
        >FILE</replaceable></option></term>
238
275
                      xpointer="priority"/>
239
276
        </listitem>
240
277
      </varlistentry>
241
 
 
 
278
      
242
279
      <varlistentry>
243
280
        <term><option>--dh-bits=<replaceable
244
281
        >BITS</replaceable></option></term>
249
286
          </para>
250
287
        </listitem>
251
288
      </varlistentry>
 
289
 
 
290
      <varlistentry>
 
291
        <term><option>--delay=<replaceable
 
292
        >SECONDS</replaceable></option></term>
 
293
        <listitem>
 
294
          <para>
 
295
            After bringing the network interface up, the program waits
 
296
            for the interface to arrive in a <quote>running</quote>
 
297
            state before proceeding.  During this time, the kernel log
 
298
            level will be lowered to reduce clutter on the system
 
299
            console, alleviating any other plugins which might be
 
300
            using the system console.  This option sets the upper
 
301
            limit of seconds to wait.  The default is 2.5 seconds.
 
302
          </para>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
 
 
306
      <varlistentry>
 
307
        <term><option>--retry=<replaceable
 
308
        >SECONDS</replaceable></option></term>
 
309
        <listitem>
 
310
          <para>
 
311
            All Mandos servers are tried repeatedly until a password
 
312
            is received.  This value specifies, in seconds, how long
 
313
            between each successive try <emphasis>for the same
 
314
            server</emphasis>.  The default is 10 seconds.
 
315
          </para>
 
316
        </listitem>
 
317
      </varlistentry>
 
318
 
 
319
      <varlistentry>
 
320
        <term><option>--network-hook-dir=<replaceable
 
321
        >DIR</replaceable></option></term>
 
322
        <listitem>
 
323
          <para>
 
324
            Network hook directory.  The default directory is
 
325
            <quote><filename class="directory"
 
326
            >/lib/mandos/network-hooks.d</filename></quote>.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
252
330
      
253
331
      <varlistentry>
254
332
        <term><option>--debug</option></term>
284
362
          </para>
285
363
        </listitem>
286
364
      </varlistentry>
287
 
 
 
365
      
288
366
      <varlistentry>
289
367
        <term><option>--version</option></term>
290
368
        <term><option>-V</option></term>
296
374
      </varlistentry>
297
375
    </variablelist>
298
376
  </refsect1>
299
 
 
 
377
  
300
378
  <refsect1 id="overview">
301
379
    <title>OVERVIEW</title>
302
380
    <xi:include href="../overview.xml"/>
327
405
      server could be found and the password received from it could be
328
406
      successfully decrypted and output on standard output.  The
329
407
      program will exit with a non-zero exit status only if a critical
330
 
      error occurs.  Otherwise, it will forever connect to new
331
 
      <application>Mandos</application> servers as they appear, trying
332
 
      to get a decryptable password and print it.
 
408
      error occurs.  Otherwise, it will forever connect to any
 
409
      discovered <application>Mandos</application> servers, trying to
 
410
      get a decryptable password and print it.
333
411
    </para>
334
412
  </refsect1>
335
413
  
343
421
    </para>
344
422
  </refsect1>
345
423
  
346
 
  <refsect1 id="file">
 
424
  <refsect1 id="files">
347
425
    <title>FILES</title>
348
426
    <variablelist>
349
427
      <varlistentry>
368
446
<!--     <para> -->
369
447
<!--     </para> -->
370
448
<!--   </refsect1> -->
371
 
 
 
449
  
372
450
  <refsect1 id="example">
373
451
    <title>EXAMPLE</title>
374
452
    <para>
410
488
    <informalexample>
411
489
      <para>
412
490
        Run in debug mode, with a custom key, and do not use Zeroconf
413
 
        to locate a server; connect directly to the IPv6 address
414
 
        <quote><systemitem class="ipaddress"
415
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
 
        port 4711, using interface eth2:
 
491
        to locate a server; connect directly to the IPv6 link-local
 
492
        address <quote><systemitem class="ipaddress"
 
493
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
494
        using interface eth2:
417
495
      </para>
418
496
      <para>
419
497
 
420
498
<!-- do not wrap this line -->
421
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
499
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
422
500
 
423
501
      </para>
424
502
    </informalexample>
425
503
  </refsect1>
426
 
 
 
504
  
427
505
  <refsect1 id="security">
428
506
    <title>SECURITY</title>
429
507
    <para>
449
527
      The only remaining weak point is that someone with physical
450
528
      access to the client hard drive might turn off the client
451
529
      computer, read the OpenPGP keys directly from the hard drive,
452
 
      and communicate with the server.  The defense against this is
453
 
      that the server is supposed to notice the client disappearing
454
 
      and will stop giving out the encrypted data.  Therefore, it is
455
 
      important to set the timeout and checker interval values tightly
456
 
      on the server.  See <citerefentry><refentrytitle
 
530
      and communicate with the server.  To safeguard against this, the
 
531
      server is supposed to notice the client disappearing and stop
 
532
      giving out the encrypted data.  Therefore, it is important to
 
533
      set the timeout and checker interval values tightly on the
 
534
      server.  See <citerefentry><refentrytitle
457
535
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
536
    </para>
459
537
    <para>
470
548
      confidential.
471
549
    </para>
472
550
  </refsect1>
473
 
 
 
551
  
474
552
  <refsect1 id="see_also">
475
553
    <title>SEE ALSO</title>
476
554
    <para>
 
555
      <citerefentry><refentrytitle>intro</refentrytitle>
 
556
      <manvolnum>8mandos</manvolnum></citerefentry>,
477
557
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
478
558
      <manvolnum>8</manvolnum></citerefentry>,
479
559
      <citerefentry><refentrytitle>crypttab</refentrytitle>
601
681
      </varlistentry>
602
682
    </variablelist>
603
683
  </refsect1>
604
 
 
605
684
</refentry>
 
685
 
606
686
<!-- Local Variables: -->
607
687
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
688
<!-- time-stamp-end: "[\"']>" -->