/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

* mandos (ClientDBus.disable): Bug fix: complete rename of "log" and
                               "signal" to "quiet".

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">
6
 
<!ENTITY TIMESTAMP "2008-08-29">
 
5
<!ENTITY TIMESTAMP "2009-09-17">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </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>
 
39
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
67
47
  <refnamediv>
68
48
    <refname><command>&COMMANDNAME;</command></refname>
69
49
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
50
      Gives encrypted passwords to authenticated Mandos clients
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <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>
94
92
    </cmdsynopsis>
95
93
    <cmdsynopsis>
96
94
      <command>&COMMANDNAME;</command>
97
95
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
96
        <arg choice="plain"><option>--help</option></arg>
 
97
        <arg choice="plain"><option>-h</option></arg>
100
98
      </group>
101
99
    </cmdsynopsis>
102
100
    <cmdsynopsis>
103
101
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
102
      <arg choice="plain"><option>--version</option></arg>
105
103
    </cmdsynopsis>
106
104
    <cmdsynopsis>
107
105
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
106
      <arg choice="plain"><option>--check</option></arg>
109
107
    </cmdsynopsis>
110
108
  </refsynopsisdiv>
111
 
 
 
109
  
112
110
  <refsect1 id="description">
113
111
    <title>DESCRIPTION</title>
114
112
    <para>
123
121
      Any authenticated client is then given the stored pre-encrypted
124
122
      password for that specific client.
125
123
    </para>
126
 
 
127
124
  </refsect1>
128
125
  
129
126
  <refsect1 id="purpose">
130
127
    <title>PURPOSE</title>
131
 
 
132
128
    <para>
133
129
      The purpose of this is to enable <emphasis>remote and unattended
134
130
      rebooting</emphasis> of client host computer with an
135
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
132
      linkend="overview"/> for details.
137
133
    </para>
138
 
 
139
134
  </refsect1>
140
135
  
141
136
  <refsect1 id="options">
142
137
    <title>OPTIONS</title>
143
 
 
144
138
    <variablelist>
145
139
      <varlistentry>
 
140
        <term><option>--help</option></term>
146
141
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
142
        <listitem>
149
143
          <para>
150
144
            Show a help message and exit
151
145
          </para>
152
146
        </listitem>
153
147
      </varlistentry>
154
 
 
 
148
      
155
149
      <varlistentry>
 
150
        <term><option>--interface</option>
 
151
        <replaceable>NAME</replaceable></term>
156
152
        <term><option>-i</option>
157
153
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
154
        <listitem>
161
155
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
156
        </listitem>
163
157
      </varlistentry>
164
 
 
 
158
      
165
159
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
160
        <term><option>--address
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <term><option>-a
 
163
        <replaceable>ADDRESS</replaceable></option></term>
168
164
        <listitem>
169
165
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
166
        </listitem>
171
167
      </varlistentry>
172
 
 
 
168
      
173
169
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
170
        <term><option>--port
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <term><option>-p
 
173
        <replaceable>PORT</replaceable></option></term>
176
174
        <listitem>
177
175
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
176
        </listitem>
179
177
      </varlistentry>
180
 
 
 
178
      
181
179
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
180
        <term><option>--check</option></term>
183
181
        <listitem>
184
182
          <para>
185
183
            Run the server’s self-tests.  This includes any unit
187
185
          </para>
188
186
        </listitem>
189
187
      </varlistentry>
190
 
 
 
188
      
191
189
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
190
        <term><option>--debug</option></term>
193
191
        <listitem>
194
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
193
        </listitem>
196
194
      </varlistentry>
197
 
 
 
195
      
198
196
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
197
        <term><option>--priority <replaceable>
 
198
        PRIORITY</replaceable></option></term>
201
199
        <listitem>
202
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
201
        </listitem>
204
202
      </varlistentry>
205
 
 
 
203
      
206
204
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
205
        <term><option>--servicename
 
206
        <replaceable>NAME</replaceable></option></term>
209
207
        <listitem>
210
208
          <xi:include href="mandos-options.xml"
211
209
                      xpointer="servicename"/>
212
210
        </listitem>
213
211
      </varlistentry>
214
 
 
 
212
      
215
213
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
214
        <term><option>--configdir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
218
216
        <listitem>
219
217
          <para>
220
218
            Directory to search for configuration files.  Default is
226
224
          </para>
227
225
        </listitem>
228
226
      </varlistentry>
229
 
 
 
227
      
230
228
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
229
        <term><option>--version</option></term>
232
230
        <listitem>
233
231
          <para>
234
232
            Prints the program version and exit.
235
233
          </para>
236
234
        </listitem>
237
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>
238
253
    </variablelist>
239
254
  </refsect1>
240
 
 
 
255
  
241
256
  <refsect1 id="overview">
242
257
    <title>OVERVIEW</title>
243
258
    <xi:include href="overview.xml"/>
244
259
    <para>
245
260
      This program is the server part.  It is a normal server program
246
261
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
248
263
    </para>
249
264
  </refsect1>
250
 
 
 
265
  
251
266
  <refsect1 id="protocol">
252
267
    <title>NETWORK PROTOCOL</title>
253
268
    <para>
305
320
      </row>
306
321
    </tbody></tgroup></table>
307
322
  </refsect1>
308
 
 
 
323
  
309
324
  <refsect1 id="checking">
310
325
    <title>CHECKING</title>
311
326
    <para>
312
327
      The server will, by default, continually check that the clients
313
328
      are still up.  If a client has not been confirmed as being up
314
329
      for some time, the client is assumed to be compromised and is no
315
 
      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,
316
332
      checker program, and interval between checks can be configured
317
333
      both globally and per client; see <citerefentry>
318
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
 
      <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.
320
338
    </para>
321
339
  </refsect1>
322
 
 
 
340
  
323
341
  <refsect1 id="logging">
324
342
    <title>LOGGING</title>
325
343
    <para>
329
347
      and also show them on the console.
330
348
    </para>
331
349
  </refsect1>
332
 
 
 
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.
 
357
      <!-- XXX -->
 
358
    </para>
 
359
  </refsect1>
 
360
  
333
361
  <refsect1 id="exit_status">
334
362
    <title>EXIT STATUS</title>
335
363
    <para>
337
365
      critical error is encountered.
338
366
    </para>
339
367
  </refsect1>
340
 
 
 
368
  
341
369
  <refsect1 id="environment">
342
370
    <title>ENVIRONMENT</title>
343
371
    <variablelist>
344
372
      <varlistentry>
345
 
        <term><varname>PATH</varname></term>
 
373
        <term><envar>PATH</envar></term>
346
374
        <listitem>
347
375
          <para>
348
376
            To start the configured checker (see <xref
357
385
      </varlistentry>
358
386
    </variablelist>
359
387
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
388
  
 
389
  <refsect1 id="files">
362
390
    <title>FILES</title>
363
391
    <para>
364
392
      Use the <option>--configdir</option> option to change where
387
415
        </listitem>
388
416
      </varlistentry>
389
417
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
418
        <term><filename>/var/run/mandos.pid</filename></term>
391
419
        <listitem>
392
420
          <para>
393
421
            The file containing the process id of
428
456
      Currently, if a client is declared <quote>invalid</quote> due to
429
457
      having timed out, the server does not record this fact onto
430
458
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
 
459
      <xref linkend="clients"/>.
432
460
    </para>
433
461
    <para>
434
462
      There is currently no way of querying the server of the current
442
470
      Debug mode is conflated with running in the foreground.
443
471
    </para>
444
472
    <para>
445
 
      The console log messages does not show a timestamp.
 
473
      The console log messages do not show a time stamp.
 
474
    </para>
 
475
    <para>
 
476
      This server does not check the expire time of clients’ OpenPGP
 
477
      keys.
446
478
    </para>
447
479
  </refsect1>
448
480
  
483
515
      </para>
484
516
    </informalexample>
485
517
  </refsect1>
486
 
 
 
518
  
487
519
  <refsect1 id="security">
488
520
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
521
    <refsect2 id="server">
490
522
      <title>SERVER</title>
491
523
      <para>
492
524
        Running this <command>&COMMANDNAME;</command> server program
493
525
        should not in itself present any security risk to the host
494
 
        computer running it.  The program does not need any special
495
 
        privileges to run, and is designed to run as a non-root user.
 
526
        computer running it.  The program switches to a non-root user
 
527
        soon after startup.
496
528
      </para>
497
529
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
530
    <refsect2 id="clients">
499
531
      <title>CLIENTS</title>
500
532
      <para>
501
533
        The server only gives out its stored data to clients which
508
540
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
541
        <manvolnum>5</manvolnum></citerefentry>)
510
542
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
543
        except the user starting the server (usually root).
512
544
      </para>
513
545
      <para>
514
546
        As detailed in <xref linkend="checking"/>, the status of all
525
557
        restarting servers if it is suspected that a client has, in
526
558
        fact, been compromised by parties who may now be running a
527
559
        fake Mandos client with the keys from the non-encrypted
528
 
        initial RAM image of the client host.  What should be done in
529
 
        that case (if restarting the server program really is
530
 
        necessary) is to stop the server program, edit the
 
560
        initial <acronym>RAM</acronym> image of the client host.  What
 
561
        should be done in that case (if restarting the server program
 
562
        really is necessary) is to stop the server program, edit the
531
563
        configuration file to omit any suspect clients, and restart
532
564
        the server program.
533
565
      </para>
534
566
      <para>
535
567
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
568
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
569
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
570
      </para>
539
571
    </refsect2>
540
572
  </refsect1>
541
 
 
 
573
  
542
574
  <refsect1 id="see_also">
543
575
    <title>SEE ALSO</title>
544
576
    <para>
547
579
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
580
        <refentrytitle>mandos.conf</refentrytitle>
549
581
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
 
582
        <refentrytitle>mandos-client</refentrytitle>
551
583
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
584
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
585
      </citerefentry>