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
- browse files at revision 237.7.731
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.731
- Committer: Teddy Hogeborn
- Date: 2019-11-03 18:44:41 UTC
- mto: This revision was merged to the branch mainline in revision 396.
- Revision ID: teddy@recompile.se-20191103184441-1vhjuf06hjqgfohh
mandos-monitor: Use Python's standard loggging module
* mandos-monitor: Use Python's standard loggging module, also for
warnings. Suppress BytesWarning from urwid when
exiting.
(log): New global logger object. This replaces UserInterface
log_message().
(MandosClientWidget.__init__): Remove "logger" argument.
(MandosClientWidget.using_timer): Wrap self.update_timer using new
glib_safely() function.
(glib_safely): New function to log any exceptions instead of letting
exceptions propagate up to GLib.
(UserInterface.__init__): Remove "log_level" argument. Set new
"loghandler" attribute, instance of new
"UILogHandler".
(UserInterface.log_message): Removed.
(UserInterface.log_message_raw): Renamed to "add_log_line"; all
callers changed. Also fix
off-by-one error in max_log_length
logic.
(UserInterface.run): Add self.loghandler to logger "log". Wrap
self.process_input using new glib_safely()
function.
(UserInterface.stop): Remove self.loghandler from logger "log".
(UserInterface.process_input): Make verbosity toggle affect log
level of logger "log".
(UILogHandler): New.
* mandos-monitor: Use Python's standard loggging module, also for
warnings. Suppress BytesWarning from urwid when
exiting.
(log): New global logger object. This replaces UserInterface
log_message().
(MandosClientWidget.__init__): Remove "logger" argument.
(MandosClientWidget.using_timer): Wrap self.update_timer using new
glib_safely() function.
(glib_safely): New function to log any exceptions instead of letting
exceptions propagate up to GLib.
(UserInterface.__init__): Remove "log_level" argument. Set new
"loghandler" attribute, instance of new
"UILogHandler".
(UserInterface.log_message): Removed.
(UserInterface.log_message_raw): Renamed to "add_log_line"; all
callers changed. Also fix
off-by-one error in max_log_length
logic.
(UserInterface.run): Add self.loghandler to logger "log". Wrap
self.process_input using new glib_safely()
function.
(UserInterface.stop): Remove self.loghandler from logger "log".
(UserInterface.process_input): Make verbosity toggle affect log
level of logger "log".
(UILogHandler): New.
- files added:
- bugs.xml
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
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 "2010-09-26">
5
<!ENTITY TIMESTAMP "2019-07-24">
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@fukt.bsnet.se</email>
22
<email>belorn@recompile.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@fukt.bsnet.se</email>
29
<email>teddy@recompile.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>
36
46
<holder>Teddy Hogeborn</holder>
37
47
<holder>Björn Påhlsson</holder>
38
48
</copyright>
63
73
><replaceable>PORT</replaceable></option></arg>
64
74
</group>
65
75
<sbr/>
66
<group>
76
<group rep='repeat'>
67
77
<arg choice="plain"><option>--interface
68
<replaceable>NAME</replaceable></option></arg>
69
<arg choice="plain"><option>-i
70
<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>
71
83
</group>
72
84
<sbr/>
73
85
<group>
84
96
<replaceable>FILE</replaceable></option></arg>
85
97
</group>
86
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/>
87
113
<arg>
88
114
<option>--priority <replaceable>STRING</replaceable></option>
89
115
</arg>
93
119
</arg>
94
120
<sbr/>
95
121
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
96
126
<option>--delay <replaceable>SECONDS</replaceable></option>
97
127
</arg>
98
128
<sbr/>
101
131
</arg>
102
132
<sbr/>
103
133
<arg>
134
<option>--network-hook-dir
135
<replaceable>DIR</replaceable></option>
136
</arg>
137
<sbr/>
138
<arg>
104
139
<option>--debug</option>
105
140
</arg>
106
141
</cmdsynopsis>
131
166
communicates with <citerefentry><refentrytitle
132
167
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
133
168
to get a password. In slightly more detail, this client program
134
brings up a network interface, uses the interface’s IPv6
135
link-local address to get network connectivity, uses Zeroconf to
136
find servers on the local network, and communicates with servers
137
using TLS with an OpenPGP key to ensure authenticity and
138
confidentiality. This client program keeps running, trying all
139
servers on the network, until it receives a satisfactory reply
140
or a TERM signal is received. If no servers are found, or after
141
all servers have been tried, it waits indefinitely for new
142
servers to appear.
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"/>.
143
196
</para>
144
197
<para>
145
198
This program is not meant to be run directly; it is really meant
192
245
assumed to separate the address from the port number.
193
246
</para>
194
247
<para>
195
This option is normally only useful for testing and
196
debugging.
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.
197
251
</para>
198
252
</listitem>
199
253
</varlistentry>
200
254
201
255
<varlistentry>
202
256
<term><option>--interface=<replaceable
203
>NAME</replaceable></option></term>
257
>NAME</replaceable><arg rep='repeat'>,<replaceable
258
>NAME</replaceable></arg></option></term>
204
259
<term><option>-i
205
<replaceable>NAME</replaceable></option></term>
260
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
261
>NAME</replaceable></arg></option></term>
206
262
<listitem>
207
263
<para>
208
Network interface that will be brought up and scanned for
209
Mandos servers to connect to. The default is the empty
210
string, which will automatically choose an appropriate
211
interface.
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.
212
268
</para>
213
269
<para>
214
If the <option>--connect</option> option is used, this
215
specifies the interface to use to connect to the address
216
given.
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.
217
274
</para>
218
275
<para>
219
276
Note that since this program will normally run in the
220
277
initial RAM disk environment, the interface must be an
221
278
interface which exists at that stage. Thus, the interface
222
can not be a pseudo-interface such as <quote>br0</quote>
223
or <quote>tun0</quote>; such interfaces will not exist
224
until much later in the boot process, and can not be used
225
by this program.
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"/>.
226
285
</para>
227
286
<para>
228
287
<replaceable>NAME</replaceable> can be the string
229
<quote><literal>none</literal></quote>; this will not use
230
any specific interface, and will not bring up an interface
231
on startup. This is not recommended, and only meant for
232
advanced users.
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.
233
292
</para>
234
293
</listitem>
235
294
</varlistentry>
263
322
</varlistentry>
264
323
265
324
<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>
266
353
<term><option>--priority=<replaceable
267
354
>STRING</replaceable></option></term>
268
355
<listitem>
277
364
<listitem>
278
365
<para>
279
366
Sets the number of bits to use for the prime number in the
280
TLS Diffie-Hellman key exchange. Default is 1024.
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.
281
389
</para>
282
390
</listitem>
283
391
</varlistentry>
287
395
>SECONDS</replaceable></option></term>
288
396
<listitem>
289
397
<para>
290
After bringing the network interface up, the program waits
398
After bringing a network interface up, the program waits
291
399
for the interface to arrive in a <quote>running</quote>
292
400
state before proceeding. During this time, the kernel log
293
401
level will be lowered to reduce clutter on the system
303
411
>SECONDS</replaceable></option></term>
304
412
<listitem>
305
413
<para>
306
All Mandos servers servers are tried repeatedly until a
307
password is received. This value specifies, in seconds,
308
how long between each successive try <emphasis>for the
309
same server</emphasis>. The default is 10 seconds.
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>.
310
430
</para>
311
431
</listitem>
312
432
</varlistentry>
376
496
<refentrytitle>plugin-runner</refentrytitle>
377
497
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
378
498
both this program and others in in parallel,
379
<emphasis>one</emphasis> of which will prompt for passwords on
380
the system console.
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.
381
503
</para>
382
504
</refsect1>
383
505
388
510
server could be found and the password received from it could be
389
511
successfully decrypted and output on standard output. The
390
512
program will exit with a non-zero exit status only if a critical
391
error occurs. Otherwise, it will forever connect to new
392
<application>Mandos</application> servers as they appear, trying
393
to get a decryptable password and print it.
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.
394
516
</para>
395
517
</refsect1>
396
518
397
519
<refsect1 id="environment">
398
520
<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 purposely
529
not documented.
530
</para>
531
</listitem>
532
</varlistentry>
533
</variablelist>
399
534
<para>
400
This program does not use any environment variables, not even
401
the ones provided by <citerefentry><refentrytitle
535
This program does not use any other environment variables, not
536
even the ones provided by <citerefentry><refentrytitle
402
537
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
403
538
</citerefentry>.
404
539
</para>
405
540
</refsect1>
406
541
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
407
711
<refsect1 id="files">
408
712
<title>FILES</title>
409
713
<variablelist>
421
725
</para>
422
726
</listitem>
423
727
</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>
424
753
</variablelist>
425
754
</refsect1>
426
755
427
<!-- <refsect1 id="bugs"> -->
428
<!-- <title>BUGS</title> -->
429
<!-- <para> -->
430
<!-- </para> -->
431
<!-- </refsect1> -->
756
<refsect1 id="bugs">
757
<title>BUGS</title>
758
<xi:include href="../bugs.xml"/>
759
</refsect1>
432
760
433
761
<refsect1 id="example">
434
762
<title>EXAMPLE</title>
440
768
</para>
441
769
<informalexample>
442
770
<para>
443
Normal invocation needs no options, if the network interface
444
is <quote>eth0</quote>:
771
Normal invocation needs no options, if the network interfaces
772
can be automatically determined:
445
773
</para>
446
774
<para>
447
775
<userinput>&COMMANDNAME;</userinput>
449
777
</informalexample>
450
778
<informalexample>
451
779
<para>
452
Search for Mandos servers (and connect to them) using another
453
interface:
780
Search for Mandos servers (and connect to them) using one
781
specific interface:
454
782
</para>
455
783
<para>
456
784
<!-- do not wrap this line -->
459
787
</informalexample>
460
788
<informalexample>
461
789
<para>
462
Run in debug mode, and use a custom key:
790
Run in debug mode, and use custom keys:
463
791
</para>
464
792
<para>
465
793
466
794
<!-- do not wrap this line -->
467
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
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>
468
796
469
797
</para>
470
798
</informalexample>
471
799
<informalexample>
472
800
<para>
473
Run in debug mode, with a custom key, and do not use Zeroconf
801
Run in debug mode, with custom keys, and do not use Zeroconf
474
802
to locate a server; connect directly to the IPv6 link-local
475
803
address <quote><systemitem class="ipaddress"
476
804
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
479
807
<para>
480
808
481
809
<!-- do not wrap this line -->
482
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
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>
483
811
484
812
</para>
485
813
</informalexample>
488
816
<refsect1 id="security">
489
817
<title>SECURITY</title>
490
818
<para>
491
This program is set-uid to root, but will switch back to the
492
original (and presumably non-privileged) user and group after
493
bringing up the network interface.
819
This program assumes that it is set-uid to root, and will switch
820
back to the original (and presumably non-privileged) user and
821
group after bringing up the network interface.
494
822
</para>
495
823
<para>
496
824
To use this program for its intended purpose (see <xref
509
837
<para>
510
838
The only remaining weak point is that someone with physical
511
839
access to the client hard drive might turn off the client
512
computer, read the OpenPGP keys directly from the hard drive,
513
and communicate with the server. To safeguard against this, the
514
server is supposed to notice the client disappearing and stop
515
giving out the encrypted data. Therefore, it is important to
516
set the timeout and checker interval values tightly on the
517
server. See <citerefentry><refentrytitle
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
518
846
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
519
847
</para>
520
848
<para>
521
849
It will also help if the checker program on the server is
522
850
configured to request something from the client which can not be
523
spoofed by someone else on the network, unlike unencrypted
524
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
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.
525
854
</para>
526
855
<para>
527
856
<emphasis>Note</emphasis>: This makes it completely insecure to
535
864
<refsect1 id="see_also">
536
865
<title>SEE ALSO</title>
537
866
<para>
867
<citerefentry><refentrytitle>intro</refentrytitle>
868
<manvolnum>8mandos</manvolnum></citerefentry>,
538
869
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
539
870
<manvolnum>8</manvolnum></citerefentry>,
540
871
<citerefentry><refentrytitle>crypttab</refentrytitle>
560
891
</varlistentry>
561
892
<varlistentry>
562
893
<term>
563
<ulink url="http://www.avahi.org/">Avahi</ulink>
894
<ulink url="https://www.avahi.org/">Avahi</ulink>
564
895
</term>
565
896
<listitem>
566
897
<para>
571
902
</varlistentry>
572
903
<varlistentry>
573
904
<term>
574
<ulink url="http://www.gnu.org/software/gnutls/"
575
>GnuTLS</ulink>
905
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
576
906
</term>
577
907
<listitem>
578
908
<para>
579
909
GnuTLS is the library this client uses to implement TLS for
580
910
communicating securely with the server, and at the same time
581
send the public OpenPGP key to the server.
911
send the public key to the server.
582
912
</para>
583
913
</listitem>
584
914
</varlistentry>
585
915
<varlistentry>
586
916
<term>
587
<ulink url="http://www.gnupg.org/related_software/gpgme/"
917
<ulink url="https://www.gnupg.org/related_software/gpgme/"
588
918
>GPGME</ulink>
589
919
</term>
590
920
<listitem>
618
948
<para>
619
949
This client uses IPv6 link-local addresses, which are
620
950
immediately usable since a link-local addresses is
621
automatically assigned to a network interfaces when it
951
automatically assigned to a network interface when it
622
952
is brought up.
623
953
</para>
624
954
</listitem>
628
958
</varlistentry>
629
959
<varlistentry>
630
960
<term>
631
RFC 4346: <citetitle>The Transport Layer Security (TLS)
632
Protocol Version 1.1</citetitle>
961
RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
Protocol Version 1.2</citetitle>
633
963
</term>
634
964
<listitem>
635
965
<para>
636
TLS 1.1 is the protocol implemented by GnuTLS.
966
TLS 1.2 is the protocol implemented by GnuTLS.
637
967
</para>
638
968
</listitem>
639
969
</varlistentry>
650
980
</varlistentry>
651
981
<varlistentry>
652
982
<term>
653
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
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
654
998
Security</citetitle>
655
999
</term>
656
1000
<listitem>
657
1001
<para>
658
This is implemented by GnuTLS and used by this program so
659
that OpenPGP keys can be used.
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.
660
1005
</para>
661
1006
</listitem>
662
1007
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0