/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: 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 "2011-02-27">
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
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
52
70
      Gives encrypted passwords to authenticated Mandos clients
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
87
105
      <replaceable>DIRECTORY</replaceable></option></arg>
88
106
      <sbr/>
89
107
      <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>
97
108
    </cmdsynopsis>
98
109
    <cmdsynopsis>
99
110
      <command>&COMMANDNAME;</command>
100
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
101
113
        <arg choice="plain"><option>--help</option></arg>
102
 
        <arg choice="plain"><option>-h</option></arg>
103
114
      </group>
104
115
    </cmdsynopsis>
105
116
    <cmdsynopsis>
111
122
      <arg choice="plain"><option>--check</option></arg>
112
123
    </cmdsynopsis>
113
124
  </refsynopsisdiv>
114
 
  
 
125
 
115
126
  <refsect1 id="description">
116
127
    <title>DESCRIPTION</title>
117
128
    <para>
126
137
      Any authenticated client is then given the stored pre-encrypted
127
138
      password for that specific client.
128
139
    </para>
 
140
 
129
141
  </refsect1>
130
142
  
131
143
  <refsect1 id="purpose">
132
144
    <title>PURPOSE</title>
 
145
 
133
146
    <para>
134
147
      The purpose of this is to enable <emphasis>remote and unattended
135
148
      rebooting</emphasis> of client host computer with an
136
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
137
150
      linkend="overview"/> for details.
138
151
    </para>
 
152
 
139
153
  </refsect1>
140
154
  
141
155
  <refsect1 id="options">
142
156
    <title>OPTIONS</title>
 
157
 
143
158
    <variablelist>
144
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
145
161
        <term><option>--help</option></term>
146
 
        <term><option>-h</option></term>
147
162
        <listitem>
148
163
          <para>
149
164
            Show a help message and exit
150
165
          </para>
151
166
        </listitem>
152
167
      </varlistentry>
153
 
      
 
168
 
154
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
155
172
        <term><option>--interface</option>
156
173
        <replaceable>NAME</replaceable></term>
157
 
        <term><option>-i</option>
158
 
        <replaceable>NAME</replaceable></term>
159
174
        <listitem>
160
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
161
176
        </listitem>
162
177
      </varlistentry>
163
 
      
 
178
 
164
179
      <varlistentry>
165
 
        <term><option>--address
166
 
        <replaceable>ADDRESS</replaceable></option></term>
167
 
        <term><option>-a
168
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
169
182
        <listitem>
170
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
171
184
        </listitem>
172
185
      </varlistentry>
173
 
      
 
186
 
174
187
      <varlistentry>
175
 
        <term><option>--port
176
 
        <replaceable>PORT</replaceable></option></term>
177
 
        <term><option>-p
178
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
179
190
        <listitem>
180
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
181
192
        </listitem>
182
193
      </varlistentry>
183
 
      
 
194
 
184
195
      <varlistentry>
185
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
186
197
        <listitem>
187
198
          <para>
188
199
            Run the server’s self-tests.  This includes any unit
190
201
          </para>
191
202
        </listitem>
192
203
      </varlistentry>
193
 
      
 
204
 
194
205
      <varlistentry>
195
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
196
207
        <listitem>
197
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
198
209
        </listitem>
199
210
      </varlistentry>
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>
 
211
 
 
212
      <varlistentry>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
222
215
        <listitem>
223
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
224
217
        </listitem>
225
218
      </varlistentry>
226
 
      
 
219
 
227
220
      <varlistentry>
228
 
        <term><option>--servicename
229
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
230
223
        <listitem>
231
224
          <xi:include href="mandos-options.xml"
232
225
                      xpointer="servicename"/>
233
226
        </listitem>
234
227
      </varlistentry>
235
 
      
 
228
 
236
229
      <varlistentry>
237
 
        <term><option>--configdir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
239
232
        <listitem>
240
233
          <para>
241
234
            Directory to search for configuration files.  Default is
247
240
          </para>
248
241
        </listitem>
249
242
      </varlistentry>
250
 
      
 
243
 
251
244
      <varlistentry>
252
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
253
246
        <listitem>
254
247
          <para>
255
248
            Prints the program version and exit.
256
249
          </para>
257
250
        </listitem>
258
251
      </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>
276
252
    </variablelist>
277
253
  </refsect1>
278
 
  
 
254
 
279
255
  <refsect1 id="overview">
280
256
    <title>OVERVIEW</title>
281
257
    <xi:include href="overview.xml"/>
282
258
    <para>
283
259
      This program is the server part.  It is a normal server program
284
260
      and will run in a normal system environment, not in an initial
285
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
286
262
    </para>
287
263
  </refsect1>
288
 
  
 
264
 
289
265
  <refsect1 id="protocol">
290
266
    <title>NETWORK PROTOCOL</title>
291
267
    <para>
343
319
      </row>
344
320
    </tbody></tgroup></table>
345
321
  </refsect1>
346
 
  
 
322
 
347
323
  <refsect1 id="checking">
348
324
    <title>CHECKING</title>
349
325
    <para>
350
326
      The server will, by default, continually check that the clients
351
327
      are still up.  If a client has not been confirmed as being up
352
328
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  (Manual
354
 
      intervention is required to re-enable a client.)  The timeout,
 
329
      longer eligible to receive the encrypted password.  The timeout,
355
330
      checker program, and interval between checks can be configured
356
331
      both globally and per client; see <citerefentry>
357
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
  
 
333
      <manvolnum>5</manvolnum></citerefentry>.
 
334
    </para>
 
335
  </refsect1>
 
336
 
384
337
  <refsect1 id="logging">
385
338
    <title>LOGGING</title>
386
339
    <para>
390
343
      and also show them on the console.
391
344
    </para>
392
345
  </refsect1>
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
 
  
 
346
 
404
347
  <refsect1 id="exit_status">
405
348
    <title>EXIT STATUS</title>
406
349
    <para>
408
351
      critical error is encountered.
409
352
    </para>
410
353
  </refsect1>
411
 
  
 
354
 
412
355
  <refsect1 id="environment">
413
356
    <title>ENVIRONMENT</title>
414
357
    <variablelist>
428
371
      </varlistentry>
429
372
    </variablelist>
430
373
  </refsect1>
431
 
  
432
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
433
376
    <title>FILES</title>
434
377
    <para>
435
378
      Use the <option>--configdir</option> option to change where
458
401
        </listitem>
459
402
      </varlistentry>
460
403
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
462
405
        <listitem>
463
406
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
407
            The file containing the process id of
 
408
            <command>&COMMANDNAME;</command>.
466
409
          </para>
467
410
        </listitem>
468
411
      </varlistentry>
496
439
      backtrace.  This could be considered a feature.
497
440
    </para>
498
441
    <para>
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"/>.
 
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.
502
451
    </para>
503
452
    <para>
504
453
      There is no fine-grained control over logging and debug output.
507
456
      Debug mode is conflated with running in the foreground.
508
457
    </para>
509
458
    <para>
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.
 
459
      The console log messages does not show a timestamp.
515
460
    </para>
516
461
  </refsect1>
517
462
  
552
497
      </para>
553
498
    </informalexample>
554
499
  </refsect1>
555
 
  
 
500
 
556
501
  <refsect1 id="security">
557
502
    <title>SECURITY</title>
558
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
559
504
      <title>SERVER</title>
560
505
      <para>
561
506
        Running this <command>&COMMANDNAME;</command> server program
562
507
        should not in itself present any security risk to the host
563
 
        computer running it.  The program switches to a non-root user
564
 
        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.
565
510
      </para>
566
511
    </refsect2>
567
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
568
513
      <title>CLIENTS</title>
569
514
      <para>
570
515
        The server only gives out its stored data to clients which
577
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
578
523
        <manvolnum>5</manvolnum></citerefentry>)
579
524
        <emphasis>must</emphasis> be made non-readable by anyone
580
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
581
526
      </para>
582
527
      <para>
583
528
        As detailed in <xref linkend="checking"/>, the status of all
586
531
      </para>
587
532
      <para>
588
533
        If a client is compromised, its downtime should be duly noted
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.
 
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.
601
547
      </para>
602
548
      <para>
603
549
        For more details on client-side security, see
604
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
605
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
606
552
      </para>
607
553
    </refsect2>
608
554
  </refsect1>
609
 
  
 
555
 
610
556
  <refsect1 id="see_also">
611
557
    <title>SEE ALSO</title>
612
558
    <para>
615
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
562
        <refentrytitle>mandos.conf</refentrytitle>
617
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
 
564
        <refentrytitle>password-request</refentrytitle>
619
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
567
      </citerefentry>