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.668
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.668
- Committer: Teddy Hogeborn
- Date: 2019-07-18 00:02:43 UTC
- mto: This revision was merged to the branch mainline in revision 384.
- Revision ID: teddy@recompile.se-20190718000243-okz4s9xao1r1tfnx
Document bug in mandos-keygen which strips white space from passwords
Passwords, as read by mandos-keygen when given the --password or -p
options, are stripped of white space from the start and from the end
of the password. This is because mandos-keygen is a shell script, and
the Bourne Shell "read" builtin does not seem to have a way to avoid
this. Document this bug.
* manods-keygen.xml (OPTIONS): Document the white space-stripping
nature of the --password/-p option, and
also note in the description of
--passfile and -F that they avoid this
behavior.
(BUGS): Again mention the problem with the --password and -p
options, and suggest --passfile as a possible workaround.
Passwords, as read by mandos-keygen when given the --password or -p
options, are stripped of white space from the start and from the end
of the password. This is because mandos-keygen is a shell script, and
the Bourne Shell "read" builtin does not seem to have a way to avoid
this. Document this bug.
* manods-keygen.xml (OPTIONS): Document the white space-stripping
nature of the --password/-p option, and
also note in the description of
--passfile and -F that they avoid this
behavior.
(BUGS): Again mention the problem with the --password and -p
options, and suggest --passfile as a possible workaround.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/tests
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- etc-plugins.d-README
- files modified:
- .bzrignore
added
removed
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-client">
6
<!ENTITY TIMESTAMP "2008-09-06">
5
<!ENTITY TIMESTAMP "2019-02-10">
6
<!ENTITY % common SYSTEM "../common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
16
17
<authorgroup>
17
18
<author>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
20
21
<address>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
22
23
</address>
23
24
</author>
24
25
<author>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
27
28
<address>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
29
30
</address>
30
31
</author>
31
32
</authorgroup>
32
33
<copyright>
33
34
<year>2008</year>
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>
34
46
<holder>Teddy Hogeborn</holder>
35
47
<holder>Björn Påhlsson</holder>
36
48
</copyright>
37
49
<xi:include href="../legalnotice.xml"/>
38
50
</refentryinfo>
39
51
40
52
<refmeta>
41
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
54
<manvolnum>8mandos</manvolnum>
48
60
Client for <application>Mandos</application>
49
61
</refpurpose>
50
62
</refnamediv>
51
63
52
64
<refsynopsisdiv>
53
65
<cmdsynopsis>
54
66
<command>&COMMANDNAME;</command>
61
73
><replaceable>PORT</replaceable></option></arg>
62
74
</group>
63
75
<sbr/>
64
<group>
76
<group rep='repeat'>
65
77
<arg choice="plain"><option>--interface
66
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>-i
68
<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>
69
83
</group>
70
84
<sbr/>
71
85
<group>
82
96
<replaceable>FILE</replaceable></option></arg>
83
97
</group>
84
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/>
85
113
<arg>
86
114
<option>--priority <replaceable>STRING</replaceable></option>
87
115
</arg>
91
119
</arg>
92
120
<sbr/>
93
121
<arg>
122
<option>--dh-params <replaceable>FILE</replaceable></option>
123
</arg>
124
<sbr/>
125
<arg>
126
<option>--delay <replaceable>SECONDS</replaceable></option>
127
</arg>
128
<sbr/>
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>
94
139
<option>--debug</option>
95
140
</arg>
96
141
</cmdsynopsis>
113
158
</group>
114
159
</cmdsynopsis>
115
160
</refsynopsisdiv>
116
161
117
162
<refsect1 id="description">
118
163
<title>DESCRIPTION</title>
119
164
<para>
120
165
<command>&COMMANDNAME;</command> is a client program that
121
166
communicates with <citerefentry><refentrytitle
122
167
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
to get a password. It uses IPv6 link-local addresses to get
124
network connectivity, Zeroconf to find servers, and TLS with an
125
OpenPGP key to ensure authenticity and confidentiality. It
126
keeps running, trying all servers on the network, until it
127
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"/>.
128
196
</para>
129
197
<para>
130
198
This program is not meant to be run directly; it is really meant
177
245
assumed to separate the address from the port number.
178
246
</para>
179
247
<para>
180
This option is normally only useful for testing and
181
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.
182
251
</para>
183
252
</listitem>
184
253
</varlistentry>
185
254
186
255
<varlistentry>
187
<term><option>--interface=
188
<replaceable>NAME</replaceable></option></term>
256
<term><option>--interface=<replaceable
257
>NAME</replaceable><arg rep='repeat'>,<replaceable
258
>NAME</replaceable></arg></option></term>
189
259
<term><option>-i
190
<replaceable>NAME</replaceable></option></term>
260
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
261
>NAME</replaceable></arg></option></term>
191
262
<listitem>
192
263
<para>
193
Network interface that will be brought up and scanned for
194
Mandos servers to connect to. The default it
195
<quote><literal>eth0</literal></quote>.
196
</para>
197
<para>
198
If the <option>--connect</option> option is used, this
199
specifies the interface to use to connect to the address
200
given.
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.
268
</para>
269
<para>
270
If the <option>--connect</option> option is used, and
271
exactly one interface name is specified (except
272
<quote><literal>none</literal></quote>), this specifies
273
the interface to use to connect to the address given.
274
</para>
275
<para>
276
Note that since this program will normally run in the
277
initial RAM disk environment, the interface must be an
278
interface which exists at that stage. Thus, the interface
279
can normally not be a pseudo-interface such as
280
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
281
will not exist until much later in the boot process, and
282
can not be used by this program, unless created by a
283
<quote>network hook</quote> — see <xref
284
linkend="network-hooks"/>.
285
</para>
286
<para>
287
<replaceable>NAME</replaceable> can be the string
288
<quote><literal>none</literal></quote>; this will make
289
<command>&COMMANDNAME;</command> only bring up interfaces
290
specified <emphasis>before</emphasis> this string. This
291
is not recommended, and only meant for advanced users.
201
292
</para>
202
293
</listitem>
203
294
</varlistentry>
215
306
</para>
216
307
</listitem>
217
308
</varlistentry>
218
309
219
310
<varlistentry>
220
311
<term><option>--seckey=<replaceable
221
312
>FILE</replaceable></option></term>
231
322
</varlistentry>
232
323
233
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>
234
353
<term><option>--priority=<replaceable
235
354
>STRING</replaceable></option></term>
236
355
<listitem>
238
357
xpointer="priority"/>
239
358
</listitem>
240
359
</varlistentry>
241
360
242
361
<varlistentry>
243
362
<term><option>--dh-bits=<replaceable
244
363
>BITS</replaceable></option></term>
245
364
<listitem>
246
365
<para>
247
366
Sets the number of bits to use for the prime number in the
248
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.
389
</para>
390
</listitem>
391
</varlistentry>
392
393
<varlistentry>
394
<term><option>--delay=<replaceable
395
>SECONDS</replaceable></option></term>
396
<listitem>
397
<para>
398
After bringing a network interface up, the program waits
399
for the interface to arrive in a <quote>running</quote>
400
state before proceeding. During this time, the kernel log
401
level will be lowered to reduce clutter on the system
402
console, alleviating any other plugins which might be
403
using the system console. This option sets the upper
404
limit of seconds to wait. The default is 2.5 seconds.
405
</para>
406
</listitem>
407
</varlistentry>
408
409
<varlistentry>
410
<term><option>--retry=<replaceable
411
>SECONDS</replaceable></option></term>
412
<listitem>
413
<para>
414
All Mandos servers are tried repeatedly until a password
415
is received. This value specifies, in seconds, how long
416
between each successive try <emphasis>for the same
417
server</emphasis>. The default is 10 seconds.
418
</para>
419
</listitem>
420
</varlistentry>
421
422
<varlistentry>
423
<term><option>--network-hook-dir=<replaceable
424
>DIR</replaceable></option></term>
425
<listitem>
426
<para>
427
Network hook directory. The default directory is
428
<quote><filename class="directory"
429
>/lib/mandos/network-hooks.d</filename></quote>.
249
430
</para>
250
431
</listitem>
251
432
</varlistentry>
284
465
</para>
285
466
</listitem>
286
467
</varlistentry>
287
468
288
469
<varlistentry>
289
470
<term><option>--version</option></term>
290
471
<term><option>-V</option></term>
296
477
</varlistentry>
297
478
</variablelist>
298
479
</refsect1>
299
480
300
481
<refsect1 id="overview">
301
482
<title>OVERVIEW</title>
302
483
<xi:include href="../overview.xml"/>
315
496
<refentrytitle>plugin-runner</refentrytitle>
316
497
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
498
both this program and others in in parallel,
318
<emphasis>one</emphasis> of which will prompt for passwords on
319
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.
320
503
</para>
321
504
</refsect1>
322
505
327
510
server could be found and the password received from it could be
328
511
successfully decrypted and output on standard output. The
329
512
program will exit with a non-zero exit status only if a critical
330
error occurs. Otherwise, it will forever connect to new
331
<application>Mandos</application> servers as they appear, trying
332
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.
333
516
</para>
334
517
</refsect1>
335
518
336
519
<refsect1 id="environment">
337
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>
338
534
<para>
339
This program does not use any environment variables, not even
340
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
341
537
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
342
538
</citerefentry>.
343
539
</para>
344
540
</refsect1>
345
541
346
<refsect1 id="file">
542
<refsect1 id="network-hooks">
543
<title>NETWORK HOOKS</title>
544
<para>
545
If a network interface like a bridge or tunnel is required to
546
find a Mandos server, this requires the interface to be up and
547
running before <command>&COMMANDNAME;</command> starts looking
548
for Mandos servers. This can be accomplished by creating a
549
<quote>network hook</quote> program, and placing it in a special
550
directory.
551
</para>
552
<para>
553
Before the network is used (and again before program exit), any
554
runnable programs found in the network hook directory are run
555
with the argument <quote><literal>start</literal></quote> or
556
<quote><literal>stop</literal></quote>. This should bring up or
557
down, respectively, any network interface which
558
<command>&COMMANDNAME;</command> should use.
559
</para>
560
<refsect2 id="hook-requirements">
561
<title>REQUIREMENTS</title>
562
<para>
563
A network hook must be an executable file, and its name must
564
consist entirely of upper and lower case letters, digits,
565
underscores, periods, and hyphens.
566
</para>
567
<para>
568
A network hook will receive one argument, which can be one of
569
the following:
570
</para>
571
<variablelist>
572
<varlistentry>
573
<term><literal>start</literal></term>
574
<listitem>
575
<para>
576
This should make the network hook create (if necessary)
577
and bring up a network interface.
578
</para>
579
</listitem>
580
</varlistentry>
581
<varlistentry>
582
<term><literal>stop</literal></term>
583
<listitem>
584
<para>
585
This should make the network hook take down a network
586
interface, and delete it if it did not exist previously.
587
</para>
588
</listitem>
589
</varlistentry>
590
<varlistentry>
591
<term><literal>files</literal></term>
592
<listitem>
593
<para>
594
This should make the network hook print, <emphasis>one
595
file per line</emphasis>, all the files needed for it to
596
run. (These files will be copied into the initial RAM
597
filesystem.) Typical use is for a network hook which is
598
a shell script to print its needed binaries.
599
</para>
600
<para>
601
It is not necessary to print any non-executable files
602
already in the network hook directory, these will be
603
copied implicitly if they otherwise satisfy the name
604
requirements.
605
</para>
606
</listitem>
607
</varlistentry>
608
<varlistentry>
609
<term><literal>modules</literal></term>
610
<listitem>
611
<para>
612
This should make the network hook print, <emphasis>on
613
separate lines</emphasis>, all the kernel modules needed
614
for it to run. (These modules will be copied into the
615
initial RAM filesystem.) For instance, a tunnel
616
interface needs the
617
<quote><literal>tun</literal></quote> module.
618
</para>
619
</listitem>
620
</varlistentry>
621
</variablelist>
622
<para>
623
The network hook will be provided with a number of environment
624
variables:
625
</para>
626
<variablelist>
627
<varlistentry>
628
<term><envar>MANDOSNETHOOKDIR</envar></term>
629
<listitem>
630
<para>
631
The network hook directory, specified to
632
<command>&COMMANDNAME;</command> by the
633
<option>--network-hook-dir</option> option. Note: this
634
should <emphasis>always</emphasis> be used by the
635
network hook to refer to itself or any files in the hook
636
directory it may require.
637
</para>
638
</listitem>
639
</varlistentry>
640
<varlistentry>
641
<term><envar>DEVICE</envar></term>
642
<listitem>
643
<para>
644
The network interfaces, as specified to
645
<command>&COMMANDNAME;</command> by the
646
<option>--interface</option> option, combined to one
647
string and separated by commas. If this is set, and
648
does not contain the interface a hook will bring up,
649
there is no reason for a hook to continue.
650
</para>
651
</listitem>
652
</varlistentry>
653
<varlistentry>
654
<term><envar>MODE</envar></term>
655
<listitem>
656
<para>
657
This will be the same as the first argument;
658
i.e. <quote><literal>start</literal></quote>,
659
<quote><literal>stop</literal></quote>,
660
<quote><literal>files</literal></quote>, or
661
<quote><literal>modules</literal></quote>.
662
</para>
663
</listitem>
664
</varlistentry>
665
<varlistentry>
666
<term><envar>VERBOSITY</envar></term>
667
<listitem>
668
<para>
669
This will be the <quote><literal>1</literal></quote> if
670
the <option>--debug</option> option is passed to
671
<command>&COMMANDNAME;</command>, otherwise
672
<quote><literal>0</literal></quote>.
673
</para>
674
</listitem>
675
</varlistentry>
676
<varlistentry>
677
<term><envar>DELAY</envar></term>
678
<listitem>
679
<para>
680
This will be the same as the <option>--delay</option>
681
option passed to <command>&COMMANDNAME;</command>. Is
682
only set if <envar>MODE</envar> is
683
<quote><literal>start</literal></quote> or
684
<quote><literal>stop</literal></quote>.
685
</para>
686
</listitem>
687
</varlistentry>
688
<varlistentry>
689
<term><envar>CONNECT</envar></term>
690
<listitem>
691
<para>
692
This will be the same as the <option>--connect</option>
693
option passed to <command>&COMMANDNAME;</command>. Is
694
only set if <option>--connect</option> is passed and
695
<envar>MODE</envar> is
696
<quote><literal>start</literal></quote> or
697
<quote><literal>stop</literal></quote>.
698
</para>
699
</listitem>
700
</varlistentry>
701
</variablelist>
702
<para>
703
A hook may not read from standard input, and should be
704
restrictive in printing to standard output or standard error
705
unless <varname>VERBOSITY</varname> is
706
<quote><literal>1</literal></quote>.
707
</para>
708
</refsect2>
709
</refsect1>
710
711
<refsect1 id="files">
347
712
<title>FILES</title>
348
713
<variablelist>
349
714
<varlistentry>
360
725
</para>
361
726
</listitem>
362
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>
363
753
</variablelist>
364
754
</refsect1>
365
755
366
<!-- <refsect1 id="bugs"> -->
367
<!-- <title>BUGS</title> -->
368
<!-- <para> -->
369
<!-- </para> -->
370
<!-- </refsect1> -->
371
756
<refsect1 id="bugs">
757
<title>BUGS</title>
758
<xi:include href="../bugs.xml"/>
759
</refsect1>
760
372
761
<refsect1 id="example">
373
762
<title>EXAMPLE</title>
374
763
<para>
379
768
</para>
380
769
<informalexample>
381
770
<para>
382
Normal invocation needs no options, if the network interface
383
is <quote>eth0</quote>:
771
Normal invocation needs no options, if the network interfaces
772
can be automatically determined:
384
773
</para>
385
774
<para>
386
775
<userinput>&COMMANDNAME;</userinput>
388
777
</informalexample>
389
778
<informalexample>
390
779
<para>
391
Search for Mandos servers (and connect to them) using another
392
interface:
780
Search for Mandos servers (and connect to them) using one
781
specific interface:
393
782
</para>
394
783
<para>
395
784
<!-- do not wrap this line -->
398
787
</informalexample>
399
788
<informalexample>
400
789
<para>
401
Run in debug mode, and use a custom key:
790
Run in debug mode, and use custom keys:
402
791
</para>
403
792
<para>
404
793
405
794
<!-- do not wrap this line -->
406
<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>
407
796
408
797
</para>
409
798
</informalexample>
410
799
<informalexample>
411
800
<para>
412
Run in debug mode, with a custom key, and do not use Zeroconf
413
to locate a server; connect directly to the IPv6 address
414
<quote><systemitem class="ipaddress"
415
>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
port 4711, using interface eth2:
801
Run in debug mode, with custom keys, and do not use Zeroconf
802
to locate a server; connect directly to the IPv6 link-local
803
address <quote><systemitem class="ipaddress"
804
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
805
using interface eth2:
417
806
</para>
418
807
<para>
419
808
420
809
<!-- do not wrap this line -->
421
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672: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>
422
811
423
812
</para>
424
813
</informalexample>
425
814
</refsect1>
426
815
427
816
<refsect1 id="security">
428
817
<title>SECURITY</title>
429
818
<para>
448
837
<para>
449
838
The only remaining weak point is that someone with physical
450
839
access to the client hard drive might turn off the client
451
computer, read the OpenPGP keys directly from the hard drive,
452
and communicate with the server. The defense against this is
453
that the server is supposed to notice the client disappearing
454
and will stop giving out the encrypted data. Therefore, it is
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
455
844
important to set the timeout and checker interval values tightly
456
845
on the server. See <citerefentry><refentrytitle
457
846
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
459
848
<para>
460
849
It will also help if the checker program on the server is
461
850
configured to request something from the client which can not be
462
spoofed by someone else on the network, unlike unencrypted
463
<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.
464
854
</para>
465
855
<para>
466
856
<emphasis>Note</emphasis>: This makes it completely insecure to
470
860
confidential.
471
861
</para>
472
862
</refsect1>
473
863
474
864
<refsect1 id="see_also">
475
865
<title>SEE ALSO</title>
476
866
<para>
867
<citerefentry><refentrytitle>intro</refentrytitle>
868
<manvolnum>8mandos</manvolnum></citerefentry>,
477
869
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
478
870
<manvolnum>8</manvolnum></citerefentry>,
479
871
<citerefentry><refentrytitle>crypttab</refentrytitle>
510
902
</varlistentry>
511
903
<varlistentry>
512
904
<term>
513
<ulink url="http://www.gnu.org/software/gnutls/"
514
>GnuTLS</ulink>
905
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
515
906
</term>
516
907
<listitem>
517
908
<para>
518
909
GnuTLS is the library this client uses to implement TLS for
519
910
communicating securely with the server, and at the same time
520
send the public OpenPGP key to the server.
911
send the public key to the server.
521
912
</para>
522
913
</listitem>
523
914
</varlistentry>
524
915
<varlistentry>
525
916
<term>
526
<ulink url="http://www.gnupg.org/related_software/gpgme/"
917
<ulink url="https://www.gnupg.org/related_software/gpgme/"
527
918
>GPGME</ulink>
528
919
</term>
529
920
<listitem>
557
948
<para>
558
949
This client uses IPv6 link-local addresses, which are
559
950
immediately usable since a link-local addresses is
560
automatically assigned to a network interfaces when it
951
automatically assigned to a network interface when it
561
952
is brought up.
562
953
</para>
563
954
</listitem>
567
958
</varlistentry>
568
959
<varlistentry>
569
960
<term>
570
RFC 4346: <citetitle>The Transport Layer Security (TLS)
571
Protocol Version 1.1</citetitle>
961
RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
Protocol Version 1.2</citetitle>
572
963
</term>
573
964
<listitem>
574
965
<para>
575
TLS 1.1 is the protocol implemented by GnuTLS.
966
TLS 1.2 is the protocol implemented by GnuTLS.
576
967
</para>
577
968
</listitem>
578
969
</varlistentry>
589
980
</varlistentry>
590
981
<varlistentry>
591
982
<term>
592
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
593
998
Security</citetitle>
594
999
</term>
595
1000
<listitem>
596
1001
<para>
597
This is implemented by GnuTLS and used by this program so
598
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.
599
1005
</para>
600
1006
</listitem>
601
1007
</varlistentry>
602
1008
</variablelist>
603
1009
</refsect1>
604
605
1010
</refentry>
1011
606
1012
<!-- Local Variables: -->
607
1013
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
1014
<!-- time-stamp-end: "[\"']>" -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0