/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
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>
41
60
  </refentryinfo>
42
 
  
 
61
 
43
62
  <refmeta>
44
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
64
    <manvolnum>8</manvolnum>
51
70
      Gives encrypted passwords to authenticated Mandos clients
52
71
    </refpurpose>
53
72
  </refnamediv>
54
 
  
 
73
 
55
74
  <refsynopsisdiv>
56
75
    <cmdsynopsis>
57
76
      <command>&COMMANDNAME;</command>
86
105
      <replaceable>DIRECTORY</replaceable></option></arg>
87
106
      <sbr/>
88
107
      <arg><option>--debug</option></arg>
89
 
      <sbr/>
90
 
      <arg><option>--no-dbus</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--no-ipv6</option></arg>
93
108
    </cmdsynopsis>
94
109
    <cmdsynopsis>
95
110
      <command>&COMMANDNAME;</command>
96
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
97
113
        <arg choice="plain"><option>--help</option></arg>
98
 
        <arg choice="plain"><option>-h</option></arg>
99
114
      </group>
100
115
    </cmdsynopsis>
101
116
    <cmdsynopsis>
107
122
      <arg choice="plain"><option>--check</option></arg>
108
123
    </cmdsynopsis>
109
124
  </refsynopsisdiv>
110
 
  
 
125
 
111
126
  <refsect1 id="description">
112
127
    <title>DESCRIPTION</title>
113
128
    <para>
122
137
      Any authenticated client is then given the stored pre-encrypted
123
138
      password for that specific client.
124
139
    </para>
 
140
 
125
141
  </refsect1>
126
142
  
127
143
  <refsect1 id="purpose">
128
144
    <title>PURPOSE</title>
 
145
 
129
146
    <para>
130
147
      The purpose of this is to enable <emphasis>remote and unattended
131
148
      rebooting</emphasis> of client host computer with an
132
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
133
150
      linkend="overview"/> for details.
134
151
    </para>
 
152
 
135
153
  </refsect1>
136
154
  
137
155
  <refsect1 id="options">
138
156
    <title>OPTIONS</title>
 
157
 
139
158
    <variablelist>
140
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
141
161
        <term><option>--help</option></term>
142
 
        <term><option>-h</option></term>
143
162
        <listitem>
144
163
          <para>
145
164
            Show a help message and exit
146
165
          </para>
147
166
        </listitem>
148
167
      </varlistentry>
149
 
      
 
168
 
150
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
151
172
        <term><option>--interface</option>
152
173
        <replaceable>NAME</replaceable></term>
153
 
        <term><option>-i</option>
154
 
        <replaceable>NAME</replaceable></term>
155
174
        <listitem>
156
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
176
        </listitem>
158
177
      </varlistentry>
159
 
      
 
178
 
160
179
      <varlistentry>
161
 
        <term><option>--address
162
 
        <replaceable>ADDRESS</replaceable></option></term>
163
 
        <term><option>-a
164
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
165
182
        <listitem>
166
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
184
        </listitem>
168
185
      </varlistentry>
169
 
      
 
186
 
170
187
      <varlistentry>
171
 
        <term><option>--port
172
 
        <replaceable>PORT</replaceable></option></term>
173
 
        <term><option>-p
174
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
175
190
        <listitem>
176
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
177
192
        </listitem>
178
193
      </varlistentry>
179
 
      
 
194
 
180
195
      <varlistentry>
181
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
182
197
        <listitem>
183
198
          <para>
184
199
            Run the server’s self-tests.  This includes any unit
186
201
          </para>
187
202
        </listitem>
188
203
      </varlistentry>
189
 
      
 
204
 
190
205
      <varlistentry>
191
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
192
207
        <listitem>
193
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
194
209
        </listitem>
195
210
      </varlistentry>
196
 
      
 
211
 
197
212
      <varlistentry>
198
 
        <term><option>--priority <replaceable>
199
 
        PRIORITY</replaceable></option></term>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
200
215
        <listitem>
201
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
202
217
        </listitem>
203
218
      </varlistentry>
204
 
      
 
219
 
205
220
      <varlistentry>
206
 
        <term><option>--servicename
207
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
208
223
        <listitem>
209
224
          <xi:include href="mandos-options.xml"
210
225
                      xpointer="servicename"/>
211
226
        </listitem>
212
227
      </varlistentry>
213
 
      
 
228
 
214
229
      <varlistentry>
215
 
        <term><option>--configdir
216
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
217
232
        <listitem>
218
233
          <para>
219
234
            Directory to search for configuration files.  Default is
225
240
          </para>
226
241
        </listitem>
227
242
      </varlistentry>
228
 
      
 
243
 
229
244
      <varlistentry>
230
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
231
246
        <listitem>
232
247
          <para>
233
248
            Prints the program version and exit.
234
249
          </para>
235
250
        </listitem>
236
251
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--no-dbus</option></term>
240
 
        <listitem>
241
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
242
 
          <para>
243
 
            See also <xref linkend="dbus_interface"/>.
244
 
          </para>
245
 
        </listitem>
246
 
      </varlistentry>
247
 
      
248
 
      <varlistentry>
249
 
        <term><option>--no-ipv6</option></term>
250
 
        <listitem>
251
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
252
 
        </listitem>
253
 
      </varlistentry>
254
252
    </variablelist>
255
253
  </refsect1>
256
 
  
 
254
 
257
255
  <refsect1 id="overview">
258
256
    <title>OVERVIEW</title>
259
257
    <xi:include href="overview.xml"/>
260
258
    <para>
261
259
      This program is the server part.  It is a normal server program
262
260
      and will run in a normal system environment, not in an initial
263
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
264
262
    </para>
265
263
  </refsect1>
266
 
  
 
264
 
267
265
  <refsect1 id="protocol">
268
266
    <title>NETWORK PROTOCOL</title>
269
267
    <para>
321
319
      </row>
322
320
    </tbody></tgroup></table>
323
321
  </refsect1>
324
 
  
 
322
 
325
323
  <refsect1 id="checking">
326
324
    <title>CHECKING</title>
327
325
    <para>
328
326
      The server will, by default, continually check that the clients
329
327
      are still up.  If a client has not been confirmed as being up
330
328
      for some time, the client is assumed to be compromised and is no
331
 
      longer eligible to receive the encrypted password.  (Manual
332
 
      intervention is required to re-enable a client.)  The timeout,
 
329
      longer eligible to receive the encrypted password.  The timeout,
333
330
      checker program, and interval between checks can be configured
334
331
      both globally and per client; see <citerefentry>
335
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
336
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
337
 
      receiving its password will also be treated as a successful
338
 
      checker run.
339
 
    </para>
340
 
  </refsect1>
341
 
  
342
 
  <refsect1 id="approval">
343
 
    <title>APPROVAL</title>
344
 
    <para>
345
 
      The server can be configured to require manual approval for a
346
 
      client before it is sent its secret.  The delay to wait for such
347
 
      approval and the default action (approve or deny) can be
348
 
      configured both globally and per client; see <citerefentry>
349
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
350
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
351
 
      will be approved immediately without delay.
352
 
    </para>
353
 
    <para>
354
 
      This can be used to deny a client its secret if not manually
355
 
      approved within a specified time.  It can also be used to make
356
 
      the server delay before giving a client its secret, allowing
357
 
      optional manual denying of this specific client.
358
 
    </para>
359
 
    
360
 
  </refsect1>
361
 
  
 
333
      <manvolnum>5</manvolnum></citerefentry>.
 
334
    </para>
 
335
  </refsect1>
 
336
 
362
337
  <refsect1 id="logging">
363
338
    <title>LOGGING</title>
364
339
    <para>
368
343
      and also show them on the console.
369
344
    </para>
370
345
  </refsect1>
371
 
  
372
 
  <refsect1 id="dbus_interface">
373
 
    <title>D-BUS INTERFACE</title>
374
 
    <para>
375
 
      The server will by default provide a D-Bus system bus interface.
376
 
      This interface will only be accessible by the root user or a
377
 
      Mandos-specific user, if such a user exists.  For documentation
378
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
379
 
    </para>
380
 
  </refsect1>
381
 
  
 
346
 
382
347
  <refsect1 id="exit_status">
383
348
    <title>EXIT STATUS</title>
384
349
    <para>
386
351
      critical error is encountered.
387
352
    </para>
388
353
  </refsect1>
389
 
  
 
354
 
390
355
  <refsect1 id="environment">
391
356
    <title>ENVIRONMENT</title>
392
357
    <variablelist>
406
371
      </varlistentry>
407
372
    </variablelist>
408
373
  </refsect1>
409
 
  
410
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
411
376
    <title>FILES</title>
412
377
    <para>
413
378
      Use the <option>--configdir</option> option to change where
436
401
        </listitem>
437
402
      </varlistentry>
438
403
      <varlistentry>
439
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
440
405
        <listitem>
441
406
          <para>
442
 
            The file containing the process id of the
443
 
            <command>&COMMANDNAME;</command> process started last.
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
444
409
          </para>
445
410
        </listitem>
446
411
      </varlistentry>
474
439
      backtrace.  This could be considered a feature.
475
440
    </para>
476
441
    <para>
477
 
      Currently, if a client is disabled due to having timed out, the
478
 
      server does not record this fact onto permanent storage.  This
479
 
      has some security implications, see <xref linkend="clients"/>.
 
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.
480
451
    </para>
481
452
    <para>
482
453
      There is no fine-grained control over logging and debug output.
485
456
      Debug mode is conflated with running in the foreground.
486
457
    </para>
487
458
    <para>
488
 
      The console log messages do not show a time stamp.
489
 
    </para>
490
 
    <para>
491
 
      This server does not check the expire time of clients’ OpenPGP
492
 
      keys.
 
459
      The console log messages does not show a timestamp.
493
460
    </para>
494
461
  </refsect1>
495
462
  
530
497
      </para>
531
498
    </informalexample>
532
499
  </refsect1>
533
 
  
 
500
 
534
501
  <refsect1 id="security">
535
502
    <title>SECURITY</title>
536
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
537
504
      <title>SERVER</title>
538
505
      <para>
539
506
        Running this <command>&COMMANDNAME;</command> server program
540
507
        should not in itself present any security risk to the host
541
 
        computer running it.  The program switches to a non-root user
542
 
        soon after startup.
 
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.
543
510
      </para>
544
511
    </refsect2>
545
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
546
513
      <title>CLIENTS</title>
547
514
      <para>
548
515
        The server only gives out its stored data to clients which
555
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
556
523
        <manvolnum>5</manvolnum></citerefentry>)
557
524
        <emphasis>must</emphasis> be made non-readable by anyone
558
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
559
526
      </para>
560
527
      <para>
561
528
        As detailed in <xref linkend="checking"/>, the status of all
564
531
      </para>
565
532
      <para>
566
533
        If a client is compromised, its downtime should be duly noted
567
 
        by the server which would therefore disable the client.  But
568
 
        if the server was ever restarted, it would re-read its client
569
 
        list from its configuration file and again regard all clients
570
 
        therein as enabled, and hence eligible to receive their
571
 
        passwords.  Therefore, be careful when restarting servers if
572
 
        it is suspected that a client has, in fact, been compromised
573
 
        by parties who may now be running a fake Mandos client with
574
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
575
 
        image of the client host.  What should be done in that case
576
 
        (if restarting the server program really is necessary) is to
577
 
        stop the server program, edit the configuration file to omit
578
 
        any suspect clients, and restart the server program.
 
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.
579
547
      </para>
580
548
      <para>
581
549
        For more details on client-side security, see
582
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
583
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
584
552
      </para>
585
553
    </refsect2>
586
554
  </refsect1>
587
 
  
 
555
 
588
556
  <refsect1 id="see_also">
589
557
    <title>SEE ALSO</title>
590
558
    <para>
593
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
594
562
        <refentrytitle>mandos.conf</refentrytitle>
595
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
596
 
        <refentrytitle>mandos-client</refentrytitle>
 
564
        <refentrytitle>password-request</refentrytitle>
597
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
598
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
599
567
      </citerefentry>