/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 "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>
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
108
    </cmdsynopsis>
91
109
    <cmdsynopsis>
92
110
      <command>&COMMANDNAME;</command>
93
111
      <group choice="req">
 
112
        <arg choice="plain"><option>-h</option></arg>
94
113
        <arg choice="plain"><option>--help</option></arg>
95
 
        <arg choice="plain"><option>-h</option></arg>
96
114
      </group>
97
115
    </cmdsynopsis>
98
116
    <cmdsynopsis>
104
122
      <arg choice="plain"><option>--check</option></arg>
105
123
    </cmdsynopsis>
106
124
  </refsynopsisdiv>
107
 
  
 
125
 
108
126
  <refsect1 id="description">
109
127
    <title>DESCRIPTION</title>
110
128
    <para>
119
137
      Any authenticated client is then given the stored pre-encrypted
120
138
      password for that specific client.
121
139
    </para>
 
140
 
122
141
  </refsect1>
123
142
  
124
143
  <refsect1 id="purpose">
125
144
    <title>PURPOSE</title>
 
145
 
126
146
    <para>
127
147
      The purpose of this is to enable <emphasis>remote and unattended
128
148
      rebooting</emphasis> of client host computer with an
129
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
130
150
      linkend="overview"/> for details.
131
151
    </para>
 
152
 
132
153
  </refsect1>
133
154
  
134
155
  <refsect1 id="options">
135
156
    <title>OPTIONS</title>
 
157
 
136
158
    <variablelist>
137
159
      <varlistentry>
 
160
        <term><option>-h</option></term>
138
161
        <term><option>--help</option></term>
139
 
        <term><option>-h</option></term>
140
162
        <listitem>
141
163
          <para>
142
164
            Show a help message and exit
143
165
          </para>
144
166
        </listitem>
145
167
      </varlistentry>
146
 
      
 
168
 
147
169
      <varlistentry>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
148
172
        <term><option>--interface</option>
149
173
        <replaceable>NAME</replaceable></term>
150
 
        <term><option>-i</option>
151
 
        <replaceable>NAME</replaceable></term>
152
174
        <listitem>
153
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
154
176
        </listitem>
155
177
      </varlistentry>
156
 
      
 
178
 
157
179
      <varlistentry>
158
 
        <term><option>--address
159
 
        <replaceable>ADDRESS</replaceable></option></term>
160
 
        <term><option>-a
161
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
162
182
        <listitem>
163
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
164
184
        </listitem>
165
185
      </varlistentry>
166
 
      
 
186
 
167
187
      <varlistentry>
168
 
        <term><option>--port
169
 
        <replaceable>PORT</replaceable></option></term>
170
 
        <term><option>-p
171
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
172
190
        <listitem>
173
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
174
192
        </listitem>
175
193
      </varlistentry>
176
 
      
 
194
 
177
195
      <varlistentry>
178
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
179
197
        <listitem>
180
198
          <para>
181
199
            Run the server’s self-tests.  This includes any unit
183
201
          </para>
184
202
        </listitem>
185
203
      </varlistentry>
186
 
      
 
204
 
187
205
      <varlistentry>
188
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
189
207
        <listitem>
190
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
209
        </listitem>
192
210
      </varlistentry>
193
 
      
 
211
 
194
212
      <varlistentry>
195
 
        <term><option>--priority <replaceable>
196
 
        PRIORITY</replaceable></option></term>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
197
215
        <listitem>
198
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
217
        </listitem>
200
218
      </varlistentry>
201
 
      
 
219
 
202
220
      <varlistentry>
203
 
        <term><option>--servicename
204
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
205
223
        <listitem>
206
224
          <xi:include href="mandos-options.xml"
207
225
                      xpointer="servicename"/>
208
226
        </listitem>
209
227
      </varlistentry>
210
 
      
 
228
 
211
229
      <varlistentry>
212
 
        <term><option>--configdir
213
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
214
232
        <listitem>
215
233
          <para>
216
234
            Directory to search for configuration files.  Default is
222
240
          </para>
223
241
        </listitem>
224
242
      </varlistentry>
225
 
      
 
243
 
226
244
      <varlistentry>
227
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
228
246
        <listitem>
229
247
          <para>
230
248
            Prints the program version and exit.
231
249
          </para>
232
250
        </listitem>
233
251
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--no-dbus</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
239
 
          <para>
240
 
            See also <xref linkend="dbus_interface"/>.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
252
    </variablelist>
245
253
  </refsect1>
246
 
  
 
254
 
247
255
  <refsect1 id="overview">
248
256
    <title>OVERVIEW</title>
249
257
    <xi:include href="overview.xml"/>
250
258
    <para>
251
259
      This program is the server part.  It is a normal server program
252
260
      and will run in a normal system environment, not in an initial
253
 
      <acronym>RAM</acronym> disk environment.
 
261
      RAM disk environment.
254
262
    </para>
255
263
  </refsect1>
256
 
  
 
264
 
257
265
  <refsect1 id="protocol">
258
266
    <title>NETWORK PROTOCOL</title>
259
267
    <para>
311
319
      </row>
312
320
    </tbody></tgroup></table>
313
321
  </refsect1>
314
 
  
 
322
 
315
323
  <refsect1 id="checking">
316
324
    <title>CHECKING</title>
317
325
    <para>
325
333
      <manvolnum>5</manvolnum></citerefentry>.
326
334
    </para>
327
335
  </refsect1>
328
 
  
 
336
 
329
337
  <refsect1 id="logging">
330
338
    <title>LOGGING</title>
331
339
    <para>
335
343
      and also show them on the console.
336
344
    </para>
337
345
  </refsect1>
338
 
  
339
 
  <refsect1 id="dbus_interface">
340
 
    <title>D-BUS INTERFACE</title>
341
 
    <para>
342
 
      The server will by default provide a D-Bus system bus interface.
343
 
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- XXX -->
346
 
    </para>
347
 
  </refsect1>
348
346
 
349
347
  <refsect1 id="exit_status">
350
348
    <title>EXIT STATUS</title>
353
351
      critical error is encountered.
354
352
    </para>
355
353
  </refsect1>
356
 
  
 
354
 
357
355
  <refsect1 id="environment">
358
356
    <title>ENVIRONMENT</title>
359
357
    <variablelist>
373
371
      </varlistentry>
374
372
    </variablelist>
375
373
  </refsect1>
376
 
  
377
 
  <refsect1 id="files">
 
374
 
 
375
  <refsect1 id="file">
378
376
    <title>FILES</title>
379
377
    <para>
380
378
      Use the <option>--configdir</option> option to change where
403
401
        </listitem>
404
402
      </varlistentry>
405
403
      <varlistentry>
406
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
407
405
        <listitem>
408
406
          <para>
409
407
            The file containing the process id of
444
442
      Currently, if a client is declared <quote>invalid</quote> due to
445
443
      having timed out, the server does not record this fact onto
446
444
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
 
445
      <xref linkend="CLIENTS"/>.
448
446
    </para>
449
447
    <para>
450
448
      There is currently no way of querying the server of the current
458
456
      Debug mode is conflated with running in the foreground.
459
457
    </para>
460
458
    <para>
461
 
      The console log messages does not show a time stamp.
462
 
    </para>
463
 
    <para>
464
 
      This server does not check the expire time of clients’ OpenPGP
465
 
      keys.
 
459
      The console log messages does not show a timestamp.
466
460
    </para>
467
461
  </refsect1>
468
462
  
503
497
      </para>
504
498
    </informalexample>
505
499
  </refsect1>
506
 
  
 
500
 
507
501
  <refsect1 id="security">
508
502
    <title>SECURITY</title>
509
 
    <refsect2 id="server">
 
503
    <refsect2 id="SERVER">
510
504
      <title>SERVER</title>
511
505
      <para>
512
506
        Running this <command>&COMMANDNAME;</command> server program
513
507
        should not in itself present any security risk to the host
514
 
        computer running it.  The program switches to a non-root user
515
 
        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.
516
510
      </para>
517
511
    </refsect2>
518
 
    <refsect2 id="clients">
 
512
    <refsect2 id="CLIENTS">
519
513
      <title>CLIENTS</title>
520
514
      <para>
521
515
        The server only gives out its stored data to clients which
528
522
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
523
        <manvolnum>5</manvolnum></citerefentry>)
530
524
        <emphasis>must</emphasis> be made non-readable by anyone
531
 
        except the user starting the server (usually root).
 
525
        except the user running the server.
532
526
      </para>
533
527
      <para>
534
528
        As detailed in <xref linkend="checking"/>, the status of all
545
539
        restarting servers if it is suspected that a client has, in
546
540
        fact, been compromised by parties who may now be running a
547
541
        fake Mandos client with the keys from the non-encrypted
548
 
        initial <acronym>RAM</acronym> image of the client host.  What
549
 
        should be done in that case (if restarting the server program
550
 
        really is necessary) is to stop the server program, edit the
 
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
551
545
        configuration file to omit any suspect clients, and restart
552
546
        the server program.
553
547
      </para>
554
548
      <para>
555
549
        For more details on client-side security, see
556
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
550
        <citerefentry><refentrytitle>password-request</refentrytitle>
557
551
        <manvolnum>8mandos</manvolnum></citerefentry>.
558
552
      </para>
559
553
    </refsect2>
560
554
  </refsect1>
561
 
  
 
555
 
562
556
  <refsect1 id="see_also">
563
557
    <title>SEE ALSO</title>
564
558
    <para>
567
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
562
        <refentrytitle>mandos.conf</refentrytitle>
569
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>mandos-client</refentrytitle>
 
564
        <refentrytitle>password-request</refentrytitle>
571
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
567
      </citerefentry>