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