To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to plugins.d/mandos-client.xml
- browse files at revision 1304
- compare with another revision
- download diff
- download tarball
- view history from revision 1304
- Committer: Teddy Hogeborn
- Date: 2024-09-16 21:01:52 UTC
- Revision ID: teddy@recompile.se-20240916210152-0xbv4b15jyho9ydk
Override lintian experimental tag "executable-in-usr-lib"
Lintian reports executable files in /usr/lib, since binaries which are
executed internally are supposed to be stored in /usr/libexec. But
the executables we store in /usr/lib are all files to be copied into
the initial RAM disk image, and are never executed from their storage
location in /usr/lib. Except one; the Dracut module-setup.sh file.
But that file seems to be required to be executable; the
module-setup.sh file of every other Dracut module is also an
executable file.
* debian/mandos-client.lintian-overrides: Override experimental tag
"executable-in-usr-lib" about files which are not actually executed
from this location, and only exist to be copied to the initial RAM
disk image. Also the Dracut module-setup.sh file, which merely
follows the pattern of all other Dracut module-setup.sh files from
other Dracut modules.
Lintian reports executable files in /usr/lib, since binaries which are
executed internally are supposed to be stored in /usr/libexec. But
the executables we store in /usr/lib are all files to be copied into
the initial RAM disk image, and are never executed from their storage
location in /usr/lib. Except one; the Dracut module-setup.sh file.
But that file seems to be required to be executable; the
module-setup.sh file of every other Dracut module is also an
executable file.
* debian/mandos-client.lintian-overrides: Override experimental tag
"executable-in-usr-lib" about files which are not actually executed
from this location, and only exist to be copied to the initial RAM
disk image. Also the Dracut module-setup.sh file, which merely
follows the pattern of all other Dracut module-setup.sh files from
other Dracut modules.
- files added:
- DBUS-API
- debian/source
- 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 "2009-01-04">
5
<!ENTITY TIMESTAMP "2023-10-21">
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/>
99
129
<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>
100
139
<option>--debug</option>
101
140
</arg>
102
141
</cmdsynopsis>
126
165
<command>&COMMANDNAME;</command> is a client program that
127
166
communicates with <citerefentry><refentrytitle
128
167
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
to get a password. It uses IPv6 link-local addresses to get
130
network connectivity, Zeroconf to find servers, and TLS with an
131
OpenPGP key to ensure authenticity and confidentiality. It
132
keeps running, trying all servers on the network, until it
133
receives a satisfactory reply or a TERM signal is received.
168
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"/>.
134
196
</para>
135
197
<para>
136
198
This program is not meant to be run directly; it is really meant
137
to run as a plugin of the <application>Mandos</application>
138
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
139
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
140
initial <acronym>RAM</acronym> disk environment because it is
141
specified as a <quote>keyscript</quote> in the <citerefentry>
142
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
143
</citerefentry> file.
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
144
202
</para>
145
203
</refsect1>
146
204
158
216
<title>OPTIONS</title>
159
217
<para>
160
218
This program is commonly not invoked from the command line; it
161
is normally started by the <application>Mandos</application>
162
plugin runner, see <citerefentry><refentrytitle
163
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
164
</citerefentry>. Any command line options this program accepts
165
are therefore normally provided by the plugin runner, and not
166
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.
167
223
</para>
168
224
169
225
<variablelist>
183
239
assumed to separate the address from the port number.
184
240
</para>
185
241
<para>
186
This option is normally only useful for testing and
187
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.
188
245
</para>
189
246
</listitem>
190
247
</varlistentry>
191
248
192
249
<varlistentry>
193
<term><option>--interface=
194
<replaceable>NAME</replaceable></option></term>
250
<term><option>--interface=<replaceable
251
>NAME</replaceable><arg rep='repeat'>,<replaceable
252
>NAME</replaceable></arg></option></term>
195
253
<term><option>-i
196
<replaceable>NAME</replaceable></option></term>
254
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
255
>NAME</replaceable></arg></option></term>
197
256
<listitem>
198
257
<para>
199
Network interface that will be brought up and scanned for
200
Mandos servers to connect to. The default it
201
<quote><literal>eth0</literal></quote>.
202
</para>
203
<para>
204
If the <option>--connect</option> option is used, this
205
specifies the interface to use to connect to the address
206
given.
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.
262
</para>
263
<para>
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.
268
</para>
269
<para>
270
Note that since this program will normally run in the
271
initial RAM disk environment, the interface must be an
272
interface which exists at that stage. Thus, the interface
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"/>.
279
</para>
280
<para>
281
<replaceable>NAME</replaceable> can be the string
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.
207
286
</para>
208
287
</listitem>
209
288
</varlistentry>
237
316
</varlistentry>
238
317
239
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>
240
347
<term><option>--priority=<replaceable
241
348
>STRING</replaceable></option></term>
242
349
<listitem>
251
358
<listitem>
252
359
<para>
253
360
Sets the number of bits to use for the prime number in the
254
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.
255
383
</para>
256
384
</listitem>
257
385
</varlistentry>
261
389
>SECONDS</replaceable></option></term>
262
390
<listitem>
263
391
<para>
264
After bringing the network interface up, the program waits
392
After bringing a network interface up, the program waits
265
393
for the interface to arrive in a <quote>running</quote>
266
394
state before proceeding. During this time, the kernel log
267
395
level will be lowered to reduce clutter on the system
271
399
</para>
272
400
</listitem>
273
401
</varlistentry>
402
403
<varlistentry>
404
<term><option>--retry=<replaceable
405
>SECONDS</replaceable></option></term>
406
<listitem>
407
<para>
408
All Mandos servers are tried repeatedly until a password
409
is received. This value specifies, in seconds, how long
410
between each successive try <emphasis>for the same
411
server</emphasis>. The default is 10 seconds.
412
</para>
413
</listitem>
414
</varlistentry>
415
416
<varlistentry>
417
<term><option>--network-hook-dir=<replaceable
418
>DIR</replaceable></option></term>
419
<listitem>
420
<para>
421
Network hook directory. The default directory is
422
<quote><filename class="directory"
423
>/lib/mandos/network-hooks.d</filename></quote>.
424
</para>
425
</listitem>
426
</varlistentry>
274
427
275
428
<varlistentry>
276
429
<term><option>--debug</option></term>
323
476
<title>OVERVIEW</title>
324
477
<xi:include href="../overview.xml"/>
325
478
<para>
326
This program is the client part. It is a plugin started by
327
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
328
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
329
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.
330
504
</para>
331
505
<para>
332
506
This program could, theoretically, be used as a keyscript in
333
507
<filename>/etc/crypttab</filename>, but it would then be
334
508
impossible to enter a password for the encrypted root disk at
335
509
the console, since this program does not read from the console
336
at all. This is why a separate plugin runner (<citerefentry>
337
<refentrytitle>plugin-runner</refentrytitle>
338
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
339
both this program and others in in parallel,
340
<emphasis>one</emphasis> of which will prompt for passwords on
341
the system console.
510
at all.
342
511
</para>
343
512
</refsect1>
344
513
349
518
server could be found and the password received from it could be
350
519
successfully decrypted and output on standard output. The
351
520
program will exit with a non-zero exit status only if a critical
352
error occurs. Otherwise, it will forever connect to new
353
<application>Mandos</application> servers as they appear, trying
354
to get a decryptable password and print it.
521
error occurs. Otherwise, it will forever connect to any
522
discovered <application>Mandos</application> servers, trying to
523
get a decryptable password and print it.
355
524
</para>
356
525
</refsect1>
357
526
358
527
<refsect1 id="environment">
359
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>
360
542
<para>
361
This program does not use any environment variables, not even
362
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
363
545
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
364
546
</citerefentry>.
365
547
</para>
366
548
</refsect1>
367
549
550
<refsect1 id="network-hooks">
551
<title>NETWORK HOOKS</title>
552
<para>
553
If a network interface like a bridge or tunnel is required to
554
find a Mandos server, this requires the interface to be up and
555
running before <command>&COMMANDNAME;</command> starts looking
556
for Mandos servers. This can be accomplished by creating a
557
<quote>network hook</quote> program, and placing it in a special
558
directory.
559
</para>
560
<para>
561
Before the network is used (and again before program exit), any
562
runnable programs found in the network hook directory are run
563
with the argument <quote><literal>start</literal></quote> or
564
<quote><literal>stop</literal></quote>. This should bring up or
565
down, respectively, any network interface which
566
<command>&COMMANDNAME;</command> should use.
567
</para>
568
<refsect2 id="hook-requirements">
569
<title>REQUIREMENTS</title>
570
<para>
571
A network hook must be an executable file, and its name must
572
consist entirely of upper and lower case letters, digits,
573
underscores, periods, and hyphens.
574
</para>
575
<para>
576
A network hook will receive one argument, which can be one of
577
the following:
578
</para>
579
<variablelist>
580
<varlistentry>
581
<term><literal>start</literal></term>
582
<listitem>
583
<para>
584
This should make the network hook create (if necessary)
585
and bring up a network interface.
586
</para>
587
</listitem>
588
</varlistentry>
589
<varlistentry>
590
<term><literal>stop</literal></term>
591
<listitem>
592
<para>
593
This should make the network hook take down a network
594
interface, and delete it if it did not exist previously.
595
</para>
596
</listitem>
597
</varlistentry>
598
<varlistentry>
599
<term><literal>files</literal></term>
600
<listitem>
601
<para>
602
This should make the network hook print, <emphasis>one
603
file per line</emphasis>, all the files needed for it to
604
run. (These files will be copied into the initial RAM
605
filesystem.) Typical use is for a network hook which is
606
a shell script to print its needed binaries.
607
</para>
608
<para>
609
It is not necessary to print any non-executable files
610
already in the network hook directory, these will be
611
copied implicitly if they otherwise satisfy the name
612
requirements.
613
</para>
614
</listitem>
615
</varlistentry>
616
<varlistentry>
617
<term><literal>modules</literal></term>
618
<listitem>
619
<para>
620
This should make the network hook print, <emphasis>on
621
separate lines</emphasis>, all the kernel modules needed
622
for it to run. (These modules will be copied into the
623
initial RAM filesystem.) For instance, a tunnel
624
interface needs the
625
<quote><literal>tun</literal></quote> module.
626
</para>
627
</listitem>
628
</varlistentry>
629
</variablelist>
630
<para>
631
The network hook will be provided with a number of environment
632
variables:
633
</para>
634
<variablelist>
635
<varlistentry>
636
<term><envar>MANDOSNETHOOKDIR</envar></term>
637
<listitem>
638
<para>
639
The network hook directory, specified to
640
<command>&COMMANDNAME;</command> by the
641
<option>--network-hook-dir</option> option. Note: this
642
should <emphasis>always</emphasis> be used by the
643
network hook to refer to itself or any files in the hook
644
directory it may require.
645
</para>
646
</listitem>
647
</varlistentry>
648
<varlistentry>
649
<term><envar>DEVICE</envar></term>
650
<listitem>
651
<para>
652
The network interfaces, as specified to
653
<command>&COMMANDNAME;</command> by the
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.
658
</para>
659
</listitem>
660
</varlistentry>
661
<varlistentry>
662
<term><envar>MODE</envar></term>
663
<listitem>
664
<para>
665
This will be the same as the first argument;
666
i.e. <quote><literal>start</literal></quote>,
667
<quote><literal>stop</literal></quote>,
668
<quote><literal>files</literal></quote>, or
669
<quote><literal>modules</literal></quote>.
670
</para>
671
</listitem>
672
</varlistentry>
673
<varlistentry>
674
<term><envar>VERBOSITY</envar></term>
675
<listitem>
676
<para>
677
This will be the <quote><literal>1</literal></quote> if
678
the <option>--debug</option> option is passed to
679
<command>&COMMANDNAME;</command>, otherwise
680
<quote><literal>0</literal></quote>.
681
</para>
682
</listitem>
683
</varlistentry>
684
<varlistentry>
685
<term><envar>DELAY</envar></term>
686
<listitem>
687
<para>
688
This will be the same as the <option>--delay</option>
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>.
706
</para>
707
</listitem>
708
</varlistentry>
709
</variablelist>
710
<para>
711
A hook may not read from standard input, and should be
712
restrictive in printing to standard output or standard error
713
unless <varname>VERBOSITY</varname> is
714
<quote><literal>1</literal></quote>.
715
</para>
716
</refsect2>
717
</refsect1>
718
368
719
<refsect1 id="files">
369
720
<title>FILES</title>
370
721
<variablelist>
382
733
</para>
383
734
</listitem>
384
735
</varlistentry>
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>
751
<term><filename
752
class="directory">/lib/mandos/network-hooks.d</filename></term>
753
<listitem>
754
<para>
755
Directory where network hooks are located. Change this
756
with the <option>--network-hook-dir</option> option. See
757
<xref linkend="network-hooks"/>.
758
</para>
759
</listitem>
760
</varlistentry>
385
761
</variablelist>
386
762
</refsect1>
387
763
388
<!-- <refsect1 id="bugs"> -->
389
<!-- <title>BUGS</title> -->
390
<!-- <para> -->
391
<!-- </para> -->
392
<!-- </refsect1> -->
764
<refsect1 id="bugs">
765
<title>BUGS</title>
766
<xi:include href="../bugs.xml"/>
767
</refsect1>
393
768
394
769
<refsect1 id="example">
395
770
<title>EXAMPLE</title>
396
771
<para>
397
772
Note that normally, command line options will not be given
398
directly, but via options for the Mandos <citerefentry
399
><refentrytitle>plugin-runner</refentrytitle>
400
<manvolnum>8mandos</manvolnum></citerefentry>.
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
401
775
</para>
402
776
<informalexample>
403
777
<para>
404
Normal invocation needs no options, if the network interface
405
is <quote>eth0</quote>:
778
Normal invocation needs no options, if the network interfaces
779
can be automatically determined:
406
780
</para>
407
781
<para>
408
782
<userinput>&COMMANDNAME;</userinput>
410
784
</informalexample>
411
785
<informalexample>
412
786
<para>
413
Search for Mandos servers (and connect to them) using another
414
interface:
787
Search for Mandos servers (and connect to them) using one
788
specific interface:
415
789
</para>
416
790
<para>
417
791
<!-- do not wrap this line -->
420
794
</informalexample>
421
795
<informalexample>
422
796
<para>
423
Run in debug mode, and use a custom key:
797
Run in debug mode, and use custom keys:
424
798
</para>
425
799
<para>
426
800
427
801
<!-- do not wrap this line -->
428
<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>
429
803
430
804
</para>
431
805
</informalexample>
432
806
<informalexample>
433
807
<para>
434
Run in debug mode, with a custom key, and do not use Zeroconf
435
to locate a server; connect directly to the IPv6 address
436
<quote><systemitem class="ipaddress"
437
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
438
port 4711, using interface eth2:
808
Run in debug mode, with custom keys, and do not use Zeroconf
809
to locate a server; connect directly to the IPv6 link-local
810
address <quote><systemitem class="ipaddress"
811
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
812
using interface eth2:
439
813
</para>
440
814
<para>
441
815
442
816
<!-- do not wrap this line -->
443
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672: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>
444
818
445
819
</para>
446
820
</informalexample>
449
823
<refsect1 id="security">
450
824
<title>SECURITY</title>
451
825
<para>
452
This program is set-uid to root, but will switch back to the
453
original (and presumably non-privileged) user and group after
454
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.
455
829
</para>
456
830
<para>
457
831
To use this program for its intended purpose (see <xref
470
844
<para>
471
845
The only remaining weak point is that someone with physical
472
846
access to the client hard drive might turn off the client
473
computer, read the OpenPGP keys directly from the hard drive,
474
and communicate with the server. To safeguard against this, the
475
server is supposed to notice the client disappearing and stop
476
giving out the encrypted data. Therefore, it is important to
477
set the timeout and checker interval values tightly on the
478
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
479
853
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
480
854
</para>
481
855
<para>
482
856
It will also help if the checker program on the server is
483
857
configured to request something from the client which can not be
484
spoofed by someone else on the network, unlike unencrypted
485
<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.
486
861
</para>
487
862
<para>
488
863
<emphasis>Note</emphasis>: This makes it completely insecure to
496
871
<refsect1 id="see_also">
497
872
<title>SEE ALSO</title>
498
873
<para>
874
<citerefentry><refentrytitle>intro</refentrytitle>
875
<manvolnum>8mandos</manvolnum></citerefentry>,
499
876
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
500
877
<manvolnum>8</manvolnum></citerefentry>,
501
878
<citerefentry><refentrytitle>crypttab</refentrytitle>
502
879
<manvolnum>5</manvolnum></citerefentry>,
503
880
<citerefentry><refentrytitle>mandos</refentrytitle>
504
881
<manvolnum>8</manvolnum></citerefentry>,
505
<citerefentry><refentrytitle>password-prompt</refentrytitle>
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
506
883
<manvolnum>8mandos</manvolnum></citerefentry>,
507
884
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
508
885
<manvolnum>8mandos</manvolnum></citerefentry>
521
898
</varlistentry>
522
899
<varlistentry>
523
900
<term>
524
<ulink url="http://www.avahi.org/">Avahi</ulink>
901
<ulink url="https://www.avahi.org/">Avahi</ulink>
525
902
</term>
526
903
<listitem>
527
904
<para>
532
909
</varlistentry>
533
910
<varlistentry>
534
911
<term>
535
<ulink url="http://www.gnu.org/software/gnutls/"
536
>GnuTLS</ulink>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
537
913
</term>
538
914
<listitem>
539
915
<para>
540
916
GnuTLS is the library this client uses to implement TLS for
541
917
communicating securely with the server, and at the same time
542
send the public OpenPGP key to the server.
918
send the public key to the server.
543
919
</para>
544
920
</listitem>
545
921
</varlistentry>
546
922
<varlistentry>
547
923
<term>
548
<ulink url="http://www.gnupg.org/related_software/gpgme/"
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
549
925
>GPGME</ulink>
550
926
</term>
551
927
<listitem>
579
955
<para>
580
956
This client uses IPv6 link-local addresses, which are
581
957
immediately usable since a link-local addresses is
582
automatically assigned to a network interfaces when it
958
automatically assigned to a network interface when it
583
959
is brought up.
584
960
</para>
585
961
</listitem>
589
965
</varlistentry>
590
966
<varlistentry>
591
967
<term>
592
RFC 4346: <citetitle>The Transport Layer Security (TLS)
593
Protocol Version 1.1</citetitle>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
594
970
</term>
595
971
<listitem>
596
972
<para>
597
TLS 1.1 is the protocol implemented by GnuTLS.
973
TLS 1.2 is the protocol implemented by GnuTLS.
598
974
</para>
599
975
</listitem>
600
976
</varlistentry>
611
987
</varlistentry>
612
988
<varlistentry>
613
989
<term>
614
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
615
1005
Security</citetitle>
616
1006
</term>
617
1007
<listitem>
618
1008
<para>
619
This is implemented by GnuTLS and used by this program so
620
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.
621
1012
</para>
622
1013
</listitem>
623
1014
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0