To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos.xml
- browse files at revision 330
- compare with another revision
- download diff
- download tarball
- view history from revision 330
- Committer: Teddy Hogeborn
- Date: 2015-12-05 01:29:53 UTC
- Revision ID: teddy@recompile.se-20151205012953-oi5hosp5yqhrmudh
Tags: version-1.7.1-2
* debian/changelog (1.7.1-2): New entry.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- plugins.d/usplash
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- files modified:
- .bzrignore
added
removed
mandos.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">
6
<!ENTITY TIMESTAMP "2008-08-30">
5
<!ENTITY TIMESTAMP "2015-07-20">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<refentryinfo>
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
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>
34
42
<holder>Teddy Hogeborn</holder>
35
43
<holder>Björn Påhlsson</holder>
36
44
</copyright>
37
<legalnotice>
38
<para>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
43
later version.
44
</para>
45
46
<para>
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
51
for more details.
52
</para>
53
54
<para>
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
58
</para>
59
</legalnotice>
45
<xi:include href="legalnotice.xml"/>
60
46
</refentryinfo>
61
47
62
48
<refmeta>
63
49
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
50
<manvolnum>8</manvolnum>
70
56
Gives encrypted passwords to authenticated Mandos clients
71
57
</refpurpose>
72
58
</refnamediv>
73
59
74
60
<refsynopsisdiv>
75
61
<cmdsynopsis>
76
62
<command>&COMMANDNAME;</command>
105
91
<replaceable>DIRECTORY</replaceable></option></arg>
106
92
<sbr/>
107
93
<arg><option>--debug</option></arg>
94
<sbr/>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
97
<sbr/>
98
<arg><option>--no-dbus</option></arg>
99
<sbr/>
100
<arg><option>--no-ipv6</option></arg>
101
<sbr/>
102
<arg><option>--no-restore</option></arg>
103
<sbr/>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--foreground</option></arg>
111
<sbr/>
112
<arg><option>--no-zeroconf</option></arg>
108
113
</cmdsynopsis>
109
114
<cmdsynopsis>
110
115
<command>&COMMANDNAME;</command>
111
116
<group choice="req">
117
<arg choice="plain"><option>--help</option></arg>
112
118
<arg choice="plain"><option>-h</option></arg>
113
<arg choice="plain"><option>--help</option></arg>
114
119
</group>
115
120
</cmdsynopsis>
116
121
<cmdsynopsis>
122
127
<arg choice="plain"><option>--check</option></arg>
123
128
</cmdsynopsis>
124
129
</refsynopsisdiv>
125
130
126
131
<refsect1 id="description">
127
132
<title>DESCRIPTION</title>
128
133
<para>
129
134
<command>&COMMANDNAME;</command> is a server daemon which
130
135
handles incoming request for passwords for a pre-defined list of
131
client host computers. The Mandos server uses Zeroconf to
132
announce itself on the local network, and uses TLS to
133
communicate securely with and to authenticate the clients. The
134
Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
link-local addresses, since the clients will probably not have
136
any other addresses configured (see <xref linkend="overview"/>).
137
Any authenticated client is then given the stored pre-encrypted
138
password for that specific client.
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
139
146
</para>
140
141
147
</refsect1>
142
148
143
149
<refsect1 id="purpose">
144
150
<title>PURPOSE</title>
145
146
151
<para>
147
152
The purpose of this is to enable <emphasis>remote and unattended
148
153
rebooting</emphasis> of client host computer with an
149
154
<emphasis>encrypted root file system</emphasis>. See <xref
150
155
linkend="overview"/> for details.
151
156
</para>
152
153
157
</refsect1>
154
158
155
159
<refsect1 id="options">
156
160
<title>OPTIONS</title>
157
158
161
<variablelist>
159
162
<varlistentry>
163
<term><option>--help</option></term>
160
164
<term><option>-h</option></term>
161
<term><option>--help</option></term>
162
165
<listitem>
163
166
<para>
164
167
Show a help message and exit
165
168
</para>
166
169
</listitem>
167
170
</varlistentry>
168
171
169
172
<varlistentry>
173
<term><option>--interface</option>
174
<replaceable>NAME</replaceable></term>
170
175
<term><option>-i</option>
171
176
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
174
177
<listitem>
175
178
<xi:include href="mandos-options.xml" xpointer="interface"/>
176
179
</listitem>
177
180
</varlistentry>
178
181
179
182
<varlistentry>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
183
<term><option>--address
184
<replaceable>ADDRESS</replaceable></option></term>
185
<term><option>-a
186
<replaceable>ADDRESS</replaceable></option></term>
182
187
<listitem>
183
188
<xi:include href="mandos-options.xml" xpointer="address"/>
184
189
</listitem>
185
190
</varlistentry>
186
191
187
192
<varlistentry>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
193
<term><option>--port
194
<replaceable>PORT</replaceable></option></term>
195
<term><option>-p
196
<replaceable>PORT</replaceable></option></term>
190
197
<listitem>
191
198
<xi:include href="mandos-options.xml" xpointer="port"/>
192
199
</listitem>
193
200
</varlistentry>
194
201
195
202
<varlistentry>
196
<term><literal>--check</literal></term>
203
<term><option>--check</option></term>
197
204
<listitem>
198
205
<para>
199
206
Run the server’s self-tests. This includes any unit
201
208
</para>
202
209
</listitem>
203
210
</varlistentry>
204
211
205
212
<varlistentry>
206
<term><literal>--debug</literal></term>
213
<term><option>--debug</option></term>
207
214
<listitem>
208
215
<xi:include href="mandos-options.xml" xpointer="debug"/>
209
216
</listitem>
210
217
</varlistentry>
211
212
<varlistentry>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
218
219
<varlistentry>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
222
<listitem>
223
<para>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
233
</para>
234
</listitem>
235
</varlistentry>
236
237
<varlistentry>
238
<term><option>--priority <replaceable>
239
PRIORITY</replaceable></option></term>
215
240
<listitem>
216
241
<xi:include href="mandos-options.xml" xpointer="priority"/>
217
242
</listitem>
218
243
</varlistentry>
219
244
220
245
<varlistentry>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
222
</literal></term>
246
<term><option>--servicename
247
<replaceable>NAME</replaceable></option></term>
223
248
<listitem>
224
249
<xi:include href="mandos-options.xml"
225
250
xpointer="servicename"/>
226
251
</listitem>
227
252
</varlistentry>
228
253
229
254
<varlistentry>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
231
</literal></term>
255
<term><option>--configdir
256
<replaceable>DIRECTORY</replaceable></option></term>
232
257
<listitem>
233
258
<para>
234
259
Directory to search for configuration files. Default is
240
265
</para>
241
266
</listitem>
242
267
</varlistentry>
243
268
244
269
<varlistentry>
245
<term><literal>--version</literal></term>
270
<term><option>--version</option></term>
246
271
<listitem>
247
272
<para>
248
273
Prints the program version and exit.
249
274
</para>
250
275
</listitem>
251
276
</varlistentry>
277
278
<varlistentry>
279
<term><option>--no-dbus</option></term>
280
<listitem>
281
<xi:include href="mandos-options.xml" xpointer="dbus"/>
282
<para>
283
See also <xref linkend="dbus_interface"/>.
284
</para>
285
</listitem>
286
</varlistentry>
287
288
<varlistentry>
289
<term><option>--no-ipv6</option></term>
290
<listitem>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
</listitem>
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--no-restore</option></term>
297
<listitem>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
<para>
300
See also <xref linkend="persistent_state"/>.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
308
<listitem>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
</listitem>
311
</varlistentry>
312
313
<varlistentry>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
316
<listitem>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
</listitem>
319
</varlistentry>
320
321
<varlistentry>
322
<term><option>--foreground</option></term>
323
<listitem>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>--no-zeroconf</option></term>
331
<listitem>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
</listitem>
334
</varlistentry>
335
252
336
</variablelist>
253
337
</refsect1>
254
338
255
339
<refsect1 id="overview">
256
340
<title>OVERVIEW</title>
257
341
<xi:include href="overview.xml"/>
258
342
<para>
259
343
This program is the server part. It is a normal server program
260
344
and will run in a normal system environment, not in an initial
261
RAM disk environment.
345
<acronym>RAM</acronym> disk environment.
262
346
</para>
263
347
</refsect1>
264
348
265
349
<refsect1 id="protocol">
266
350
<title>NETWORK PROTOCOL</title>
267
351
<para>
319
403
</row>
320
404
</tbody></tgroup></table>
321
405
</refsect1>
322
406
323
407
<refsect1 id="checking">
324
408
<title>CHECKING</title>
325
409
<para>
326
410
The server will, by default, continually check that the clients
327
411
are still up. If a client has not been confirmed as being up
328
412
for some time, the client is assumed to be compromised and is no
329
longer eligible to receive the encrypted password. The timeout,
330
checker program, and interval between checks can be configured
331
both globally and per client; see <citerefentry>
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
<manvolnum>5</manvolnum></citerefentry>.
419
</para>
420
</refsect1>
421
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
424
<para>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
332
429
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
334
</para>
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
432
</para>
433
<para>
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
438
</para>
439
335
440
</refsect1>
336
441
337
442
<refsect1 id="logging">
338
443
<title>LOGGING</title>
339
444
<para>
340
445
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
342
447
<option>--debug</option> option, it will log even more messages,
343
448
and also show them on the console.
344
449
</para>
345
450
</refsect1>
346
451
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
454
<para>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
461
</para>
462
</refsect1>
463
464
<refsect1 id="dbus_interface">
465
<title>D-BUS INTERFACE</title>
466
<para>
467
The server will by default provide a D-Bus system bus interface.
468
This interface will only be accessible by the root user or a
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
</para>
472
</refsect1>
473
347
474
<refsect1 id="exit_status">
348
475
<title>EXIT STATUS</title>
349
476
<para>
351
478
critical error is encountered.
352
479
</para>
353
480
</refsect1>
354
481
355
482
<refsect1 id="environment">
356
483
<title>ENVIRONMENT</title>
357
484
<variablelist>
371
498
</varlistentry>
372
499
</variablelist>
373
500
</refsect1>
374
375
<refsect1 id="file">
501
502
<refsect1 id="files">
376
503
<title>FILES</title>
377
504
<para>
378
505
Use the <option>--configdir</option> option to change where
401
528
</listitem>
402
529
</varlistentry>
403
530
<varlistentry>
404
<term><filename>/var/run/mandos/mandos.pid</filename></term>
405
<listitem>
406
<para>
407
The file containing the process id of
408
<command>&COMMANDNAME;</command>.
531
<term><filename>/run/mandos.pid</filename></term>
532
<listitem>
533
<para>
534
The file containing the process id of the
535
<command>&COMMANDNAME;</command> process started last.
536
<emphasis >Note:</emphasis> If the <filename
537
class="directory">/run</filename> directory does not
538
exist, <filename>/var/run/mandos.pid</filename> will be
539
used instead.
540
</para>
541
</listitem>
542
</varlistentry>
543
<varlistentry>
544
<term><filename class="devicefile">/dev/log</filename></term>
545
</varlistentry>
546
<varlistentry>
547
<term><filename
548
class="directory">/var/lib/mandos</filename></term>
549
<listitem>
550
<para>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
409
554
</para>
410
555
</listitem>
411
556
</varlistentry>
439
584
backtrace. This could be considered a feature.
440
585
</para>
441
586
<para>
442
Currently, if a client is declared <quote>invalid</quote> due to
443
having timed out, the server does not record this fact onto
444
permanent storage. This has some security implications, see
445
<xref linkend="CLIENTS"/>.
446
</para>
447
<para>
448
There is currently no way of querying the server of the current
449
status of clients, other than analyzing its <systemitem
450
class="service">syslog</systemitem> output.
451
</para>
452
<para>
453
587
There is no fine-grained control over logging and debug output.
454
588
</para>
455
589
<para>
456
Debug mode is conflated with running in the foreground.
457
</para>
458
<para>
459
The console log messages does not show a timestamp.
590
This server does not check the expire time of clients’ OpenPGP
591
keys.
460
592
</para>
461
593
</refsect1>
462
594
473
605
<informalexample>
474
606
<para>
475
607
Run the server in debug mode, read configuration files from
476
the <filename>~/mandos</filename> directory, and use the
477
Zeroconf service name <quote>Test</quote> to not collide with
478
any other official Mandos server on this host:
608
the <filename class="directory">~/mandos</filename> directory,
609
and use the Zeroconf service name <quote>Test</quote> to not
610
collide with any other official Mandos server on this host:
479
611
</para>
480
612
<para>
481
613
497
629
</para>
498
630
</informalexample>
499
631
</refsect1>
500
632
501
633
<refsect1 id="security">
502
634
<title>SECURITY</title>
503
<refsect2 id="SERVER">
635
<refsect2 id="server">
504
636
<title>SERVER</title>
505
637
<para>
506
638
Running this <command>&COMMANDNAME;</command> server program
507
639
should not in itself present any security risk to the host
508
computer running it. The program does not need any special
509
privileges to run, and is designed to run as a non-root user.
640
computer running it. The program switches to a non-root user
641
soon after startup.
510
642
</para>
511
643
</refsect2>
512
<refsect2 id="CLIENTS">
644
<refsect2 id="clients">
513
645
<title>CLIENTS</title>
514
646
<para>
515
647
The server only gives out its stored data to clients which
522
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
655
<manvolnum>5</manvolnum></citerefentry>)
524
656
<emphasis>must</emphasis> be made non-readable by anyone
525
except the user running the server.
657
except the user starting the server (usually root).
526
658
</para>
527
659
<para>
528
660
As detailed in <xref linkend="checking"/>, the status of all
530
662
compromised if they are gone for too long.
531
663
</para>
532
664
<para>
533
If a client is compromised, its downtime should be duly noted
534
by the server which would therefore declare the client
535
invalid. But if the server was ever restarted, it would
536
re-read its client list from its configuration file and again
537
regard all clients therein as valid, and hence eligible to
538
receive their passwords. Therefore, be careful when
539
restarting servers if it is suspected that a client has, in
540
fact, been compromised by parties who may now be running a
541
fake Mandos client with the keys from the non-encrypted
542
initial RAM image of the client host. What should be done in
543
that case (if restarting the server program really is
544
necessary) is to stop the server program, edit the
545
configuration file to omit any suspect clients, and restart
546
the server program.
547
</para>
548
<para>
549
665
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
667
<manvolnum>8mandos</manvolnum></citerefentry>.
552
668
</para>
553
669
</refsect2>
554
670
</refsect1>
555
671
556
672
<refsect1 id="see_also">
557
673
<title>SEE ALSO</title>
558
674
<para>
559
<citerefentry>
560
<refentrytitle>mandos-clients.conf</refentrytitle>
561
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
<refentrytitle>mandos.conf</refentrytitle>
563
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
<refentrytitle>password-request</refentrytitle>
565
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
</citerefentry>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>mandos-client</refentrytitle>
682
<manvolnum>8mandos</manvolnum></citerefentry>,
683
<citerefentry><refentrytitle>sh</refentrytitle>
684
<manvolnum>1</manvolnum></citerefentry>
568
685
</para>
569
686
<variablelist>
570
687
<varlistentry>
591
708
</varlistentry>
592
709
<varlistentry>
593
710
<term>
594
<ulink url="http://www.gnu.org/software/gnutls/"
595
>GnuTLS</ulink>
711
<ulink url="http://gnutls.org/">GnuTLS</ulink>
596
712
</term>
597
713
<listitem>
598
714
<para>
636
752
</varlistentry>
637
753
<varlistentry>
638
754
<term>
639
RFC 4346: <citetitle>The Transport Layer Security (TLS)
640
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
641
757
</term>
642
758
<listitem>
643
759
<para>
644
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
645
761
</para>
646
762
</listitem>
647
763
</varlistentry>
657
773
</varlistentry>
658
774
<varlistentry>
659
775
<term>
660
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
661
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
662
778
</term>
663
779
<listitem>
664
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0