/mandos/release

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

* plugins.d/plymouth.c: Break lines, fix whitespace.  Remove
                        unnecessary casts.

  (main) Exit with EX_UNAVAILABLE if plymouth is not found.  Use first
         argument of error() where useful.  Simplify logic of checking
         results of running the ask-for-password command.  Simplify
         assigning value to "plymouthd_argv".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
 
5
<!ENTITY TIMESTAMP "2010-09-11">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
32
36
      <holder>Teddy Hogeborn</holder>
33
37
      <holder>Björn Påhlsson</holder>
34
38
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
39
    <xi:include href="legalnotice.xml"/>
58
40
  </refentryinfo>
59
 
 
 
41
  
60
42
  <refmeta>
61
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
44
    <manvolnum>8</manvolnum>
65
47
  <refnamediv>
66
48
    <refname><command>&COMMANDNAME;</command></refname>
67
49
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
50
      Gives encrypted passwords to authenticated Mandos clients
69
51
    </refpurpose>
70
52
  </refnamediv>
71
 
 
 
53
  
72
54
  <refsynopsisdiv>
73
55
    <cmdsynopsis>
74
56
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
57
      <group>
 
58
        <arg choice="plain"><option>--interface
 
59
        <replaceable>NAME</replaceable></option></arg>
 
60
        <arg choice="plain"><option>-i
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--address
 
66
        <replaceable>ADDRESS</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-a
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
 
72
        <arg choice="plain"><option>--port
 
73
        <replaceable>PORT</replaceable></option></arg>
 
74
        <arg choice="plain"><option>-p
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
      </group>
 
77
      <sbr/>
 
78
      <arg><option>--priority
 
79
      <replaceable>PRIORITY</replaceable></option></arg>
 
80
      <sbr/>
 
81
      <arg><option>--servicename
 
82
      <replaceable>NAME</replaceable></option></arg>
 
83
      <sbr/>
 
84
      <arg><option>--configdir
 
85
      <replaceable>DIRECTORY</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
92
92
    </cmdsynopsis>
93
93
    <cmdsynopsis>
94
94
      <command>&COMMANDNAME;</command>
95
95
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
96
        <arg choice="plain"><option>--help</option></arg>
 
97
        <arg choice="plain"><option>-h</option></arg>
98
98
      </group>
99
99
    </cmdsynopsis>
100
100
    <cmdsynopsis>
101
101
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
102
      <arg choice="plain"><option>--version</option></arg>
103
103
    </cmdsynopsis>
104
104
    <cmdsynopsis>
105
105
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
106
      <arg choice="plain"><option>--check</option></arg>
107
107
    </cmdsynopsis>
108
108
  </refsynopsisdiv>
109
 
 
 
109
  
110
110
  <refsect1 id="description">
111
111
    <title>DESCRIPTION</title>
112
112
    <para>
121
121
      Any authenticated client is then given the stored pre-encrypted
122
122
      password for that specific client.
123
123
    </para>
124
 
 
125
124
  </refsect1>
126
125
  
127
126
  <refsect1 id="purpose">
128
127
    <title>PURPOSE</title>
129
 
 
130
128
    <para>
131
129
      The purpose of this is to enable <emphasis>remote and unattended
132
130
      rebooting</emphasis> of client host computer with an
133
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
132
      linkend="overview"/> for details.
135
133
    </para>
136
 
 
137
134
  </refsect1>
138
135
  
139
136
  <refsect1 id="options">
140
137
    <title>OPTIONS</title>
141
 
 
142
138
    <variablelist>
143
139
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
140
        <term><option>--help</option></term>
 
141
        <term><option>-h</option></term>
145
142
        <listitem>
146
143
          <para>
147
144
            Show a help message and exit
148
145
          </para>
149
146
        </listitem>
150
147
      </varlistentry>
151
 
 
 
148
      
152
149
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
150
        <term><option>--interface</option>
 
151
        <replaceable>NAME</replaceable></term>
 
152
        <term><option>-i</option>
 
153
        <replaceable>NAME</replaceable></term>
155
154
        <listitem>
156
155
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
156
        </listitem>
158
157
      </varlistentry>
159
 
 
 
158
      
160
159
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
160
        <term><option>--address
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <term><option>-a
 
163
        <replaceable>ADDRESS</replaceable></option></term>
163
164
        <listitem>
164
165
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
166
        </listitem>
166
167
      </varlistentry>
167
 
 
 
168
      
168
169
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
170
        <term><option>--port
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <term><option>-p
 
173
        <replaceable>PORT</replaceable></option></term>
171
174
        <listitem>
172
175
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
176
        </listitem>
174
177
      </varlistentry>
175
 
 
 
178
      
176
179
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
180
        <term><option>--check</option></term>
178
181
        <listitem>
179
182
          <para>
180
183
            Run the server’s self-tests.  This includes any unit
182
185
          </para>
183
186
        </listitem>
184
187
      </varlistentry>
185
 
 
 
188
      
186
189
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
190
        <term><option>--debug</option></term>
188
191
        <listitem>
189
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
193
        </listitem>
191
194
      </varlistentry>
192
 
 
 
195
      
193
196
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
197
        <term><option>--priority <replaceable>
 
198
        PRIORITY</replaceable></option></term>
196
199
        <listitem>
197
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
201
        </listitem>
199
202
      </varlistentry>
200
 
 
 
203
      
201
204
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
205
        <term><option>--servicename
 
206
        <replaceable>NAME</replaceable></option></term>
204
207
        <listitem>
205
208
          <xi:include href="mandos-options.xml"
206
209
                      xpointer="servicename"/>
207
210
        </listitem>
208
211
      </varlistentry>
209
 
 
 
212
      
210
213
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
214
        <term><option>--configdir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
213
216
        <listitem>
214
217
          <para>
215
218
            Directory to search for configuration files.  Default is
221
224
          </para>
222
225
        </listitem>
223
226
      </varlistentry>
224
 
 
 
227
      
225
228
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
229
        <term><option>--version</option></term>
227
230
        <listitem>
228
231
          <para>
229
232
            Prints the program version and exit.
230
233
          </para>
231
234
        </listitem>
232
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
233
253
    </variablelist>
234
254
  </refsect1>
235
 
 
 
255
  
236
256
  <refsect1 id="overview">
237
257
    <title>OVERVIEW</title>
238
258
    <xi:include href="overview.xml"/>
239
259
    <para>
240
260
      This program is the server part.  It is a normal server program
241
261
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
243
263
    </para>
244
264
  </refsect1>
245
 
 
 
265
  
246
266
  <refsect1 id="protocol">
247
267
    <title>NETWORK PROTOCOL</title>
248
268
    <para>
300
320
      </row>
301
321
    </tbody></tgroup></table>
302
322
  </refsect1>
303
 
 
 
323
  
304
324
  <refsect1 id="checking">
305
325
    <title>CHECKING</title>
306
326
    <para>
307
327
      The server will, by default, continually check that the clients
308
328
      are still up.  If a client has not been confirmed as being up
309
329
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
311
332
      checker program, and interval between checks can be configured
312
333
      both globally and per client; see <citerefentry>
313
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
315
338
    </para>
316
339
  </refsect1>
317
 
 
 
340
  
318
341
  <refsect1 id="logging">
319
342
    <title>LOGGING</title>
320
343
    <para>
324
347
      and also show them on the console.
325
348
    </para>
326
349
  </refsect1>
327
 
 
 
350
  
 
351
  <refsect1 id="dbus_interface">
 
352
    <title>D-BUS INTERFACE</title>
 
353
    <para>
 
354
      The server will by default provide a D-Bus system bus interface.
 
355
      This interface will only be accessible by the root user or a
 
356
      Mandos-specific user, if such a user exists.  For documentation
 
357
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
358
    </para>
 
359
  </refsect1>
 
360
  
328
361
  <refsect1 id="exit_status">
329
362
    <title>EXIT STATUS</title>
330
363
    <para>
332
365
      critical error is encountered.
333
366
    </para>
334
367
  </refsect1>
335
 
 
 
368
  
336
369
  <refsect1 id="environment">
337
370
    <title>ENVIRONMENT</title>
338
371
    <variablelist>
339
372
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
373
        <term><envar>PATH</envar></term>
341
374
        <listitem>
342
375
          <para>
343
376
            To start the configured checker (see <xref
352
385
      </varlistentry>
353
386
    </variablelist>
354
387
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
357
390
    <title>FILES</title>
358
391
    <para>
359
392
      Use the <option>--configdir</option> option to change where
382
415
        </listitem>
383
416
      </varlistentry>
384
417
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
418
        <term><filename>/var/run/mandos.pid</filename></term>
386
419
        <listitem>
387
420
          <para>
388
421
            The file containing the process id of
420
453
      backtrace.  This could be considered a feature.
421
454
    </para>
422
455
    <para>
423
 
      Currently, if a client is declared <quote>invalid</quote> due to
424
 
      having timed out, the server does not record this fact onto
425
 
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
427
 
    </para>
428
 
    <para>
429
 
      There is currently no way of querying the server of the current
430
 
      status of clients, other than analyzing its <systemitem
431
 
      class="service">syslog</systemitem> output.
 
456
      Currently, if a client is disabled due to having timed out, the
 
457
      server does not record this fact onto permanent storage.  This
 
458
      has some security implications, see <xref linkend="clients"/>.
432
459
    </para>
433
460
    <para>
434
461
      There is no fine-grained control over logging and debug output.
437
464
      Debug mode is conflated with running in the foreground.
438
465
    </para>
439
466
    <para>
440
 
      The console log messages does not show a timestamp.
 
467
      The console log messages do not show a time stamp.
 
468
    </para>
 
469
    <para>
 
470
      This server does not check the expire time of clients’ OpenPGP
 
471
      keys.
441
472
    </para>
442
473
  </refsect1>
443
474
  
448
479
        Normal invocation needs no options:
449
480
      </para>
450
481
      <para>
451
 
        <userinput>mandos</userinput>
 
482
        <userinput>&COMMANDNAME;</userinput>
452
483
      </para>
453
484
    </informalexample>
454
485
    <informalexample>
461
492
      <para>
462
493
 
463
494
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
495
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
496
 
466
497
      </para>
467
498
    </informalexample>
473
504
      <para>
474
505
 
475
506
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
507
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
508
 
478
509
      </para>
479
510
    </informalexample>
480
511
  </refsect1>
481
 
 
 
512
  
482
513
  <refsect1 id="security">
483
514
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
515
    <refsect2 id="server">
485
516
      <title>SERVER</title>
486
517
      <para>
487
518
        Running this <command>&COMMANDNAME;</command> server program
488
519
        should not in itself present any security risk to the host
489
 
        computer running it.  The program does not need any special
490
 
        privileges to run, and is designed to run as a non-root user.
 
520
        computer running it.  The program switches to a non-root user
 
521
        soon after startup.
491
522
      </para>
492
523
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
524
    <refsect2 id="clients">
494
525
      <title>CLIENTS</title>
495
526
      <para>
496
527
        The server only gives out its stored data to clients which
503
534
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
535
        <manvolnum>5</manvolnum></citerefentry>)
505
536
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
537
        except the user starting the server (usually root).
507
538
      </para>
508
539
      <para>
509
540
        As detailed in <xref linkend="checking"/>, the status of all
512
543
      </para>
513
544
      <para>
514
545
        If a client is compromised, its downtime should be duly noted
515
 
        by the server which would therefore declare the client
516
 
        invalid.  But if the server was ever restarted, it would
517
 
        re-read its client list from its configuration file and again
518
 
        regard all clients therein as valid, and hence eligible to
519
 
        receive their passwords.  Therefore, be careful when
520
 
        restarting servers if it is suspected that a client has, in
521
 
        fact, been compromised by parties who may now be running a
522
 
        fake Mandos client with the keys from the non-encrypted
523
 
        initial RAM image of the client host.  What should be done in
524
 
        that case (if restarting the server program really is
525
 
        necessary) is to stop the server program, edit the
526
 
        configuration file to omit any suspect clients, and restart
527
 
        the server program.
 
546
        by the server which would therefore disable the client.  But
 
547
        if the server was ever restarted, it would re-read its client
 
548
        list from its configuration file and again regard all clients
 
549
        therein as enabled, and hence eligible to receive their
 
550
        passwords.  Therefore, be careful when restarting servers if
 
551
        it is suspected that a client has, in fact, been compromised
 
552
        by parties who may now be running a fake Mandos client with
 
553
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
554
        image of the client host.  What should be done in that case
 
555
        (if restarting the server program really is necessary) is to
 
556
        stop the server program, edit the configuration file to omit
 
557
        any suspect clients, and restart the server program.
528
558
      </para>
529
559
      <para>
530
560
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
561
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
562
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
563
      </para>
534
564
    </refsect2>
535
565
  </refsect1>
536
 
 
 
566
  
537
567
  <refsect1 id="see_also">
538
568
    <title>SEE ALSO</title>
539
569
    <para>
540
570
      <citerefentry>
 
571
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
572
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
573
        <refentrytitle>mandos.conf</refentrytitle>
542
574
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
 
575
        <refentrytitle>mandos-client</refentrytitle>
546
576
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
577
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
578
      </citerefentry>
651
681
    </variablelist>
652
682
  </refsect1>
653
683
</refentry>
 
684
<!-- Local Variables: -->
 
685
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
686
<!-- time-stamp-end: "[\"']>" -->
 
687
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
688
<!-- End: -->