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 483
- compare with another revision
- download diff
- download tarball
- view history from revision 483
- Committer: Teddy Hogeborn
- Date: 2011-04-03 00:46:51 UTC
- Revision ID: teddy@fukt.bsnet.se-20110403004651-yyrzgwwkoq4ts2vi
* mandos: Never call .Reset() on a defunct Avahi entry group.
(AvahiService.remove): Only do group.Reset(), as before.
(AvahiService.add): Only create new group if necessary.
(AvahiService.cleanup): Also do group.Free() if a group exists.
(AvahiService.server_state_changed): Call .cleanup() on errors.
Also log error parameter, if
passed.
(AvahiService.remove): Only do group.Reset(), as before.
(AvahiService.add): Only create new group if necessary.
(AvahiService.cleanup): Also do group.Free() if a group exists.
(AvahiService.server_state_changed): Call .cleanup() on errors.
Also log error parameter, if
passed.
- files added:
- initramfs-tools-hook-conf
- files removed:
- bugs.xml
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- 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 "2023-10-21">
5
<!ENTITY TIMESTAMP "2010-09-26">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
<firstname>Björn</firstname>
20
20
<surname>Påhlsson</surname>
21
21
<address>
22
<email>belorn@recompile.se</email>
22
<email>belorn@fukt.bsnet.se</email>
23
23
</address>
24
24
</author>
25
25
<author>
26
26
<firstname>Teddy</firstname>
27
27
<surname>Hogeborn</surname>
28
28
<address>
29
<email>teddy@recompile.se</email>
29
<email>teddy@fukt.bsnet.se</email>
30
30
</address>
31
31
</author>
32
32
</authorgroup>
33
33
<copyright>
34
34
<year>2008</year>
35
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
38
<year>2012</year>
39
<year>2013</year>
40
<year>2014</year>
41
<year>2015</year>
42
<year>2016</year>
43
<year>2017</year>
44
<year>2018</year>
45
<year>2019</year>
46
36
<holder>Teddy Hogeborn</holder>
47
37
<holder>Björn Påhlsson</holder>
48
38
</copyright>
73
63
><replaceable>PORT</replaceable></option></arg>
74
64
</group>
75
65
<sbr/>
76
<group rep='repeat'>
66
<group>
77
67
<arg choice="plain"><option>--interface
78
<replaceable>NAME</replaceable><arg rep='repeat'
79
>,<replaceable>NAME</replaceable></arg></option></arg>
80
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
81
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
82
></option></arg>
68
<replaceable>NAME</replaceable></option></arg>
69
<arg choice="plain"><option>-i
70
<replaceable>NAME</replaceable></option></arg>
83
71
</group>
84
72
<sbr/>
85
73
<group>
96
84
<replaceable>FILE</replaceable></option></arg>
97
85
</group>
98
86
<sbr/>
99
<group>
100
<arg choice="plain"><option>--tls-privkey
101
<replaceable>FILE</replaceable></option></arg>
102
<arg choice="plain"><option>-t
103
<replaceable>FILE</replaceable></option></arg>
104
</group>
105
<sbr/>
106
<group>
107
<arg choice="plain"><option>--tls-pubkey
108
<replaceable>FILE</replaceable></option></arg>
109
<arg choice="plain"><option>-T
110
<replaceable>FILE</replaceable></option></arg>
111
</group>
112
<sbr/>
113
87
<arg>
114
88
<option>--priority <replaceable>STRING</replaceable></option>
115
89
</arg>
119
93
</arg>
120
94
<sbr/>
121
95
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
126
96
<option>--delay <replaceable>SECONDS</replaceable></option>
127
97
</arg>
128
98
<sbr/>
129
99
<arg>
130
<option>--retry <replaceable>SECONDS</replaceable></option>
131
</arg>
132
<sbr/>
133
<arg>
134
<option>--network-hook-dir
135
<replaceable>DIR</replaceable></option>
136
</arg>
137
<sbr/>
138
<arg>
139
100
<option>--debug</option>
140
101
</arg>
141
102
</cmdsynopsis>
166
127
communicates with <citerefentry><refentrytitle
167
128
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
168
129
to get a password. In slightly more detail, this client program
169
brings up network interfaces, uses the interfaces’ IPv6
170
link-local addresses to get network connectivity, uses Zeroconf
171
to find servers on the local network, and communicates with
172
servers using TLS with a raw public key to ensure authenticity
173
and confidentiality. This client program keeps running, trying
174
all servers on the network, until it receives a satisfactory
175
reply or a TERM signal. After all servers have been tried, all
176
servers are periodically retried. If no servers are found it
177
will wait indefinitely for new servers to appear.
178
</para>
179
<para>
180
The network interfaces are selected like this: If any interfaces
181
are specified using the <option>--interface</option> option,
182
those interface are used. Otherwise,
183
<command>&COMMANDNAME;</command> will use all interfaces that
184
are not loopback interfaces, are not point-to-point interfaces,
185
are capable of broadcasting and do not have the NOARP flag (see
186
<citerefentry><refentrytitle>netdevice</refentrytitle>
187
<manvolnum>7</manvolnum></citerefentry>). (If the
188
<option>--connect</option> option is used, point-to-point
189
interfaces and non-broadcast interfaces are accepted.) If any
190
used interfaces are not up and running, they are first taken up
191
(and later taken down again on program exit).
192
</para>
193
<para>
194
Before network interfaces are selected, all <quote>network
195
hooks</quote> are run; see <xref linkend="network-hooks"/>.
130
brings up a network interface, uses the interface’s IPv6
131
link-local address to get network connectivity, uses Zeroconf to
132
find servers on the local network, and communicates with servers
133
using TLS with an OpenPGP key to ensure authenticity and
134
confidentiality. This client program keeps running, trying all
135
servers on the network, until it receives a satisfactory reply
136
or a TERM signal is received. If no servers are found, or after
137
all servers have been tried, it waits indefinitely for new
138
servers to appear.
196
139
</para>
197
140
<para>
198
141
This program is not meant to be run directly; it is really meant
199
to be run by other programs in the initial
200
<acronym>RAM</acronym> disk environment; see <xref
201
linkend="overview"/>.
142
to run as a plugin of the <application>Mandos</application>
143
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
144
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
145
initial <acronym>RAM</acronym> disk environment because it is
146
specified as a <quote>keyscript</quote> in the <citerefentry>
147
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
148
</citerefentry> file.
202
149
</para>
203
150
</refsect1>
204
151
216
163
<title>OPTIONS</title>
217
164
<para>
218
165
This program is commonly not invoked from the command line; it
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.
166
is normally started by the <application>Mandos</application>
167
plugin runner, see <citerefentry><refentrytitle
168
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
169
</citerefentry>. Any command line options this program accepts
170
are therefore normally provided by the plugin runner, and not
171
directly.
223
172
</para>
224
173
225
174
<variablelist>
239
188
assumed to separate the address from the port number.
240
189
</para>
241
190
<para>
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.
191
This option is normally only useful for testing and
192
debugging.
245
193
</para>
246
194
</listitem>
247
195
</varlistentry>
248
196
249
197
<varlistentry>
250
198
<term><option>--interface=<replaceable
251
>NAME</replaceable><arg rep='repeat'>,<replaceable
252
>NAME</replaceable></arg></option></term>
199
>NAME</replaceable></option></term>
253
200
<term><option>-i
254
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
255
>NAME</replaceable></arg></option></term>
201
<replaceable>NAME</replaceable></option></term>
256
202
<listitem>
257
203
<para>
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.
204
Network interface that will be brought up and scanned for
205
Mandos servers to connect to. The default is the empty
206
string, which will automatically choose an appropriate
207
interface.
262
208
</para>
263
209
<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.
210
If the <option>--connect</option> option is used, this
211
specifies the interface to use to connect to the address
212
given.
268
213
</para>
269
214
<para>
270
215
Note that since this program will normally run in the
271
216
initial RAM disk environment, the interface must be an
272
217
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"/>.
218
can not be a pseudo-interface such as <quote>br0</quote>
219
or <quote>tun0</quote>; such interfaces will not exist
220
until much later in the boot process, and can not be used
221
by this program.
279
222
</para>
280
223
<para>
281
224
<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.
225
<quote><literal>none</literal></quote>; this will not use
226
any specific interface, and will not bring up an interface
227
on startup. This is not recommended, and only meant for
228
advanced users.
286
229
</para>
287
230
</listitem>
288
231
</varlistentry>
316
259
</varlistentry>
317
260
318
261
<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>
347
262
<term><option>--priority=<replaceable
348
263
>STRING</replaceable></option></term>
349
264
<listitem>
358
273
<listitem>
359
274
<para>
360
275
Sets the number of bits to use for the prime number in the
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.
276
TLS Diffie-Hellman key exchange. Default is 1024.
383
277
</para>
384
278
</listitem>
385
279
</varlistentry>
389
283
>SECONDS</replaceable></option></term>
390
284
<listitem>
391
285
<para>
392
After bringing a network interface up, the program waits
286
After bringing the network interface up, the program waits
393
287
for the interface to arrive in a <quote>running</quote>
394
288
state before proceeding. During this time, the kernel log
395
289
level will be lowered to reduce clutter on the system
399
293
</para>
400
294
</listitem>
401
295
</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>
427
296
428
297
<varlistentry>
429
298
<term><option>--debug</option></term>
476
345
<title>OVERVIEW</title>
477
346
<xi:include href="../overview.xml"/>
478
347
<para>
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.
348
This program is the client part. It is a plugin started by
349
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
350
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
351
an initial <acronym>RAM</acronym> disk environment.
504
352
</para>
505
353
<para>
506
354
This program could, theoretically, be used as a keyscript in
507
355
<filename>/etc/crypttab</filename>, but it would then be
508
356
impossible to enter a password for the encrypted root disk at
509
357
the console, since this program does not read from the console
510
at all.
358
at all. This is why a separate plugin runner (<citerefentry>
359
<refentrytitle>plugin-runner</refentrytitle>
360
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
361
both this program and others in in parallel,
362
<emphasis>one</emphasis> of which will prompt for passwords on
363
the system console.
511
364
</para>
512
365
</refsect1>
513
366
518
371
server could be found and the password received from it could be
519
372
successfully decrypted and output on standard output. The
520
373
program will exit with a non-zero exit status only if a critical
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.
374
error occurs. Otherwise, it will forever connect to new
375
<application>Mandos</application> servers as they appear, trying
376
to get a decryptable password and print it.
524
377
</para>
525
378
</refsect1>
526
379
527
380
<refsect1 id="environment">
528
381
<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>
542
382
<para>
543
This program does not use any other environment variables, not
544
even the ones provided by <citerefentry><refentrytitle
383
This program does not use any environment variables, not even
384
the ones provided by <citerefentry><refentrytitle
545
385
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
546
386
</citerefentry>.
547
387
</para>
548
388
</refsect1>
549
389
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
719
390
<refsect1 id="files">
720
391
<title>FILES</title>
721
392
<variablelist>
733
404
</para>
734
405
</listitem>
735
406
</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>
761
407
</variablelist>
762
408
</refsect1>
763
409
764
<refsect1 id="bugs">
765
<title>BUGS</title>
766
<xi:include href="../bugs.xml"/>
767
</refsect1>
410
<!-- <refsect1 id="bugs"> -->
411
<!-- <title>BUGS</title> -->
412
<!-- <para> -->
413
<!-- </para> -->
414
<!-- </refsect1> -->
768
415
769
416
<refsect1 id="example">
770
417
<title>EXAMPLE</title>
771
418
<para>
772
419
Note that normally, command line options will not be given
773
directly, but passed on via the program responsible for starting
774
this program; see <xref linkend="overview"/>.
420
directly, but via options for the Mandos <citerefentry
421
><refentrytitle>plugin-runner</refentrytitle>
422
<manvolnum>8mandos</manvolnum></citerefentry>.
775
423
</para>
776
424
<informalexample>
777
425
<para>
778
Normal invocation needs no options, if the network interfaces
779
can be automatically determined:
426
Normal invocation needs no options, if the network interface
427
is <quote>eth0</quote>:
780
428
</para>
781
429
<para>
782
430
<userinput>&COMMANDNAME;</userinput>
784
432
</informalexample>
785
433
<informalexample>
786
434
<para>
787
Search for Mandos servers (and connect to them) using one
788
specific interface:
435
Search for Mandos servers (and connect to them) using another
436
interface:
789
437
</para>
790
438
<para>
791
439
<!-- do not wrap this line -->
794
442
</informalexample>
795
443
<informalexample>
796
444
<para>
797
Run in debug mode, and use custom keys:
445
Run in debug mode, and use a custom key:
798
446
</para>
799
447
<para>
800
448
801
449
<!-- do not wrap this line -->
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>
450
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
803
451
804
452
</para>
805
453
</informalexample>
806
454
<informalexample>
807
455
<para>
808
Run in debug mode, with custom keys, and do not use Zeroconf
456
Run in debug mode, with a custom key, and do not use Zeroconf
809
457
to locate a server; connect directly to the IPv6 link-local
810
458
address <quote><systemitem class="ipaddress"
811
459
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
462
<para>
815
463
816
464
<!-- do not wrap this line -->
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>
465
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
818
466
819
467
</para>
820
468
</informalexample>
823
471
<refsect1 id="security">
824
472
<title>SECURITY</title>
825
473
<para>
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.
474
This program is set-uid to root, but will switch back to the
475
original (and presumably non-privileged) user and group after
476
bringing up the network interface.
829
477
</para>
830
478
<para>
831
479
To use this program for its intended purpose (see <xref
844
492
<para>
845
493
The only remaining weak point is that someone with physical
846
494
access to the client hard drive might turn off the client
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
495
computer, read the OpenPGP keys directly from the hard drive,
496
and communicate with the server. To safeguard against this, the
497
server is supposed to notice the client disappearing and stop
498
giving out the encrypted data. Therefore, it is important to
499
set the timeout and checker interval values tightly on the
500
server. See <citerefentry><refentrytitle
853
501
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
502
</para>
855
503
<para>
856
504
It will also help if the checker program on the server is
857
505
configured to request something from the client which can not be
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.
506
spoofed by someone else on the network, unlike unencrypted
507
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
861
508
</para>
862
509
<para>
863
510
<emphasis>Note</emphasis>: This makes it completely insecure to
871
518
<refsect1 id="see_also">
872
519
<title>SEE ALSO</title>
873
520
<para>
874
<citerefentry><refentrytitle>intro</refentrytitle>
875
<manvolnum>8mandos</manvolnum></citerefentry>,
876
521
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
877
522
<manvolnum>8</manvolnum></citerefentry>,
878
523
<citerefentry><refentrytitle>crypttab</refentrytitle>
879
524
<manvolnum>5</manvolnum></citerefentry>,
880
525
<citerefentry><refentrytitle>mandos</refentrytitle>
881
526
<manvolnum>8</manvolnum></citerefentry>,
882
<citerefentry><refentrytitle>password-agent</refentrytitle>
527
<citerefentry><refentrytitle>password-prompt</refentrytitle>
883
528
<manvolnum>8mandos</manvolnum></citerefentry>,
884
529
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
530
<manvolnum>8mandos</manvolnum></citerefentry>
898
543
</varlistentry>
899
544
<varlistentry>
900
545
<term>
901
<ulink url="https://www.avahi.org/">Avahi</ulink>
546
<ulink url="http://www.avahi.org/">Avahi</ulink>
902
547
</term>
903
548
<listitem>
904
549
<para>
909
554
</varlistentry>
910
555
<varlistentry>
911
556
<term>
912
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
557
<ulink url="http://www.gnu.org/software/gnutls/"
558
>GnuTLS</ulink>
913
559
</term>
914
560
<listitem>
915
561
<para>
916
562
GnuTLS is the library this client uses to implement TLS for
917
563
communicating securely with the server, and at the same time
918
send the public key to the server.
564
send the public OpenPGP key to the server.
919
565
</para>
920
566
</listitem>
921
567
</varlistentry>
922
568
<varlistentry>
923
569
<term>
924
<ulink url="https://www.gnupg.org/related_software/gpgme/"
570
<ulink url="http://www.gnupg.org/related_software/gpgme/"
925
571
>GPGME</ulink>
926
572
</term>
927
573
<listitem>
955
601
<para>
956
602
This client uses IPv6 link-local addresses, which are
957
603
immediately usable since a link-local addresses is
958
automatically assigned to a network interface when it
604
automatically assigned to a network interfaces when it
959
605
is brought up.
960
606
</para>
961
607
</listitem>
965
611
</varlistentry>
966
612
<varlistentry>
967
613
<term>
968
RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
Protocol Version 1.2</citetitle>
614
RFC 4346: <citetitle>The Transport Layer Security (TLS)
615
Protocol Version 1.1</citetitle>
970
616
</term>
971
617
<listitem>
972
618
<para>
973
TLS 1.2 is the protocol implemented by GnuTLS.
619
TLS 1.1 is the protocol implemented by GnuTLS.
974
620
</para>
975
621
</listitem>
976
622
</varlistentry>
987
633
</varlistentry>
988
634
<varlistentry>
989
635
<term>
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
636
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
637
Security</citetitle>
1006
638
</term>
1007
639
<listitem>
1008
640
<para>
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.
641
This is implemented by GnuTLS and used by this program so
642
that OpenPGP keys can be used.
1012
643
</para>
1013
644
</listitem>
1014
645
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0