/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

* Makefile (plugins.d/mandos-client): Bug fix: Put $^ before all
                                      libraries.  Remove "$(COMMON)".
                                      Thanks to Angel Abad
                                      <angelabad@ubuntu.com>.
* initramfs-tools-script: Work around change in initramfs-tools,
                          Debian bug #633582.
* plugins.d/mandos-client.c (init_gnutls_global): Bug fix: check for
                errors from gnutls_certificate_allocate_credentials().

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 "2019-02-10">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
36
      <holder>Teddy Hogeborn</holder>
47
37
      <holder>Björn Påhlsson</holder>
48
38
    </copyright>
73
63
        ><replaceable>PORT</replaceable></option></arg>
74
64
      </group>
75
65
      <sbr/>
76
 
      <group rep='repeat'>
 
66
      <group>
77
67
        <arg choice="plain"><option>--interface
78
 
        <replaceable>NAME</replaceable><arg rep='repeat'
79
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
80
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
81
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
82
 
        ></option></arg>
 
68
        <replaceable>NAME</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-i
 
70
        <replaceable>NAME</replaceable></option></arg>
83
71
      </group>
84
72
      <sbr/>
85
73
      <group>
96
84
        <replaceable>FILE</replaceable></option></arg>
97
85
      </group>
98
86
      <sbr/>
99
 
      <group>
100
 
        <arg choice="plain"><option>--tls-privkey
101
 
        <replaceable>FILE</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-t
103
 
        <replaceable>FILE</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--tls-pubkey
108
 
        <replaceable>FILE</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-T
110
 
        <replaceable>FILE</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
87
      <arg>
114
88
        <option>--priority <replaceable>STRING</replaceable></option>
115
89
      </arg>
119
93
      </arg>
120
94
      <sbr/>
121
95
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
97
      </arg>
128
98
      <sbr/>
129
99
      <arg>
130
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
131
 
      </arg>
132
 
      <sbr/>
133
 
      <arg>
134
 
        <option>--network-hook-dir
135
 
        <replaceable>DIR</replaceable></option>
136
 
      </arg>
137
 
      <sbr/>
138
 
      <arg>
139
100
        <option>--debug</option>
140
101
      </arg>
141
102
    </cmdsynopsis>
166
127
      communicates with <citerefentry><refentrytitle
167
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
168
129
      to get a password.  In slightly more detail, this client program
169
 
      brings up network interfaces, uses the interfaces’ IPv6
170
 
      link-local addresses to get network connectivity, uses Zeroconf
171
 
      to find servers on the local network, and communicates with
172
 
      servers using TLS with a raw public key to ensure authenticity
173
 
      and confidentiality.  This client program keeps running, trying
174
 
      all servers on the network, until it receives a satisfactory
175
 
      reply or a TERM signal.  After all servers have been tried, all
176
 
      servers are periodically retried.  If no servers are found it
177
 
      will wait indefinitely for new servers to appear.
178
 
    </para>
179
 
    <para>
180
 
      The network interfaces are selected like this: If any interfaces
181
 
      are specified using the <option>--interface</option> option,
182
 
      those interface are used.  Otherwise,
183
 
      <command>&COMMANDNAME;</command> will use all interfaces that
184
 
      are not loopback interfaces, are not point-to-point interfaces,
185
 
      are capable of broadcasting and do not have the NOARP flag (see
186
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
187
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
188
 
      <option>--connect</option> option is used, point-to-point
189
 
      interfaces and non-broadcast interfaces are accepted.)  If any
190
 
      used interfaces are not up and running, they are first taken up
191
 
      (and later taken down again on program exit).
192
 
    </para>
193
 
    <para>
194
 
      Before network interfaces are selected, all <quote>network
195
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
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.
196
139
    </para>
197
140
    <para>
198
141
      This program is not meant to be run directly; it is really meant
245
188
            assumed to separate the address from the port number.
246
189
          </para>
247
190
          <para>
248
 
            Normally, Zeroconf would be used to locate Mandos servers,
249
 
            in which case this option would only be used when testing
250
 
            and debugging.
 
191
            This option is normally only useful for testing and
 
192
            debugging.
251
193
          </para>
252
194
        </listitem>
253
195
      </varlistentry>
254
196
      
255
197
      <varlistentry>
256
198
        <term><option>--interface=<replaceable
257
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
258
 
        >NAME</replaceable></arg></option></term>
 
199
        >NAME</replaceable></option></term>
259
200
        <term><option>-i
260
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
261
 
        >NAME</replaceable></arg></option></term>
 
201
        <replaceable>NAME</replaceable></option></term>
262
202
        <listitem>
263
203
          <para>
264
 
            Comma separated list of network interfaces that will be
265
 
            brought up and scanned for Mandos servers to connect to.
266
 
            The default is the empty string, which will automatically
267
 
            use all appropriate interfaces.
 
204
            Network interface that will be brought up and scanned for
 
205
            Mandos servers to connect to.  The default is the empty
 
206
            string, which will automatically choose an appropriate
 
207
            interface.
268
208
          </para>
269
209
          <para>
270
 
            If the <option>--connect</option> option is used, and
271
 
            exactly one interface name is specified (except
272
 
            <quote><literal>none</literal></quote>), this specifies
273
 
            the interface to use to connect to the address given.
 
210
            If the <option>--connect</option> option is used, this
 
211
            specifies the interface to use to connect to the address
 
212
            given.
274
213
          </para>
275
214
          <para>
276
215
            Note that since this program will normally run in the
277
216
            initial RAM disk environment, the interface must be an
278
217
            interface which exists at that stage.  Thus, the interface
279
 
            can normally not be a pseudo-interface such as
280
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
281
 
            will not exist until much later in the boot process, and
282
 
            can not be used by this program, unless created by a
283
 
            <quote>network hook</quote> — see <xref
284
 
            linkend="network-hooks"/>.
 
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.
285
222
          </para>
286
223
          <para>
287
224
            <replaceable>NAME</replaceable> can be the string
288
 
            <quote><literal>none</literal></quote>; this will make
289
 
            <command>&COMMANDNAME;</command> only bring up interfaces
290
 
            specified <emphasis>before</emphasis> this string.  This
291
 
            is not recommended, and only meant for advanced users.
 
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.
292
229
          </para>
293
230
        </listitem>
294
231
      </varlistentry>
322
259
      </varlistentry>
323
260
      
324
261
      <varlistentry>
325
 
        <term><option>--tls-pubkey=<replaceable
326
 
        >FILE</replaceable></option></term>
327
 
        <term><option>-T
328
 
        <replaceable>FILE</replaceable></option></term>
329
 
        <listitem>
330
 
          <para>
331
 
            TLS raw public key file name.  The default name is
332
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
333
 
            ></quote>.
334
 
          </para>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
 
338
 
      <varlistentry>
339
 
        <term><option>--tls-privkey=<replaceable
340
 
        >FILE</replaceable></option></term>
341
 
        <term><option>-t
342
 
        <replaceable>FILE</replaceable></option></term>
343
 
        <listitem>
344
 
          <para>
345
 
            TLS secret key file name.  The default name is
346
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
347
 
            ></quote>.
348
 
          </para>
349
 
        </listitem>
350
 
      </varlistentry>
351
 
 
352
 
      <varlistentry>
353
262
        <term><option>--priority=<replaceable
354
263
        >STRING</replaceable></option></term>
355
264
        <listitem>
364
273
        <listitem>
365
274
          <para>
366
275
            Sets the number of bits to use for the prime number in the
367
 
            TLS Diffie-Hellman key exchange.  The default value is
368
 
            selected automatically based on the GnuTLS security
369
 
            profile set in its priority string.  Note that if the
370
 
            <option>--dh-params</option> option is used, the values
371
 
            from that file will be used instead.
372
 
          </para>
373
 
        </listitem>
374
 
      </varlistentry>
375
 
      
376
 
      <varlistentry>
377
 
        <term><option>--dh-params=<replaceable
378
 
        >FILE</replaceable></option></term>
379
 
        <listitem>
380
 
          <para>
381
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
382
 
            needed by the TLS Diffie-Hellman key exchange from.  If
383
 
            this option is not given, or if the file for some reason
384
 
            could not be used, the parameters will be generated on
385
 
            startup, which will take some time and processing power.
386
 
            Those using servers running under time, power or processor
387
 
            constraints may want to generate such a file in advance
388
 
            and use this option.
 
276
            TLS Diffie-Hellman key exchange.  Default is 1024.
389
277
          </para>
390
278
        </listitem>
391
279
      </varlistentry>
395
283
        >SECONDS</replaceable></option></term>
396
284
        <listitem>
397
285
          <para>
398
 
            After bringing a network interface up, the program waits
 
286
            After bringing the network interface up, the program waits
399
287
            for the interface to arrive in a <quote>running</quote>
400
288
            state before proceeding.  During this time, the kernel log
401
289
            level will be lowered to reduce clutter on the system
405
293
          </para>
406
294
        </listitem>
407
295
      </varlistentry>
408
 
 
409
 
      <varlistentry>
410
 
        <term><option>--retry=<replaceable
411
 
        >SECONDS</replaceable></option></term>
412
 
        <listitem>
413
 
          <para>
414
 
            All Mandos servers are tried repeatedly until a password
415
 
            is received.  This value specifies, in seconds, how long
416
 
            between each successive try <emphasis>for the same
417
 
            server</emphasis>.  The default is 10 seconds.
418
 
          </para>
419
 
        </listitem>
420
 
      </varlistentry>
421
 
 
422
 
      <varlistentry>
423
 
        <term><option>--network-hook-dir=<replaceable
424
 
        >DIR</replaceable></option></term>
425
 
        <listitem>
426
 
          <para>
427
 
            Network hook directory.  The default directory is
428
 
            <quote><filename class="directory"
429
 
            >/lib/mandos/network-hooks.d</filename></quote>.
430
 
          </para>
431
 
        </listitem>
432
 
      </varlistentry>
433
296
      
434
297
      <varlistentry>
435
298
        <term><option>--debug</option></term>
496
359
      <refentrytitle>plugin-runner</refentrytitle>
497
360
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
498
361
      both this program and others in in parallel,
499
 
      <emphasis>one</emphasis> of which (<citerefentry>
500
 
      <refentrytitle>password-prompt</refentrytitle>
501
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
502
 
      passwords on the system console.
 
362
      <emphasis>one</emphasis> of which will prompt for passwords on
 
363
      the system console.
503
364
    </para>
504
365
  </refsect1>
505
366
  
510
371
      server could be found and the password received from it could be
511
372
      successfully decrypted and output on standard output.  The
512
373
      program will exit with a non-zero exit status only if a critical
513
 
      error occurs.  Otherwise, it will forever connect to any
514
 
      discovered <application>Mandos</application> servers, trying to
515
 
      get a decryptable password and print it.
 
374
      error occurs.  Otherwise, it will forever connect to new
 
375
      <application>Mandos</application> servers as they appear, trying
 
376
      to get a decryptable password and print it.
516
377
    </para>
517
378
  </refsect1>
518
379
  
519
380
  <refsect1 id="environment">
520
381
    <title>ENVIRONMENT</title>
521
 
    <variablelist>
522
 
      <varlistentry>
523
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
524
 
        <listitem>
525
 
          <para>
526
 
            This environment variable will be assumed to contain the
527
 
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is
529
 
            purposefully not documented.
530
 
        </para>
531
 
        </listitem>
532
 
      </varlistentry>
533
 
    </variablelist>
534
382
    <para>
535
 
      This program does not use any other environment variables, not
536
 
      even the ones provided by <citerefentry><refentrytitle
 
383
      This program does not use any environment variables, not even
 
384
      the ones provided by <citerefentry><refentrytitle
537
385
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
538
386
    </citerefentry>.
539
387
    </para>
540
388
  </refsect1>
541
389
  
542
 
  <refsect1 id="network-hooks">
543
 
    <title>NETWORK HOOKS</title>
544
 
    <para>
545
 
      If a network interface like a bridge or tunnel is required to
546
 
      find a Mandos server, this requires the interface to be up and
547
 
      running before <command>&COMMANDNAME;</command> starts looking
548
 
      for Mandos servers.  This can be accomplished by creating a
549
 
      <quote>network hook</quote> program, and placing it in a special
550
 
      directory.
551
 
    </para>
552
 
    <para>
553
 
      Before the network is used (and again before program exit), any
554
 
      runnable programs found in the network hook directory are run
555
 
      with the argument <quote><literal>start</literal></quote> or
556
 
      <quote><literal>stop</literal></quote>.  This should bring up or
557
 
      down, respectively, any network interface which
558
 
      <command>&COMMANDNAME;</command> should use.
559
 
    </para>
560
 
    <refsect2 id="hook-requirements">
561
 
      <title>REQUIREMENTS</title>
562
 
      <para>
563
 
        A network hook must be an executable file, and its name must
564
 
        consist entirely of upper and lower case letters, digits,
565
 
        underscores, periods, and hyphens.
566
 
      </para>
567
 
      <para>
568
 
        A network hook will receive one argument, which can be one of
569
 
        the following:
570
 
      </para>
571
 
      <variablelist>
572
 
        <varlistentry>
573
 
          <term><literal>start</literal></term>
574
 
          <listitem>
575
 
            <para>
576
 
              This should make the network hook create (if necessary)
577
 
              and bring up a network interface.
578
 
            </para>
579
 
          </listitem>
580
 
        </varlistentry>
581
 
        <varlistentry>
582
 
          <term><literal>stop</literal></term>
583
 
          <listitem>
584
 
            <para>
585
 
              This should make the network hook take down a network
586
 
              interface, and delete it if it did not exist previously.
587
 
            </para>
588
 
          </listitem>
589
 
        </varlistentry>
590
 
        <varlistentry>
591
 
          <term><literal>files</literal></term>
592
 
          <listitem>
593
 
            <para>
594
 
              This should make the network hook print, <emphasis>one
595
 
              file per line</emphasis>, all the files needed for it to
596
 
              run.  (These files will be copied into the initial RAM
597
 
              filesystem.)  Typical use is for a network hook which is
598
 
              a shell script to print its needed binaries.
599
 
            </para>
600
 
            <para>
601
 
              It is not necessary to print any non-executable files
602
 
              already in the network hook directory, these will be
603
 
              copied implicitly if they otherwise satisfy the name
604
 
              requirements.
605
 
            </para>
606
 
          </listitem>
607
 
        </varlistentry>
608
 
        <varlistentry>
609
 
          <term><literal>modules</literal></term>
610
 
          <listitem>
611
 
            <para>
612
 
              This should make the network hook print, <emphasis>on
613
 
              separate lines</emphasis>, all the kernel modules needed
614
 
              for it to run.  (These modules will be copied into the
615
 
              initial RAM filesystem.)  For instance, a tunnel
616
 
              interface needs the
617
 
              <quote><literal>tun</literal></quote> module.
618
 
            </para>
619
 
          </listitem>
620
 
        </varlistentry>
621
 
      </variablelist>
622
 
      <para>
623
 
        The network hook will be provided with a number of environment
624
 
        variables:
625
 
      </para>
626
 
      <variablelist>
627
 
        <varlistentry>
628
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
629
 
          <listitem>
630
 
            <para>
631
 
              The network hook directory, specified to
632
 
              <command>&COMMANDNAME;</command> by the
633
 
              <option>--network-hook-dir</option> option.  Note: this
634
 
              should <emphasis>always</emphasis> be used by the
635
 
              network hook to refer to itself or any files in the hook
636
 
              directory it may require.
637
 
            </para>
638
 
          </listitem>
639
 
        </varlistentry>
640
 
        <varlistentry>
641
 
          <term><envar>DEVICE</envar></term>
642
 
          <listitem>
643
 
            <para>
644
 
              The network interfaces, as specified to
645
 
              <command>&COMMANDNAME;</command> by the
646
 
              <option>--interface</option> option, combined to one
647
 
              string and separated by commas.  If this is set, and
648
 
              does not contain the interface a hook will bring up,
649
 
              there is no reason for a hook to continue.
650
 
            </para>
651
 
          </listitem>
652
 
        </varlistentry>
653
 
        <varlistentry>
654
 
          <term><envar>MODE</envar></term>
655
 
          <listitem>
656
 
            <para>
657
 
              This will be the same as the first argument;
658
 
              i.e. <quote><literal>start</literal></quote>,
659
 
              <quote><literal>stop</literal></quote>,
660
 
              <quote><literal>files</literal></quote>, or
661
 
              <quote><literal>modules</literal></quote>.
662
 
            </para>
663
 
          </listitem>
664
 
        </varlistentry>
665
 
        <varlistentry>
666
 
          <term><envar>VERBOSITY</envar></term>
667
 
          <listitem>
668
 
            <para>
669
 
              This will be the <quote><literal>1</literal></quote> if
670
 
              the <option>--debug</option> option is passed to
671
 
              <command>&COMMANDNAME;</command>, otherwise
672
 
              <quote><literal>0</literal></quote>.
673
 
            </para>
674
 
          </listitem>
675
 
        </varlistentry>
676
 
        <varlistentry>
677
 
          <term><envar>DELAY</envar></term>
678
 
          <listitem>
679
 
            <para>
680
 
              This will be the same as the <option>--delay</option>
681
 
              option passed to <command>&COMMANDNAME;</command>.  Is
682
 
              only set if <envar>MODE</envar> is
683
 
              <quote><literal>start</literal></quote> or
684
 
              <quote><literal>stop</literal></quote>.
685
 
            </para>
686
 
          </listitem>
687
 
        </varlistentry>
688
 
        <varlistentry>
689
 
          <term><envar>CONNECT</envar></term>
690
 
          <listitem>
691
 
            <para>
692
 
              This will be the same as the <option>--connect</option>
693
 
              option passed to <command>&COMMANDNAME;</command>.  Is
694
 
              only set if <option>--connect</option> is passed and
695
 
              <envar>MODE</envar> is
696
 
              <quote><literal>start</literal></quote> or
697
 
              <quote><literal>stop</literal></quote>.
698
 
            </para>
699
 
          </listitem>
700
 
        </varlistentry>
701
 
      </variablelist>
702
 
      <para>
703
 
        A hook may not read from standard input, and should be
704
 
        restrictive in printing to standard output or standard error
705
 
        unless <varname>VERBOSITY</varname> is
706
 
        <quote><literal>1</literal></quote>.
707
 
      </para>
708
 
    </refsect2>
709
 
  </refsect1>
710
 
  
711
390
  <refsect1 id="files">
712
391
    <title>FILES</title>
713
392
    <variablelist>
725
404
          </para>
726
405
        </listitem>
727
406
      </varlistentry>
728
 
      <varlistentry>
729
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
730
 
        ></term>
731
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
732
 
        ></term>
733
 
        <listitem>
734
 
          <para>
735
 
            Public and private raw key files, in <quote>PEM</quote>
736
 
            format.  These are the default file names, they can be
737
 
            changed with the <option>--tls-pubkey</option> and
738
 
            <option>--tls-privkey</option> options.
739
 
          </para>
740
 
        </listitem>
741
 
      </varlistentry>
742
 
      <varlistentry>
743
 
        <term><filename
744
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
 
        <listitem>
746
 
          <para>
747
 
            Directory where network hooks are located.  Change this
748
 
            with the <option>--network-hook-dir</option> option.  See
749
 
            <xref linkend="network-hooks"/>.
750
 
          </para>
751
 
        </listitem>
752
 
      </varlistentry>
753
407
    </variablelist>
754
408
  </refsect1>
755
409
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
410
<!--   <refsect1 id="bugs"> -->
 
411
<!--     <title>BUGS</title> -->
 
412
<!--     <para> -->
 
413
<!--     </para> -->
 
414
<!--   </refsect1> -->
760
415
  
761
416
  <refsect1 id="example">
762
417
    <title>EXAMPLE</title>
768
423
    </para>
769
424
    <informalexample>
770
425
      <para>
771
 
        Normal invocation needs no options, if the network interfaces
772
 
        can be automatically determined:
 
426
        Normal invocation needs no options, if the network interface
 
427
        is <quote>eth0</quote>:
773
428
      </para>
774
429
      <para>
775
430
        <userinput>&COMMANDNAME;</userinput>
777
432
    </informalexample>
778
433
    <informalexample>
779
434
      <para>
780
 
        Search for Mandos servers (and connect to them) using one
781
 
        specific interface:
 
435
        Search for Mandos servers (and connect to them) using another
 
436
        interface:
782
437
      </para>
783
438
      <para>
784
439
        <!-- do not wrap this line -->
787
442
    </informalexample>
788
443
    <informalexample>
789
444
      <para>
790
 
        Run in debug mode, and use custom keys:
 
445
        Run in debug mode, and use a custom key:
791
446
      </para>
792
447
      <para>
793
448
 
794
449
<!-- do not wrap this line -->
795
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
450
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
451
 
797
452
      </para>
798
453
    </informalexample>
799
454
    <informalexample>
800
455
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
456
        Run in debug mode, with a custom key, and do not use Zeroconf
802
457
        to locate a server; connect directly to the IPv6 link-local
803
458
        address <quote><systemitem class="ipaddress"
804
459
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
462
      <para>
808
463
 
809
464
<!-- do not wrap this line -->
810
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2: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>
811
466
 
812
467
      </para>
813
468
    </informalexample>
837
492
    <para>
838
493
      The only remaining weak point is that someone with physical
839
494
      access to the client hard drive might turn off the client
840
 
      computer, read the OpenPGP and TLS keys directly from the hard
841
 
      drive, and communicate with the server.  To safeguard against
842
 
      this, the server is supposed to notice the client disappearing
843
 
      and stop giving out the encrypted data.  Therefore, it is
844
 
      important to set the timeout and checker interval values tightly
845
 
      on the server.  See <citerefentry><refentrytitle
 
495
      computer, read the OpenPGP keys directly from the hard drive,
 
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
846
501
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
502
    </para>
848
503
    <para>
849
504
      It will also help if the checker program on the server is
850
505
      configured to request something from the client which can not be
851
 
      spoofed by someone else on the network, like SSH server key
852
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
853
 
      echo (<quote>ping</quote>) replies.
 
506
      spoofed by someone else on the network, unlike unencrypted
 
507
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
854
508
    </para>
855
509
    <para>
856
510
      <emphasis>Note</emphasis>: This makes it completely insecure to
864
518
  <refsect1 id="see_also">
865
519
    <title>SEE ALSO</title>
866
520
    <para>
867
 
      <citerefentry><refentrytitle>intro</refentrytitle>
868
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
869
521
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
870
522
      <manvolnum>8</manvolnum></citerefentry>,
871
523
      <citerefentry><refentrytitle>crypttab</refentrytitle>
902
554
      </varlistentry>
903
555
      <varlistentry>
904
556
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
557
          <ulink url="http://www.gnu.org/software/gnutls/"
 
558
          >GnuTLS</ulink>
906
559
        </term>
907
560
      <listitem>
908
561
        <para>
909
562
          GnuTLS is the library this client uses to implement TLS for
910
563
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
564
          send the public OpenPGP key to the server.
912
565
        </para>
913
566
      </listitem>
914
567
      </varlistentry>
915
568
      <varlistentry>
916
569
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
570
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
571
                 >GPGME</ulink>
919
572
        </term>
920
573
        <listitem>
948
601
              <para>
949
602
                This client uses IPv6 link-local addresses, which are
950
603
                immediately usable since a link-local addresses is
951
 
                automatically assigned to a network interface when it
 
604
                automatically assigned to a network interfaces when it
952
605
                is brought up.
953
606
              </para>
954
607
            </listitem>
958
611
      </varlistentry>
959
612
      <varlistentry>
960
613
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
614
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
615
          Protocol Version 1.1</citetitle>
963
616
        </term>
964
617
      <listitem>
965
618
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
619
          TLS 1.1 is the protocol implemented by GnuTLS.
967
620
        </para>
968
621
      </listitem>
969
622
      </varlistentry>
980
633
      </varlistentry>
981
634
      <varlistentry>
982
635
        <term>
983
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
984
 
          Layer Security (TLS) and Datagram Transport Layer Security
985
 
          (DTLS)</citetitle>
986
 
        </term>
987
 
      <listitem>
988
 
        <para>
989
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
990
 
          present, used by this program so that raw public keys can be
991
 
          used.
992
 
        </para>
993
 
      </listitem>
994
 
      </varlistentry>
995
 
      <varlistentry>
996
 
        <term>
997
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
636
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
637
          Security</citetitle>
999
638
        </term>
1000
639
      <listitem>
1001
640
        <para>
1002
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1003
 
          if present, used by this program so that OpenPGP keys can be
1004
 
          used.
 
641
          This is implemented by GnuTLS and used by this program so
 
642
          that OpenPGP keys can be used.
1005
643
        </para>
1006
644
      </listitem>
1007
645
      </varlistentry>