/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-06-13 22:06:57 UTC
  • mto: This revision was merged to the branch mainline in revision 596.
  • Revision ID: teddy@recompile.se-20120613220657-qvq7c7nrndl3t413
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
  (up_interface): Removed; replaced with "interface_is_up".
  (interface_is_up, interface_is_running,
   lower_privileges_permanently, take_down_interface): New.
  (bring_up_interface): Return "error_t".  Use new functions
                        "interface_is_up", "get_flags", and
                        "interface_is_running".
  (main): Save all interfaces either autodetected or specified with
          --interface in argz vector "interfaces".  Save interfaces to
          take down on exit in argz vector "interfaces_to_take_down".
          Save interface names for DEVICE variable to network hooks as
          argz_vector "interfaces_hooks".  Bug fix: Be privileged
          while stopping network hooks.
* plugins.d/mandos-client.xml (SYNOPSIS): Changed --interface synopsis.
  (DESCRIPTION): Updated to document use of all interfaces.
  (OPTIONS): Updated description of "--interface".
* network-hooks.d/bridge: Parse comma-separated DEVICE environment
                          variable.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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 "2015-07-06">
 
5
<!ENTITY TIMESTAMP "2012-06-13">
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>
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
234
            Comma separated list of network interfaces that will be
243
237
            use all appropriate interfaces.
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
261
254
          </para>
262
255
          <para>
263
256
            <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.
 
257
            <quote><literal>none</literal></quote>; this will not use
 
258
            any specific interface, and will not bring up an interface
 
259
            on startup.  This is not recommended, and only meant for
 
260
            advanced users.
268
261
          </para>
269
262
        </listitem>
270
263
      </varlistentry>
312
305
        <listitem>
313
306
          <para>
314
307
            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.
 
308
            TLS Diffie-Hellman key exchange.  Default is 1024.
317
309
          </para>
318
310
        </listitem>
319
311
      </varlistentry>
446
438
  
447
439
  <refsect1 id="environment">
448
440
    <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
441
    <para>
463
 
      This program does not use any other environment variables, not
464
 
      even the ones provided by <citerefentry><refentrytitle
 
442
      This program does not use any environment variables, not even
 
443
      the ones provided by <citerefentry><refentrytitle
465
444
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
466
445
    </citerefentry>.
467
446
    </para>
529
508
              It is not necessary to print any non-executable files
530
509
              already in the network hook directory, these will be
531
510
              copied implicitly if they otherwise satisfy the name
532
 
              requirements.
 
511
              requirement.
533
512
            </para>
534
513
          </listitem>
535
514
        </varlistentry>
683
662
    </para>
684
663
    <informalexample>
685
664
      <para>
686
 
        Normal invocation needs no options, if the network interfaces
 
665
        Normal invocation needs no options, if the network interface
687
666
        can be automatically determined:
688
667
      </para>
689
668
      <para>
692
671
    </informalexample>
693
672
    <informalexample>
694
673
      <para>
695
 
        Search for Mandos servers (and connect to them) using one
696
 
        specific interface:
 
674
        Search for Mandos servers (and connect to them) using another
 
675
        interface:
697
676
      </para>
698
677
      <para>
699
678
        <!-- do not wrap this line -->
763
742
    <para>
764
743
      It will also help if the checker program on the server is
765
744
      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.
 
745
      spoofed by someone else on the network, unlike unencrypted
 
746
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
769
747
    </para>
770
748
    <para>
771
749
      <emphasis>Note</emphasis>: This makes it completely insecure to
864
842
              <para>
865
843
                This client uses IPv6 link-local addresses, which are
866
844
                immediately usable since a link-local addresses is
867
 
                automatically assigned to a network interface when it
 
845
                automatically assigned to a network interfaces when it
868
846
                is brought up.
869
847
              </para>
870
848
            </listitem>