/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: 2015-07-05 21:38:01 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150705213801-pi8vk0ovlumuj826
plugin-helpers/mandos-client-iprouteadddel.c: Fix #include lines.
(main): Fix minor typo in error message.

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 "2011-11-27">
 
5
<!ENTITY TIMESTAMP "2015-06-29">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2011</year>
 
36
      <year>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
 
39
      <year>2015</year>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
64
67
        ><replaceable>PORT</replaceable></option></arg>
65
68
      </group>
66
69
      <sbr/>
67
 
      <group>
 
70
      <group rep='repeat'>
68
71
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
72
77
      </group>
73
78
      <sbr/>
74
79
      <group>
137
142
      communicates with <citerefentry><refentrytitle
138
143
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
144
      to get a password.  In slightly more detail, this client program
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
 
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
144
149
      confidentiality.  This client program keeps running, trying all
145
150
      servers on the network, until it receives a satisfactory reply
146
151
      or a TERM signal.  After all servers have been tried, all
148
153
      will wait indefinitely for new servers to appear.
149
154
    </para>
150
155
    <para>
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
 
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
157
162
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
163
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
164
      <option>--connect</option> option is used, point-to-point
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).
 
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).
165
168
    </para>
166
169
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
170
      Before network interfaces are selected, all <quote>network
168
171
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
172
    </para>
170
173
    <para>
218
221
            assumed to separate the address from the port number.
219
222
          </para>
220
223
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
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.
223
227
          </para>
224
228
        </listitem>
225
229
      </varlistentry>
226
230
      
227
231
      <varlistentry>
228
232
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
233
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
230
235
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
236
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
237
        >NAME</replaceable></arg></option></term>
232
238
        <listitem>
233
239
          <para>
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.
 
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.
238
244
          </para>
239
245
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
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.
243
250
          </para>
244
251
          <para>
245
252
            Note that since this program will normally run in the
246
253
            initial RAM disk environment, the interface must be an
247
254
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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"/>.
253
261
          </para>
254
262
          <para>
255
263
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
260
268
          </para>
261
269
        </listitem>
262
270
      </varlistentry>
314
322
        >SECONDS</replaceable></option></term>
315
323
        <listitem>
316
324
          <para>
317
 
            After bringing the network interface up, the program waits
 
325
            After bringing a network interface up, the program waits
318
326
            for the interface to arrive in a <quote>running</quote>
319
327
            state before proceeding.  During this time, the kernel log
320
328
            level will be lowered to reduce clutter on the system
437
445
  
438
446
  <refsect1 id="environment">
439
447
    <title>ENVIRONMENT</title>
 
448
    <variablelist>
 
449
      <varlistentry>
 
450
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
451
        <listitem>
 
452
          <para>
 
453
            This environment variable will be assumed to contain the
 
454
            directory containing any helper executables.  The use and
 
455
            nature of these helper executables, if any, is
 
456
            purposefully not documented.
 
457
        </para>
 
458
        </listitem>
 
459
      </varlistentry>
 
460
    </variablelist>
440
461
    <para>
441
 
      This program does not use any environment variables, not even
442
 
      the ones provided by <citerefentry><refentrytitle
 
462
      This program does not use any other environment variables, not
 
463
      even the ones provided by <citerefentry><refentrytitle
443
464
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
465
    </citerefentry>.
445
466
    </para>
507
528
              It is not necessary to print any non-executable files
508
529
              already in the network hook directory, these will be
509
530
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
531
              requirements.
511
532
            </para>
512
533
          </listitem>
513
534
        </varlistentry>
547
568
          <term><envar>DEVICE</envar></term>
548
569
          <listitem>
549
570
            <para>
550
 
              The network interface, as specified to
 
571
              The network interfaces, as specified to
551
572
              <command>&COMMANDNAME;</command> by the
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.
 
573
              <option>--interface</option> option, combined to one
 
574
              string and separated by commas.  If this is set, and
 
575
              does not contain the interface a hook will bring up,
 
576
              there is no reason for a hook to continue.
555
577
            </para>
556
578
          </listitem>
557
579
        </varlistentry>
583
605
          <listitem>
584
606
            <para>
585
607
              This will be the same as the <option>--delay</option>
586
 
              option passed to <command>&COMMANDNAME;</command>.
 
608
              option passed to <command>&COMMANDNAME;</command>.  Is
 
609
              only set if <envar>MODE</envar> is
 
610
              <quote><literal>start</literal></quote> or
 
611
              <quote><literal>stop</literal></quote>.
 
612
            </para>
 
613
          </listitem>
 
614
        </varlistentry>
 
615
        <varlistentry>
 
616
          <term><envar>CONNECT</envar></term>
 
617
          <listitem>
 
618
            <para>
 
619
              This will be the same as the <option>--connect</option>
 
620
              option passed to <command>&COMMANDNAME;</command>.  Is
 
621
              only set if <option>--connect</option> is passed and
 
622
              <envar>MODE</envar> is
 
623
              <quote><literal>start</literal></quote> or
 
624
              <quote><literal>stop</literal></quote>.
587
625
            </para>
588
626
          </listitem>
589
627
        </varlistentry>
644
682
    </para>
645
683
    <informalexample>
646
684
      <para>
647
 
        Normal invocation needs no options, if the network interface
648
 
        is <quote>eth0</quote>:
 
685
        Normal invocation needs no options, if the network interfaces
 
686
        can be automatically determined:
649
687
      </para>
650
688
      <para>
651
689
        <userinput>&COMMANDNAME;</userinput>
653
691
    </informalexample>
654
692
    <informalexample>
655
693
      <para>
656
 
        Search for Mandos servers (and connect to them) using another
657
 
        interface:
 
694
        Search for Mandos servers (and connect to them) using one
 
695
        specific interface:
658
696
      </para>
659
697
      <para>
660
698
        <!-- do not wrap this line -->
724
762
    <para>
725
763
      It will also help if the checker program on the server is
726
764
      configured to request something from the client which can not be
727
 
      spoofed by someone else on the network, unlike unencrypted
728
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
765
      spoofed by someone else on the network, like SSH server key
 
766
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
767
      echo (<quote>ping</quote>) replies.
729
768
    </para>
730
769
    <para>
731
770
      <emphasis>Note</emphasis>: This makes it completely insecure to
824
863
              <para>
825
864
                This client uses IPv6 link-local addresses, which are
826
865
                immediately usable since a link-local addresses is
827
 
                automatically assigned to a network interfaces when it
 
866
                automatically assigned to a network interface when it
828
867
                is brought up.
829
868
              </para>
830
869
            </listitem>