/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: 2009-01-04 22:26:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104222607-1e0yg5d8rj2p18db
Remove debconf note.  Also remove translations support, since only
debconf used it.

* debian/mandos-client.templates: Removed.
* debian/mandos.templates: - '' -
* debian/po/POTFILES.in: - '' -
* debian/po/sv.po: - '' -
* debian/rules (clean): Removed "debconf-updatepo".
  (binary-common): Removed "dh_installdebconf".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
4
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2011</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
94
93
      </arg>
95
94
      <sbr/>
96
95
      <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>
109
96
        <option>--debug</option>
110
97
      </arg>
111
98
    </cmdsynopsis>
135
122
      <command>&COMMANDNAME;</command> is a client program that
136
123
      communicates with <citerefentry><refentrytitle
137
124
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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.
 
125
      to get a password.  It uses IPv6 link-local addresses to get
 
126
      network connectivity, Zeroconf to find servers, and TLS with an
 
127
      OpenPGP key to ensure authenticity and confidentiality.  It
 
128
      keeps running, trying all servers on the network, until it
 
129
      receives a satisfactory reply or a TERM signal is received.
148
130
    </para>
149
131
    <para>
150
132
      This program is not meant to be run directly; it is really meant
204
186
      </varlistentry>
205
187
      
206
188
      <varlistentry>
207
 
        <term><option>--interface=<replaceable
208
 
        >NAME</replaceable></option></term>
 
189
        <term><option>--interface=
 
190
        <replaceable>NAME</replaceable></option></term>
209
191
        <term><option>-i
210
192
        <replaceable>NAME</replaceable></option></term>
211
193
        <listitem>
212
194
          <para>
213
195
            Network interface that will be brought up and scanned for
214
 
            Mandos servers to connect to.  The default is the empty
215
 
            string, which will automatically choose an appropriate
216
 
            interface.
 
196
            Mandos servers to connect to.  The default it
 
197
            <quote><literal>eth0</literal></quote>.
217
198
          </para>
218
199
          <para>
219
200
            If the <option>--connect</option> option is used, this
220
201
            specifies the interface to use to connect to the address
221
202
            given.
222
203
          </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>
239
204
        </listitem>
240
205
      </varlistentry>
241
206
      
286
251
          </para>
287
252
        </listitem>
288
253
      </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>
330
254
      
331
255
      <varlistentry>
332
256
        <term><option>--debug</option></term>
405
329
      server could be found and the password received from it could be
406
330
      successfully decrypted and output on standard output.  The
407
331
      program will exit with a non-zero exit status only if a critical
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.
 
332
      error occurs.  Otherwise, it will forever connect to new
 
333
      <application>Mandos</application> servers as they appear, trying
 
334
      to get a decryptable password and print it.
411
335
    </para>
412
336
  </refsect1>
413
337
  
488
412
    <informalexample>
489
413
      <para>
490
414
        Run in debug mode, with a custom key, and do not use Zeroconf
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:
 
415
        to locate a server; connect directly to the IPv6 address
 
416
        <quote><systemitem class="ipaddress"
 
417
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
418
        port 4711, using interface eth2:
495
419
      </para>
496
420
      <para>
497
421
 
498
422
<!-- do not wrap this line -->
499
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
423
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
500
424
 
501
425
      </para>
502
426
    </informalexample>
552
476
  <refsect1 id="see_also">
553
477
    <title>SEE ALSO</title>
554
478
    <para>
555
 
      <citerefentry><refentrytitle>intro</refentrytitle>
556
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
557
479
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
558
480
      <manvolnum>8</manvolnum></citerefentry>,
559
481
      <citerefentry><refentrytitle>crypttab</refentrytitle>