/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 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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