/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

  • Committer: Teddy Hogeborn
  • Date: 2024-09-09 04:24:39 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240909042439-j85mr20uli2hnyis
Eliminate compiler warnings

Many programs use nested functions, which now result in a linker
warning about executable stack.  Hide this warning.  Also, rewrite a
loop in the plymouth plugin to avoid warning about signed overflow.
This change also makes the plugin pick the alphabetically first
process entry instead of the last, in case many plymouth processes are
found (which should be unlikely).

* Makefile (plugin-runner, dracut-module/password-agent,
  plugins.d/password-prompt, plugins.d/mandos-client,
  plugins.d/plymouth): New target; set LDFLAGS to add "-Xlinker
  --no-warn-execstack".
* plugins.d/plymouth.c (get_pid): When no pid files are found, and we
  are looking through the process list, go though it from the start
  instead of from the end, i.e. in normal alphabetical order and not
  in reverse order.

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 "2023-10-21">
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>2010</year>
36
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>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
64
73
        ><replaceable>PORT</replaceable></option></arg>
65
74
      </group>
66
75
      <sbr/>
67
 
      <group>
 
76
      <group rep='repeat'>
68
77
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
72
83
      </group>
73
84
      <sbr/>
74
85
      <group>
85
96
        <replaceable>FILE</replaceable></option></arg>
86
97
      </group>
87
98
      <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/>
88
113
      <arg>
89
114
        <option>--priority <replaceable>STRING</replaceable></option>
90
115
      </arg>
94
119
      </arg>
95
120
      <sbr/>
96
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
97
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
127
      </arg>
99
128
      <sbr/>
137
166
      communicates with <citerefentry><refentrytitle
138
167
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
168
      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
144
 
      confidentiality.  This client program keeps running, trying all
145
 
      servers on the network, until it receives a satisfactory reply
146
 
      or a TERM signal.  After all servers have been tried, all
 
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
147
176
      servers are periodically retried.  If no servers are found it
148
177
      will wait indefinitely for new servers to appear.
149
178
    </para>
150
179
    <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
 
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
157
186
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
187
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
188
      <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).
 
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).
165
192
    </para>
166
193
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
194
      Before network interfaces are selected, all <quote>network
168
195
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
196
    </para>
170
197
    <para>
171
198
      This program is not meant to be run directly; it is really meant
172
 
      to run as a plugin of the <application>Mandos</application>
173
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
174
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
175
 
      initial <acronym>RAM</acronym> disk environment because it is
176
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
177
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
178
 
      </citerefentry> file.
 
199
      to be run by other programs in the initial
 
200
      <acronym>RAM</acronym> disk environment; see <xref
 
201
      linkend="overview"/>.
179
202
    </para>
180
203
  </refsect1>
181
204
  
193
216
    <title>OPTIONS</title>
194
217
    <para>
195
218
      This program is commonly not invoked from the command line; it
196
 
      is normally started by the <application>Mandos</application>
197
 
      plugin runner, see <citerefentry><refentrytitle
198
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
199
 
      </citerefentry>.  Any command line options this program accepts
200
 
      are therefore normally provided by the plugin runner, and not
201
 
      directly.
 
219
      is normally started by another program as described in <xref
 
220
      linkend="description"/>.  Any command line options this program
 
221
      accepts are therefore normally provided by the invoking program,
 
222
      and not directly.
202
223
    </para>
203
224
    
204
225
    <variablelist>
218
239
            assumed to separate the address from the port number.
219
240
          </para>
220
241
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
242
            Normally, Zeroconf would be used to locate Mandos servers,
 
243
            in which case this option would only be used when testing
 
244
            and debugging.
223
245
          </para>
224
246
        </listitem>
225
247
      </varlistentry>
226
248
      
227
249
      <varlistentry>
228
250
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
251
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
252
        >NAME</replaceable></arg></option></term>
230
253
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
254
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
255
        >NAME</replaceable></arg></option></term>
232
256
        <listitem>
233
257
          <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.
 
258
            Comma separated list of network interfaces that will be
 
259
            brought up and scanned for Mandos servers to connect to.
 
260
            The default is the empty string, which will automatically
 
261
            use all appropriate interfaces.
238
262
          </para>
239
263
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
264
            If the <option>--connect</option> option is used, and
 
265
            exactly one interface name is specified (except
 
266
            <quote><literal>none</literal></quote>), this specifies
 
267
            the interface to use to connect to the address given.
243
268
          </para>
244
269
          <para>
245
270
            Note that since this program will normally run in the
246
271
            initial RAM disk environment, the interface must be an
247
272
            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"/>.
 
273
            can normally not be a pseudo-interface such as
 
274
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
275
            will not exist until much later in the boot process, and
 
276
            can not be used by this program, unless created by a
 
277
            <quote>network hook</quote> — see <xref
 
278
            linkend="network-hooks"/>.
253
279
          </para>
254
280
          <para>
255
281
            <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.
 
282
            <quote><literal>none</literal></quote>; this will make
 
283
            <command>&COMMANDNAME;</command> only bring up interfaces
 
284
            specified <emphasis>before</emphasis> this string.  This
 
285
            is not recommended, and only meant for advanced users.
260
286
          </para>
261
287
        </listitem>
262
288
      </varlistentry>
290
316
      </varlistentry>
291
317
      
292
318
      <varlistentry>
 
319
        <term><option>--tls-pubkey=<replaceable
 
320
        >FILE</replaceable></option></term>
 
321
        <term><option>-T
 
322
        <replaceable>FILE</replaceable></option></term>
 
323
        <listitem>
 
324
          <para>
 
325
            TLS raw public key file name.  The default name is
 
326
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
327
            ></quote>.
 
328
          </para>
 
329
        </listitem>
 
330
      </varlistentry>
 
331
 
 
332
      <varlistentry>
 
333
        <term><option>--tls-privkey=<replaceable
 
334
        >FILE</replaceable></option></term>
 
335
        <term><option>-t
 
336
        <replaceable>FILE</replaceable></option></term>
 
337
        <listitem>
 
338
          <para>
 
339
            TLS secret key file name.  The default name is
 
340
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
341
            ></quote>.
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
 
345
 
 
346
      <varlistentry>
293
347
        <term><option>--priority=<replaceable
294
348
        >STRING</replaceable></option></term>
295
349
        <listitem>
304
358
        <listitem>
305
359
          <para>
306
360
            Sets the number of bits to use for the prime number in the
307
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
361
            TLS Diffie-Hellman key exchange.  The default value is
 
362
            selected automatically based on the GnuTLS security
 
363
            profile set in its priority string.  Note that if the
 
364
            <option>--dh-params</option> option is used, the values
 
365
            from that file will be used instead.
 
366
          </para>
 
367
        </listitem>
 
368
      </varlistentry>
 
369
      
 
370
      <varlistentry>
 
371
        <term><option>--dh-params=<replaceable
 
372
        >FILE</replaceable></option></term>
 
373
        <listitem>
 
374
          <para>
 
375
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
376
            needed by the TLS Diffie-Hellman key exchange from.  If
 
377
            this option is not given, or if the file for some reason
 
378
            could not be used, the parameters will be generated on
 
379
            startup, which will take some time and processing power.
 
380
            Those using servers running under time, power or processor
 
381
            constraints may want to generate such a file in advance
 
382
            and use this option.
308
383
          </para>
309
384
        </listitem>
310
385
      </varlistentry>
314
389
        >SECONDS</replaceable></option></term>
315
390
        <listitem>
316
391
          <para>
317
 
            After bringing the network interface up, the program waits
 
392
            After bringing a network interface up, the program waits
318
393
            for the interface to arrive in a <quote>running</quote>
319
394
            state before proceeding.  During this time, the kernel log
320
395
            level will be lowered to reduce clutter on the system
401
476
    <title>OVERVIEW</title>
402
477
    <xi:include href="../overview.xml"/>
403
478
    <para>
404
 
      This program is the client part.  It is a plugin started by
405
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
406
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
407
 
      an initial <acronym>RAM</acronym> disk environment.
 
479
      This program is the client part.  It is run automatically in an
 
480
      initial <acronym>RAM</acronym> disk environment.
 
481
    </para>
 
482
    <para>
 
483
      In an initial <acronym>RAM</acronym> disk environment using
 
484
      <citerefentry><refentrytitle>systemd</refentrytitle>
 
485
      <manvolnum>1</manvolnum></citerefentry>, this program is started
 
486
      by the <application>Mandos</application> <citerefentry>
 
487
      <refentrytitle>password-agent</refentrytitle>
 
488
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
 
489
      started automatically by the <citerefentry>
 
490
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
491
      </citerefentry> <quote>Password Agent</quote> system.
 
492
    </para>
 
493
    <para>
 
494
      In the case of a non-<citerefentry>
 
495
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
496
      </citerefentry> environment, this program is started as a plugin
 
497
      of the <application>Mandos</application> <citerefentry>
 
498
      <refentrytitle>plugin-runner</refentrytitle>
 
499
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
500
      initial <acronym>RAM</acronym> disk environment because it is
 
501
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
502
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
503
      </citerefentry> file.
408
504
    </para>
409
505
    <para>
410
506
      This program could, theoretically, be used as a keyscript in
411
507
      <filename>/etc/crypttab</filename>, but it would then be
412
508
      impossible to enter a password for the encrypted root disk at
413
509
      the console, since this program does not read from the console
414
 
      at all.  This is why a separate plugin runner (<citerefentry>
415
 
      <refentrytitle>plugin-runner</refentrytitle>
416
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
417
 
      both this program and others in in parallel,
418
 
      <emphasis>one</emphasis> of which (<citerefentry>
419
 
      <refentrytitle>password-prompt</refentrytitle>
420
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
421
 
      passwords on the system console.
 
510
      at all.
422
511
    </para>
423
512
  </refsect1>
424
513
  
437
526
  
438
527
  <refsect1 id="environment">
439
528
    <title>ENVIRONMENT</title>
 
529
    <variablelist>
 
530
      <varlistentry>
 
531
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
532
        <listitem>
 
533
          <para>
 
534
            This environment variable will be assumed to contain the
 
535
            directory containing any helper executables.  The use and
 
536
            nature of these helper executables, if any, is purposely
 
537
            not documented.
 
538
        </para>
 
539
        </listitem>
 
540
      </varlistentry>
 
541
    </variablelist>
440
542
    <para>
441
 
      This program does not use any environment variables, not even
442
 
      the ones provided by <citerefentry><refentrytitle
 
543
      This program does not use any other environment variables, not
 
544
      even the ones provided by <citerefentry><refentrytitle
443
545
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
546
    </citerefentry>.
445
547
    </para>
507
609
              It is not necessary to print any non-executable files
508
610
              already in the network hook directory, these will be
509
611
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
612
              requirements.
511
613
            </para>
512
614
          </listitem>
513
615
        </varlistentry>
547
649
          <term><envar>DEVICE</envar></term>
548
650
          <listitem>
549
651
            <para>
550
 
              The network interface, as specified to
 
652
              The network interfaces, as specified to
551
653
              <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.
 
654
              <option>--interface</option> option, combined to one
 
655
              string and separated by commas.  If this is set, and
 
656
              does not contain the interface a hook will bring up,
 
657
              there is no reason for a hook to continue.
555
658
            </para>
556
659
          </listitem>
557
660
        </varlistentry>
583
686
          <listitem>
584
687
            <para>
585
688
              This will be the same as the <option>--delay</option>
586
 
              option passed to <command>&COMMANDNAME;</command>.
 
689
              option passed to <command>&COMMANDNAME;</command>.  Is
 
690
              only set if <envar>MODE</envar> is
 
691
              <quote><literal>start</literal></quote> or
 
692
              <quote><literal>stop</literal></quote>.
 
693
            </para>
 
694
          </listitem>
 
695
        </varlistentry>
 
696
        <varlistentry>
 
697
          <term><envar>CONNECT</envar></term>
 
698
          <listitem>
 
699
            <para>
 
700
              This will be the same as the <option>--connect</option>
 
701
              option passed to <command>&COMMANDNAME;</command>.  Is
 
702
              only set if <option>--connect</option> is passed and
 
703
              <envar>MODE</envar> is
 
704
              <quote><literal>start</literal></quote> or
 
705
              <quote><literal>stop</literal></quote>.
587
706
            </para>
588
707
          </listitem>
589
708
        </varlistentry>
615
734
        </listitem>
616
735
      </varlistentry>
617
736
      <varlistentry>
 
737
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
738
        ></term>
 
739
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
740
        ></term>
 
741
        <listitem>
 
742
          <para>
 
743
            Public and private raw key files, in <quote>PEM</quote>
 
744
            format.  These are the default file names, they can be
 
745
            changed with the <option>--tls-pubkey</option> and
 
746
            <option>--tls-privkey</option> options.
 
747
          </para>
 
748
        </listitem>
 
749
      </varlistentry>
 
750
      <varlistentry>
618
751
        <term><filename
619
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
620
753
        <listitem>
628
761
    </variablelist>
629
762
  </refsect1>
630
763
  
631
 
<!--   <refsect1 id="bugs"> -->
632
 
<!--     <title>BUGS</title> -->
633
 
<!--     <para> -->
634
 
<!--     </para> -->
635
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
636
768
  
637
769
  <refsect1 id="example">
638
770
    <title>EXAMPLE</title>
639
771
    <para>
640
772
      Note that normally, command line options will not be given
641
 
      directly, but via options for the Mandos <citerefentry
642
 
      ><refentrytitle>plugin-runner</refentrytitle>
643
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
644
775
    </para>
645
776
    <informalexample>
646
777
      <para>
647
 
        Normal invocation needs no options, if the network interface
648
 
        is <quote>eth0</quote>:
 
778
        Normal invocation needs no options, if the network interfaces
 
779
        can be automatically determined:
649
780
      </para>
650
781
      <para>
651
782
        <userinput>&COMMANDNAME;</userinput>
653
784
    </informalexample>
654
785
    <informalexample>
655
786
      <para>
656
 
        Search for Mandos servers (and connect to them) using another
657
 
        interface:
 
787
        Search for Mandos servers (and connect to them) using one
 
788
        specific interface:
658
789
      </para>
659
790
      <para>
660
791
        <!-- do not wrap this line -->
663
794
    </informalexample>
664
795
    <informalexample>
665
796
      <para>
666
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
667
798
      </para>
668
799
      <para>
669
800
 
670
801
<!-- do not wrap this line -->
671
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
802
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
672
803
 
673
804
      </para>
674
805
    </informalexample>
675
806
    <informalexample>
676
807
      <para>
677
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
808
        Run in debug mode, with custom keys, and do not use Zeroconf
678
809
        to locate a server; connect directly to the IPv6 link-local
679
810
        address <quote><systemitem class="ipaddress"
680
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
683
814
      <para>
684
815
 
685
816
<!-- do not wrap this line -->
686
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
817
<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>
687
818
 
688
819
      </para>
689
820
    </informalexample>
692
823
  <refsect1 id="security">
693
824
    <title>SECURITY</title>
694
825
    <para>
695
 
      This program is set-uid to root, but will switch back to the
696
 
      original (and presumably non-privileged) user and group after
697
 
      bringing up the network interface.
 
826
      This program assumes that it is set-uid to root, and will switch
 
827
      back to the original (and presumably non-privileged) user and
 
828
      group after bringing up the network interface.
698
829
    </para>
699
830
    <para>
700
831
      To use this program for its intended purpose (see <xref
713
844
    <para>
714
845
      The only remaining weak point is that someone with physical
715
846
      access to the client hard drive might turn off the client
716
 
      computer, read the OpenPGP keys directly from the hard drive,
717
 
      and communicate with the server.  To safeguard against this, the
718
 
      server is supposed to notice the client disappearing and stop
719
 
      giving out the encrypted data.  Therefore, it is important to
720
 
      set the timeout and checker interval values tightly on the
721
 
      server.  See <citerefentry><refentrytitle
 
847
      computer, read the OpenPGP and TLS keys directly from the hard
 
848
      drive, and communicate with the server.  To safeguard against
 
849
      this, the server is supposed to notice the client disappearing
 
850
      and stop giving out the encrypted data.  Therefore, it is
 
851
      important to set the timeout and checker interval values tightly
 
852
      on the server.  See <citerefentry><refentrytitle
722
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
723
854
    </para>
724
855
    <para>
725
856
      It will also help if the checker program on the server is
726
857
      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.
 
858
      spoofed by someone else on the network, like SSH server key
 
859
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
860
      echo (<quote>ping</quote>) replies.
729
861
    </para>
730
862
    <para>
731
863
      <emphasis>Note</emphasis>: This makes it completely insecure to
747
879
      <manvolnum>5</manvolnum></citerefentry>,
748
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
749
881
      <manvolnum>8</manvolnum></citerefentry>,
750
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
751
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
752
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
753
885
      <manvolnum>8mandos</manvolnum></citerefentry>
766
898
      </varlistentry>
767
899
      <varlistentry>
768
900
        <term>
769
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
770
902
        </term>
771
903
      <listitem>
772
904
        <para>
777
909
      </varlistentry>
778
910
      <varlistentry>
779
911
        <term>
780
 
          <ulink url="http://www.gnu.org/software/gnutls/"
781
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
782
913
        </term>
783
914
      <listitem>
784
915
        <para>
785
916
          GnuTLS is the library this client uses to implement TLS for
786
917
          communicating securely with the server, and at the same time
787
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
788
919
        </para>
789
920
      </listitem>
790
921
      </varlistentry>
791
922
      <varlistentry>
792
923
        <term>
793
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
794
925
                 >GPGME</ulink>
795
926
        </term>
796
927
        <listitem>
824
955
              <para>
825
956
                This client uses IPv6 link-local addresses, which are
826
957
                immediately usable since a link-local addresses is
827
 
                automatically assigned to a network interfaces when it
 
958
                automatically assigned to a network interface when it
828
959
                is brought up.
829
960
              </para>
830
961
            </listitem>
834
965
      </varlistentry>
835
966
      <varlistentry>
836
967
        <term>
837
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
838
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
839
970
        </term>
840
971
      <listitem>
841
972
        <para>
842
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
843
974
        </para>
844
975
      </listitem>
845
976
      </varlistentry>
856
987
      </varlistentry>
857
988
      <varlistentry>
858
989
        <term>
859
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
990
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
991
          Layer Security (TLS) and Datagram Transport Layer Security
 
992
          (DTLS)</citetitle>
 
993
        </term>
 
994
      <listitem>
 
995
        <para>
 
996
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
997
          present, used by this program so that raw public keys can be
 
998
          used.
 
999
        </para>
 
1000
      </listitem>
 
1001
      </varlistentry>
 
1002
      <varlistentry>
 
1003
        <term>
 
1004
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
860
1005
          Security</citetitle>
861
1006
        </term>
862
1007
      <listitem>
863
1008
        <para>
864
 
          This is implemented by GnuTLS and used by this program so
865
 
          that OpenPGP keys can be used.
 
1009
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1010
          if present, used by this program so that OpenPGP keys can be
 
1011
          used.
866
1012
        </para>
867
1013
      </listitem>
868
1014
      </varlistentry>