/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 at bsnet
  • Date: 2010-09-27 18:57:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927185712-d4t34t3y002xr44x
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
                                                         keys.

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
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="../legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8mandos</manvolnum>
45
47
  <refnamediv>
46
48
    <refname><command>&COMMANDNAME;</command></refname>
47
49
    <refpurpose>
48
 
      Client for mandos
 
50
      Client for <application>Mandos</application>
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
91
93
      </arg>
92
94
      <sbr/>
93
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
94
100
        <option>--debug</option>
95
101
      </arg>
96
102
    </cmdsynopsis>
113
119
      </group>
114
120
    </cmdsynopsis>
115
121
  </refsynopsisdiv>
116
 
 
 
122
  
117
123
  <refsect1 id="description">
118
124
    <title>DESCRIPTION</title>
119
125
    <para>
120
126
      <command>&COMMANDNAME;</command> is a client program that
121
127
      communicates with <citerefentry><refentrytitle
122
128
      >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.
 
129
      to get a password.  In slightly more detail, this client program
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
 
134
      confidentiality.  This client program keeps running, trying all
 
135
      servers on the network, until it receives a satisfactory reply
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
128
139
    </para>
129
140
    <para>
130
141
      This program is not meant to be run directly; it is really meant
184
195
      </varlistentry>
185
196
      
186
197
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
189
200
        <term><option>-i
190
201
        <replaceable>NAME</replaceable></option></term>
191
202
        <listitem>
192
203
          <para>
193
204
            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>.
 
205
            Mandos servers to connect to.  The default is the empty
 
206
            string, which will automatically choose an appropriate
 
207
            interface.
196
208
          </para>
197
209
          <para>
198
210
            If the <option>--connect</option> option is used, this
199
211
            specifies the interface to use to connect to the address
200
212
            given.
201
213
          </para>
 
214
          <para>
 
215
            Note that since this program will normally run in the
 
216
            initial RAM disk environment, the interface must be an
 
217
            interface which exists at that stage.  Thus, the interface
 
218
            can not be a pseudo-interface such as <quote>br0</quote>
 
219
            or <quote>tun0</quote>; such interfaces will not exist
 
220
            until much later in the boot process, and can not be used
 
221
            by this program.
 
222
          </para>
 
223
          <para>
 
224
            <replaceable>NAME</replaceable> can be the string
 
225
            <quote><literal>none</literal></quote>; this will not use
 
226
            any specific interface, and will not bring up an interface
 
227
            on startup.  This is not recommended, and only meant for
 
228
            advanced users.
 
229
          </para>
202
230
        </listitem>
203
231
      </varlistentry>
204
232
      
215
243
          </para>
216
244
        </listitem>
217
245
      </varlistentry>
218
 
 
 
246
      
219
247
      <varlistentry>
220
248
        <term><option>--seckey=<replaceable
221
249
        >FILE</replaceable></option></term>
238
266
                      xpointer="priority"/>
239
267
        </listitem>
240
268
      </varlistentry>
241
 
 
 
269
      
242
270
      <varlistentry>
243
271
        <term><option>--dh-bits=<replaceable
244
272
        >BITS</replaceable></option></term>
249
277
          </para>
250
278
        </listitem>
251
279
      </varlistentry>
 
280
 
 
281
      <varlistentry>
 
282
        <term><option>--delay=<replaceable
 
283
        >SECONDS</replaceable></option></term>
 
284
        <listitem>
 
285
          <para>
 
286
            After bringing the network interface up, the program waits
 
287
            for the interface to arrive in a <quote>running</quote>
 
288
            state before proceeding.  During this time, the kernel log
 
289
            level will be lowered to reduce clutter on the system
 
290
            console, alleviating any other plugins which might be
 
291
            using the system console.  This option sets the upper
 
292
            limit of seconds to wait.  The default is 2.5 seconds.
 
293
          </para>
 
294
        </listitem>
 
295
      </varlistentry>
252
296
      
253
297
      <varlistentry>
254
298
        <term><option>--debug</option></term>
284
328
          </para>
285
329
        </listitem>
286
330
      </varlistentry>
287
 
 
 
331
      
288
332
      <varlistentry>
289
333
        <term><option>--version</option></term>
290
334
        <term><option>-V</option></term>
296
340
      </varlistentry>
297
341
    </variablelist>
298
342
  </refsect1>
299
 
 
 
343
  
300
344
  <refsect1 id="overview">
301
345
    <title>OVERVIEW</title>
302
346
    <xi:include href="../overview.xml"/>
311
355
      <filename>/etc/crypttab</filename>, but it would then be
312
356
      impossible to enter a password for the encrypted root disk at
313
357
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
315
 
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallel to this one by the plugin runner.
 
358
      at all.  This is why a separate plugin runner (<citerefentry>
 
359
      <refentrytitle>plugin-runner</refentrytitle>
 
360
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
361
      both this program and others in in parallel,
 
362
      <emphasis>one</emphasis> of which will prompt for passwords on
 
363
      the system console.
318
364
    </para>
319
365
  </refsect1>
320
366
  
327
373
      program will exit with a non-zero exit status only if a critical
328
374
      error occurs.  Otherwise, it will forever connect to new
329
375
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
376
      to get a decryptable password and print it.
331
377
    </para>
332
378
  </refsect1>
333
379
  
341
387
    </para>
342
388
  </refsect1>
343
389
  
344
 
  <refsect1 id="file">
 
390
  <refsect1 id="files">
345
391
    <title>FILES</title>
346
392
    <variablelist>
347
393
      <varlistentry>
366
412
<!--     <para> -->
367
413
<!--     </para> -->
368
414
<!--   </refsect1> -->
369
 
 
 
415
  
370
416
  <refsect1 id="example">
371
417
    <title>EXAMPLE</title>
372
418
    <para>
408
454
    <informalexample>
409
455
      <para>
410
456
        Run in debug mode, with a custom key, and do not use Zeroconf
411
 
        to locate a server; connect directly to the IPv6 address
412
 
        <quote><systemitem class="ipaddress"
413
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
414
 
        port 4711, using interface eth2:
 
457
        to locate a server; connect directly to the IPv6 link-local
 
458
        address <quote><systemitem class="ipaddress"
 
459
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
460
        using interface eth2:
415
461
      </para>
416
462
      <para>
417
463
 
418
464
<!-- do not wrap this line -->
419
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
465
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
420
466
 
421
467
      </para>
422
468
    </informalexample>
423
469
  </refsect1>
424
 
 
 
470
  
425
471
  <refsect1 id="security">
426
472
    <title>SECURITY</title>
427
473
    <para>
447
493
      The only remaining weak point is that someone with physical
448
494
      access to the client hard drive might turn off the client
449
495
      computer, read the OpenPGP keys directly from the hard drive,
450
 
      and communicate with the server.  The defense against this is
451
 
      that the server is supposed to notice the client disappearing
452
 
      and will stop giving out the encrypted data.  Therefore, it is
453
 
      important to set the timeout and checker interval values tightly
454
 
      on the server.  See <citerefentry><refentrytitle
 
496
      and communicate with the server.  To safeguard against this, the
 
497
      server is supposed to notice the client disappearing and stop
 
498
      giving out the encrypted data.  Therefore, it is important to
 
499
      set the timeout and checker interval values tightly on the
 
500
      server.  See <citerefentry><refentrytitle
455
501
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
456
502
    </para>
457
503
    <para>
468
514
      confidential.
469
515
    </para>
470
516
  </refsect1>
471
 
 
 
517
  
472
518
  <refsect1 id="see_also">
473
519
    <title>SEE ALSO</title>
474
520
    <para>
599
645
      </varlistentry>
600
646
    </variablelist>
601
647
  </refsect1>
602
 
 
603
648
</refentry>
 
649
 
604
650
<!-- Local Variables: -->
605
651
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
606
652
<!-- time-stamp-end: "[\"']>" -->