/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: 2012-01-01 01:16:15 UTC
  • Revision ID: teddy@recompile.se-20120101011615-1jzyuxbw1z4700a3
* mandos-ctl (main): Bug fix: Make --secret actually work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
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 "2015-07-06">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
37
      <holder>Teddy Hogeborn</holder>
41
38
      <holder>Björn Påhlsson</holder>
42
39
    </copyright>
67
64
        ><replaceable>PORT</replaceable></option></arg>
68
65
      </group>
69
66
      <sbr/>
70
 
      <group rep='repeat'>
 
67
      <group>
71
68
        <arg choice="plain"><option>--interface
72
 
        <replaceable>NAME</replaceable><arg rep='repeat'
73
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
74
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
75
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
76
 
        ></option></arg>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
77
72
      </group>
78
73
      <sbr/>
79
74
      <group>
142
137
      communicates with <citerefentry><refentrytitle
143
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
144
139
      to get a password.  In slightly more detail, this client program
145
 
      brings up network interfaces, uses the interfaces’ IPv6
146
 
      link-local addresses to get network connectivity, uses Zeroconf
147
 
      to find servers on the local network, and communicates with
148
 
      servers using TLS with an OpenPGP key to ensure authenticity and
 
140
      brings up a network interface, uses the interface’s IPv6
 
141
      link-local address to get network connectivity, uses Zeroconf to
 
142
      find servers on the local network, and communicates with servers
 
143
      using TLS with an OpenPGP key to ensure authenticity and
149
144
      confidentiality.  This client program keeps running, trying all
150
145
      servers on the network, until it receives a satisfactory reply
151
146
      or a TERM signal.  After all servers have been tried, all
153
148
      will wait indefinitely for new servers to appear.
154
149
    </para>
155
150
    <para>
156
 
      The network interfaces are selected like this: If any interfaces
157
 
      are specified using the <option>--interface</option> option,
158
 
      those interface are used.  Otherwise,
159
 
      <command>&COMMANDNAME;</command> will use all interfaces that
160
 
      are not loopback interfaces, are not point-to-point interfaces,
161
 
      are capable of broadcasting and do not have the NOARP flag (see
 
151
      The network interface is selected like this: If an interface is
 
152
      specified using the <option>--interface</option> option, that
 
153
      interface is used.  Otherwise, <command>&COMMANDNAME;</command>
 
154
      will choose any interface that is up and running and is not a
 
155
      loopback interface, is not a point-to-point interface, is
 
156
      capable of broadcasting and does not have the NOARP flag (see
162
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
163
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
164
159
      <option>--connect</option> option is used, point-to-point
165
 
      interfaces and non-broadcast interfaces are accepted.)  If any
166
 
      used interfaces are not up and running, they are first taken up
167
 
      (and later taken down again on program exit).
 
160
      interfaces and non-broadcast interfaces are accepted.)  If no
 
161
      acceptable interfaces are found, re-run the check but without
 
162
      the <quote>up and running</quote> requirement, and manually take
 
163
      the selected interface up (and later take it down on program
 
164
      exit).
168
165
    </para>
169
166
    <para>
170
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
171
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
172
169
    </para>
173
170
    <para>
221
218
            assumed to separate the address from the port number.
222
219
          </para>
223
220
          <para>
224
 
            Normally, Zeroconf would be used to locate Mandos servers,
225
 
            in which case this option would only be used when testing
226
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
227
223
          </para>
228
224
        </listitem>
229
225
      </varlistentry>
230
226
      
231
227
      <varlistentry>
232
228
        <term><option>--interface=<replaceable
233
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
234
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
235
230
        <term><option>-i
236
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
237
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
238
232
        <listitem>
239
233
          <para>
240
 
            Comma separated list of network interfaces that will be
241
 
            brought up and scanned for Mandos servers to connect to.
242
 
            The default is the empty string, which will automatically
243
 
            use all appropriate interfaces.
 
234
            Network interface that will be brought up and scanned for
 
235
            Mandos servers to connect to.  The default is the empty
 
236
            string, which will automatically choose an appropriate
 
237
            interface.
244
238
          </para>
245
239
          <para>
246
 
            If the <option>--connect</option> option is used, and
247
 
            exactly one interface name is specified (except
248
 
            <quote><literal>none</literal></quote>), this specifies
249
 
            the interface to use to connect to the address given.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
250
243
          </para>
251
244
          <para>
252
245
            Note that since this program will normally run in the
253
246
            initial RAM disk environment, the interface must be an
254
247
            interface which exists at that stage.  Thus, the interface
255
 
            can normally not be a pseudo-interface such as
256
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
257
 
            will not exist until much later in the boot process, and
258
 
            can not be used by this program, unless created by a
259
 
            <quote>network hook</quote> — see <xref
260
 
            linkend="network-hooks"/>.
 
248
            can not be a pseudo-interface such as <quote>br0</quote>
 
249
            or <quote>tun0</quote>; such interfaces will not exist
 
250
            until much later in the boot process, and can not be used
 
251
            by this program, unless created by a <quote>network
 
252
            hook</quote> — see <xref linkend="network-hooks"/>.
261
253
          </para>
262
254
          <para>
263
255
            <replaceable>NAME</replaceable> can be the string
264
 
            <quote><literal>none</literal></quote>; this will make
265
 
            <command>&COMMANDNAME;</command> only bring up interfaces
266
 
            specified <emphasis>before</emphasis> this string.  This
267
 
            is not recommended, and only meant for advanced users.
 
256
            <quote><literal>none</literal></quote>; this will not use
 
257
            any specific interface, and will not bring up an interface
 
258
            on startup.  This is not recommended, and only meant for
 
259
            advanced users.
268
260
          </para>
269
261
        </listitem>
270
262
      </varlistentry>
312
304
        <listitem>
313
305
          <para>
314
306
            Sets the number of bits to use for the prime number in the
315
 
            TLS Diffie-Hellman key exchange.  The default value is
316
 
            selected automatically based on the OpenPGP key.
 
307
            TLS Diffie-Hellman key exchange.  Default is 1024.
317
308
          </para>
318
309
        </listitem>
319
310
      </varlistentry>
323
314
        >SECONDS</replaceable></option></term>
324
315
        <listitem>
325
316
          <para>
326
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
327
318
            for the interface to arrive in a <quote>running</quote>
328
319
            state before proceeding.  During this time, the kernel log
329
320
            level will be lowered to reduce clutter on the system
446
437
  
447
438
  <refsect1 id="environment">
448
439
    <title>ENVIRONMENT</title>
449
 
    <variablelist>
450
 
      <varlistentry>
451
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
452
 
        <listitem>
453
 
          <para>
454
 
            This environment variable will be assumed to contain the
455
 
            directory containing any helper executables.  The use and
456
 
            nature of these helper executables, if any, is
457
 
            purposefully not documented.
458
 
        </para>
459
 
        </listitem>
460
 
      </varlistentry>
461
 
    </variablelist>
462
440
    <para>
463
 
      This program does not use any other environment variables, not
464
 
      even the ones provided by <citerefentry><refentrytitle
 
441
      This program does not use any environment variables, not even
 
442
      the ones provided by <citerefentry><refentrytitle
465
443
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
466
444
    </citerefentry>.
467
445
    </para>
529
507
              It is not necessary to print any non-executable files
530
508
              already in the network hook directory, these will be
531
509
              copied implicitly if they otherwise satisfy the name
532
 
              requirements.
 
510
              requirement.
533
511
            </para>
534
512
          </listitem>
535
513
        </varlistentry>
569
547
          <term><envar>DEVICE</envar></term>
570
548
          <listitem>
571
549
            <para>
572
 
              The network interfaces, as specified to
 
550
              The network interface, as specified to
573
551
              <command>&COMMANDNAME;</command> by the
574
 
              <option>--interface</option> option, combined to one
575
 
              string and separated by commas.  If this is set, and
576
 
              does not contain the interface a hook will bring up,
577
 
              there is no reason for a hook to continue.
 
552
              <option>--interface</option> option.  If this is not the
 
553
              interface a hook will bring up, there is no reason for a
 
554
              hook to continue.
578
555
            </para>
579
556
          </listitem>
580
557
        </varlistentry>
683
660
    </para>
684
661
    <informalexample>
685
662
      <para>
686
 
        Normal invocation needs no options, if the network interfaces
687
 
        can be automatically determined:
 
663
        Normal invocation needs no options, if the network interface
 
664
        is <quote>eth0</quote>:
688
665
      </para>
689
666
      <para>
690
667
        <userinput>&COMMANDNAME;</userinput>
692
669
    </informalexample>
693
670
    <informalexample>
694
671
      <para>
695
 
        Search for Mandos servers (and connect to them) using one
696
 
        specific interface:
 
672
        Search for Mandos servers (and connect to them) using another
 
673
        interface:
697
674
      </para>
698
675
      <para>
699
676
        <!-- do not wrap this line -->
763
740
    <para>
764
741
      It will also help if the checker program on the server is
765
742
      configured to request something from the client which can not be
766
 
      spoofed by someone else on the network, like SSH server key
767
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
768
 
      echo (<quote>ping</quote>) replies.
 
743
      spoofed by someone else on the network, unlike unencrypted
 
744
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
769
745
    </para>
770
746
    <para>
771
747
      <emphasis>Note</emphasis>: This makes it completely insecure to
864
840
              <para>
865
841
                This client uses IPv6 link-local addresses, which are
866
842
                immediately usable since a link-local addresses is
867
 
                automatically assigned to a network interface when it
 
843
                automatically assigned to a network interfaces when it
868
844
                is brought up.
869
845
              </para>
870
846
            </listitem>