/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2011-03-17 18:28:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110317182822-miiq4c3eaexy0yo4
* plugins.d/askpass-fifo.c (main): Don't print message if FIFO exists.

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 "2011-02-27">
 
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>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
32
38
      <holder>Teddy Hogeborn</holder>
33
39
      <holder>Björn Påhlsson</holder>
34
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
58
42
  </refentryinfo>
59
 
 
 
43
  
60
44
  <refmeta>
61
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
46
    <manvolnum>8</manvolnum>
65
49
  <refnamediv>
66
50
    <refname><command>&COMMANDNAME;</command></refname>
67
51
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
69
53
    </refpurpose>
70
54
  </refnamediv>
71
 
 
 
55
  
72
56
  <refsynopsisdiv>
73
57
    <cmdsynopsis>
74
58
      <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>
 
59
      <group>
 
60
        <arg choice="plain"><option>--interface
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
        <arg choice="plain"><option>-i
 
63
        <replaceable>NAME</replaceable></option></arg>
 
64
      </group>
 
65
      <sbr/>
 
66
      <group>
 
67
        <arg choice="plain"><option>--address
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-a
 
70
        <replaceable>ADDRESS</replaceable></option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--port
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
        <arg choice="plain"><option>-p
 
77
        <replaceable>PORT</replaceable></option></arg>
 
78
      </group>
 
79
      <sbr/>
 
80
      <arg><option>--priority
 
81
      <replaceable>PRIORITY</replaceable></option></arg>
 
82
      <sbr/>
 
83
      <arg><option>--servicename
 
84
      <replaceable>NAME</replaceable></option></arg>
 
85
      <sbr/>
 
86
      <arg><option>--configdir
 
87
      <replaceable>DIRECTORY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
92
97
    </cmdsynopsis>
93
98
    <cmdsynopsis>
94
99
      <command>&COMMANDNAME;</command>
95
100
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
101
        <arg choice="plain"><option>--help</option></arg>
 
102
        <arg choice="plain"><option>-h</option></arg>
98
103
      </group>
99
104
    </cmdsynopsis>
100
105
    <cmdsynopsis>
101
106
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
107
      <arg choice="plain"><option>--version</option></arg>
103
108
    </cmdsynopsis>
104
109
    <cmdsynopsis>
105
110
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
111
      <arg choice="plain"><option>--check</option></arg>
107
112
    </cmdsynopsis>
108
113
  </refsynopsisdiv>
109
 
 
 
114
  
110
115
  <refsect1 id="description">
111
116
    <title>DESCRIPTION</title>
112
117
    <para>
121
126
      Any authenticated client is then given the stored pre-encrypted
122
127
      password for that specific client.
123
128
    </para>
124
 
 
125
129
  </refsect1>
126
130
  
127
131
  <refsect1 id="purpose">
128
132
    <title>PURPOSE</title>
129
 
 
130
133
    <para>
131
134
      The purpose of this is to enable <emphasis>remote and unattended
132
135
      rebooting</emphasis> of client host computer with an
133
136
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
137
      linkend="overview"/> for details.
135
138
    </para>
136
 
 
137
139
  </refsect1>
138
140
  
139
141
  <refsect1 id="options">
140
142
    <title>OPTIONS</title>
141
 
 
142
143
    <variablelist>
143
144
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
145
        <term><option>--help</option></term>
 
146
        <term><option>-h</option></term>
145
147
        <listitem>
146
148
          <para>
147
149
            Show a help message and exit
148
150
          </para>
149
151
        </listitem>
150
152
      </varlistentry>
151
 
 
 
153
      
152
154
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
155
        <term><option>--interface</option>
 
156
        <replaceable>NAME</replaceable></term>
 
157
        <term><option>-i</option>
 
158
        <replaceable>NAME</replaceable></term>
155
159
        <listitem>
156
160
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
161
        </listitem>
158
162
      </varlistentry>
159
 
 
 
163
      
160
164
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
165
        <term><option>--address
 
166
        <replaceable>ADDRESS</replaceable></option></term>
 
167
        <term><option>-a
 
168
        <replaceable>ADDRESS</replaceable></option></term>
163
169
        <listitem>
164
170
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
171
        </listitem>
166
172
      </varlistentry>
167
 
 
 
173
      
168
174
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
175
        <term><option>--port
 
176
        <replaceable>PORT</replaceable></option></term>
 
177
        <term><option>-p
 
178
        <replaceable>PORT</replaceable></option></term>
171
179
        <listitem>
172
180
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
181
        </listitem>
174
182
      </varlistentry>
175
 
 
 
183
      
176
184
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
185
        <term><option>--check</option></term>
178
186
        <listitem>
179
187
          <para>
180
188
            Run the server’s self-tests.  This includes any unit
182
190
          </para>
183
191
        </listitem>
184
192
      </varlistentry>
185
 
 
 
193
      
186
194
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
195
        <term><option>--debug</option></term>
188
196
        <listitem>
189
197
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
198
        </listitem>
191
199
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
200
      
 
201
      <varlistentry>
 
202
        <term><option>--debuglevel
 
203
        <replaceable>LEVEL</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Set the debugging log level.
 
207
            <replaceable>LEVEL</replaceable> is a string, one of
 
208
            <quote><literal>CRITICAL</literal></quote>,
 
209
            <quote><literal>ERROR</literal></quote>,
 
210
            <quote><literal>WARNING</literal></quote>,
 
211
            <quote><literal>INFO</literal></quote>, or
 
212
            <quote><literal>DEBUG</literal></quote>, in order of
 
213
            increasing verbosity.  The default level is
 
214
            <quote><literal>WARNING</literal></quote>.
 
215
          </para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
 
219
      <varlistentry>
 
220
        <term><option>--priority <replaceable>
 
221
        PRIORITY</replaceable></option></term>
196
222
        <listitem>
197
223
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
224
        </listitem>
199
225
      </varlistentry>
200
 
 
 
226
      
201
227
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
228
        <term><option>--servicename
 
229
        <replaceable>NAME</replaceable></option></term>
204
230
        <listitem>
205
231
          <xi:include href="mandos-options.xml"
206
232
                      xpointer="servicename"/>
207
233
        </listitem>
208
234
      </varlistentry>
209
 
 
 
235
      
210
236
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
237
        <term><option>--configdir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
213
239
        <listitem>
214
240
          <para>
215
241
            Directory to search for configuration files.  Default is
221
247
          </para>
222
248
        </listitem>
223
249
      </varlistentry>
224
 
 
 
250
      
225
251
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
227
253
        <listitem>
228
254
          <para>
229
255
            Prints the program version and exit.
230
256
          </para>
231
257
        </listitem>
232
258
      </varlistentry>
 
259
      
 
260
      <varlistentry>
 
261
        <term><option>--no-dbus</option></term>
 
262
        <listitem>
 
263
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
264
          <para>
 
265
            See also <xref linkend="dbus_interface"/>.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>--no-ipv6</option></term>
 
272
        <listitem>
 
273
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
274
        </listitem>
 
275
      </varlistentry>
233
276
    </variablelist>
234
277
  </refsect1>
235
 
 
 
278
  
236
279
  <refsect1 id="overview">
237
280
    <title>OVERVIEW</title>
238
281
    <xi:include href="overview.xml"/>
239
282
    <para>
240
283
      This program is the server part.  It is a normal server program
241
284
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
285
      <acronym>RAM</acronym> disk environment.
243
286
    </para>
244
287
  </refsect1>
245
 
 
 
288
  
246
289
  <refsect1 id="protocol">
247
290
    <title>NETWORK PROTOCOL</title>
248
291
    <para>
300
343
      </row>
301
344
    </tbody></tgroup></table>
302
345
  </refsect1>
303
 
 
 
346
  
304
347
  <refsect1 id="checking">
305
348
    <title>CHECKING</title>
306
349
    <para>
307
350
      The server will, by default, continually check that the clients
308
351
      are still up.  If a client has not been confirmed as being up
309
352
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
 
353
      longer eligible to receive the encrypted password.  (Manual
 
354
      intervention is required to re-enable a client.)  The timeout,
311
355
      checker program, and interval between checks can be configured
312
356
      both globally and per client; see <citerefentry>
313
357
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
316
 
  </refsect1>
317
 
 
 
358
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
359
      receiving its password will also be treated as a successful
 
360
      checker run.
 
361
    </para>
 
362
  </refsect1>
 
363
  
 
364
  <refsect1 id="approval">
 
365
    <title>APPROVAL</title>
 
366
    <para>
 
367
      The server can be configured to require manual approval for a
 
368
      client before it is sent its secret.  The delay to wait for such
 
369
      approval and the default action (approve or deny) can be
 
370
      configured both globally and per client; see <citerefentry>
 
371
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
372
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
373
      will be approved immediately without delay.
 
374
    </para>
 
375
    <para>
 
376
      This can be used to deny a client its secret if not manually
 
377
      approved within a specified time.  It can also be used to make
 
378
      the server delay before giving a client its secret, allowing
 
379
      optional manual denying of this specific client.
 
380
    </para>
 
381
    
 
382
  </refsect1>
 
383
  
318
384
  <refsect1 id="logging">
319
385
    <title>LOGGING</title>
320
386
    <para>
324
390
      and also show them on the console.
325
391
    </para>
326
392
  </refsect1>
327
 
 
 
393
  
 
394
  <refsect1 id="dbus_interface">
 
395
    <title>D-BUS INTERFACE</title>
 
396
    <para>
 
397
      The server will by default provide a D-Bus system bus interface.
 
398
      This interface will only be accessible by the root user or a
 
399
      Mandos-specific user, if such a user exists.  For documentation
 
400
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
401
    </para>
 
402
  </refsect1>
 
403
  
328
404
  <refsect1 id="exit_status">
329
405
    <title>EXIT STATUS</title>
330
406
    <para>
332
408
      critical error is encountered.
333
409
    </para>
334
410
  </refsect1>
335
 
 
 
411
  
336
412
  <refsect1 id="environment">
337
413
    <title>ENVIRONMENT</title>
338
414
    <variablelist>
339
415
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
416
        <term><envar>PATH</envar></term>
341
417
        <listitem>
342
418
          <para>
343
419
            To start the configured checker (see <xref
352
428
      </varlistentry>
353
429
    </variablelist>
354
430
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
431
  
 
432
  <refsect1 id="files">
357
433
    <title>FILES</title>
358
434
    <para>
359
435
      Use the <option>--configdir</option> option to change where
382
458
        </listitem>
383
459
      </varlistentry>
384
460
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
461
        <term><filename>/var/run/mandos.pid</filename></term>
386
462
        <listitem>
387
463
          <para>
388
 
            The file containing the process id of
389
 
            <command>&COMMANDNAME;</command>.
 
464
            The file containing the process id of the
 
465
            <command>&COMMANDNAME;</command> process started last.
390
466
          </para>
391
467
        </listitem>
392
468
      </varlistentry>
420
496
      backtrace.  This could be considered a feature.
421
497
    </para>
422
498
    <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.
 
499
      Currently, if a client is disabled due to having timed out, the
 
500
      server does not record this fact onto permanent storage.  This
 
501
      has some security implications, see <xref linkend="clients"/>.
432
502
    </para>
433
503
    <para>
434
504
      There is no fine-grained control over logging and debug output.
437
507
      Debug mode is conflated with running in the foreground.
438
508
    </para>
439
509
    <para>
440
 
      The console log messages does not show a timestamp.
 
510
      The console log messages do not show a time stamp.
 
511
    </para>
 
512
    <para>
 
513
      This server does not check the expire time of clients’ OpenPGP
 
514
      keys.
441
515
    </para>
442
516
  </refsect1>
443
517
  
478
552
      </para>
479
553
    </informalexample>
480
554
  </refsect1>
481
 
 
 
555
  
482
556
  <refsect1 id="security">
483
557
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
558
    <refsect2 id="server">
485
559
      <title>SERVER</title>
486
560
      <para>
487
561
        Running this <command>&COMMANDNAME;</command> server program
488
562
        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.
 
563
        computer running it.  The program switches to a non-root user
 
564
        soon after startup.
491
565
      </para>
492
566
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
567
    <refsect2 id="clients">
494
568
      <title>CLIENTS</title>
495
569
      <para>
496
570
        The server only gives out its stored data to clients which
503
577
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
578
        <manvolnum>5</manvolnum></citerefentry>)
505
579
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
580
        except the user starting the server (usually root).
507
581
      </para>
508
582
      <para>
509
583
        As detailed in <xref linkend="checking"/>, the status of all
512
586
      </para>
513
587
      <para>
514
588
        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.
 
589
        by the server which would therefore disable the client.  But
 
590
        if the server was ever restarted, it would re-read its client
 
591
        list from its configuration file and again regard all clients
 
592
        therein as enabled, and hence eligible to receive their
 
593
        passwords.  Therefore, be careful when restarting servers if
 
594
        it is suspected that a client has, in fact, been compromised
 
595
        by parties who may now be running a fake Mandos client with
 
596
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
597
        image of the client host.  What should be done in that case
 
598
        (if restarting the server program really is necessary) is to
 
599
        stop the server program, edit the configuration file to omit
 
600
        any suspect clients, and restart the server program.
528
601
      </para>
529
602
      <para>
530
603
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
604
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
605
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
606
      </para>
534
607
    </refsect2>
535
608
  </refsect1>
536
 
 
 
609
  
537
610
  <refsect1 id="see_also">
538
611
    <title>SEE ALSO</title>
539
612
    <para>
540
613
      <citerefentry>
 
614
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
615
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
616
        <refentrytitle>mandos.conf</refentrytitle>
542
617
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
 
618
        <refentrytitle>mandos-client</refentrytitle>
546
619
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
620
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
621
      </citerefentry>
651
724
    </variablelist>
652
725
  </refsect1>
653
726
</refentry>
 
727
<!-- Local Variables: -->
 
728
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
729
<!-- time-stamp-end: "[\"']>" -->
 
730
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
731
<!-- End: -->