/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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 "2008-12-28">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
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>
46
67
  <refnamediv>
47
68
    <refname><command>&COMMANDNAME;</command></refname>
48
69
    <refpurpose>
49
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends 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>
137
 
        <term><option>--help</option></term>
138
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
139
147
        <listitem>
140
148
          <para>
141
149
            Show a help message and exit
142
150
          </para>
143
151
        </listitem>
144
152
      </varlistentry>
145
 
      
 
153
 
146
154
      <varlistentry>
147
 
        <term><option>--interface</option>
148
 
        <replaceable>NAME</replaceable></term>
149
 
        <term><option>-i</option>
150
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
151
157
        <listitem>
152
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
153
159
        </listitem>
154
160
      </varlistentry>
155
 
      
 
161
 
156
162
      <varlistentry>
157
 
        <term><option>--address
158
 
        <replaceable>ADDRESS</replaceable></option></term>
159
 
        <term><option>-a
160
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
161
165
        <listitem>
162
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
163
167
        </listitem>
164
168
      </varlistentry>
165
 
      
 
169
 
166
170
      <varlistentry>
167
 
        <term><option>--port
168
 
        <replaceable>PORT</replaceable></option></term>
169
 
        <term><option>-p
170
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
171
173
        <listitem>
172
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
175
        </listitem>
174
176
      </varlistentry>
175
 
      
 
177
 
176
178
      <varlistentry>
177
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
178
180
        <listitem>
179
181
          <para>
180
182
            Run the server’s self-tests.  This includes any unit
182
184
          </para>
183
185
        </listitem>
184
186
      </varlistentry>
185
 
      
 
187
 
186
188
      <varlistentry>
187
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
188
190
        <listitem>
189
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
192
        </listitem>
191
193
      </varlistentry>
192
 
      
 
194
 
193
195
      <varlistentry>
194
 
        <term><option>--priority <replaceable>
195
 
        PRIORITY</replaceable></option></term>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
196
198
        <listitem>
197
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
200
        </listitem>
199
201
      </varlistentry>
200
 
      
 
202
 
201
203
      <varlistentry>
202
 
        <term><option>--servicename
203
 
        <replaceable>NAME</replaceable></option></term>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
204
206
        <listitem>
205
207
          <xi:include href="mandos-options.xml"
206
208
                      xpointer="servicename"/>
207
209
        </listitem>
208
210
      </varlistentry>
209
 
      
 
211
 
210
212
      <varlistentry>
211
 
        <term><option>--configdir
212
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
213
215
        <listitem>
214
216
          <para>
215
217
            Directory to search for configuration files.  Default is
221
223
          </para>
222
224
        </listitem>
223
225
      </varlistentry>
224
 
      
 
226
 
225
227
      <varlistentry>
226
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
227
229
        <listitem>
228
230
          <para>
229
231
            Prints the program version and exit.
230
232
          </para>
231
233
        </listitem>
232
234
      </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"/>.
240
 
        </listitem>
241
 
      </varlistentry>
242
235
    </variablelist>
243
236
  </refsect1>
244
 
  
 
237
 
245
238
  <refsect1 id="overview">
246
239
    <title>OVERVIEW</title>
247
240
    <xi:include href="overview.xml"/>
248
241
    <para>
249
242
      This program is the server part.  It is a normal server program
250
243
      and will run in a normal system environment, not in an initial
251
 
      <acronym>RAM</acronym> disk environment.
 
244
      RAM disk environment.
252
245
    </para>
253
246
  </refsect1>
254
 
  
 
247
 
255
248
  <refsect1 id="protocol">
256
249
    <title>NETWORK PROTOCOL</title>
257
250
    <para>
309
302
      </row>
310
303
    </tbody></tgroup></table>
311
304
  </refsect1>
312
 
  
 
305
 
313
306
  <refsect1 id="checking">
314
307
    <title>CHECKING</title>
315
308
    <para>
323
316
      <manvolnum>5</manvolnum></citerefentry>.
324
317
    </para>
325
318
  </refsect1>
326
 
  
 
319
 
327
320
  <refsect1 id="logging">
328
321
    <title>LOGGING</title>
329
322
    <para>
333
326
      and also show them on the console.
334
327
    </para>
335
328
  </refsect1>
336
 
  
337
 
  <refsect1 id="dbus">
338
 
    <title>D-BUS INTERFACE</title>
339
 
    <para>
340
 
      The server will by default provide a D-Bus system bus interface.
341
 
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
344
 
    </para>
345
 
  </refsect1>
346
329
 
347
330
  <refsect1 id="exit_status">
348
331
    <title>EXIT STATUS</title>
351
334
      critical error is encountered.
352
335
    </para>
353
336
  </refsect1>
354
 
  
 
337
 
355
338
  <refsect1 id="environment">
356
339
    <title>ENVIRONMENT</title>
357
340
    <variablelist>
358
341
      <varlistentry>
359
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
360
343
        <listitem>
361
344
          <para>
362
345
            To start the configured checker (see <xref
371
354
      </varlistentry>
372
355
    </variablelist>
373
356
  </refsect1>
374
 
  
375
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
376
359
    <title>FILES</title>
377
360
    <para>
378
361
      Use the <option>--configdir</option> option to change where
401
384
        </listitem>
402
385
      </varlistentry>
403
386
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
388
        <listitem>
406
389
          <para>
407
390
            The file containing the process id of
442
425
      Currently, if a client is declared <quote>invalid</quote> due to
443
426
      having timed out, the server does not record this fact onto
444
427
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
 
428
      <xref linkend="CLIENTS"/>.
446
429
    </para>
447
430
    <para>
448
431
      There is currently no way of querying the server of the current
456
439
      Debug mode is conflated with running in the foreground.
457
440
    </para>
458
441
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
 
      This server does not check the expire time of clients’ OpenPGP
463
 
      keys.
 
442
      The console log messages does not show a timestamp.
464
443
    </para>
465
444
  </refsect1>
466
445
  
501
480
      </para>
502
481
    </informalexample>
503
482
  </refsect1>
504
 
  
 
483
 
505
484
  <refsect1 id="security">
506
485
    <title>SECURITY</title>
507
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
508
487
      <title>SERVER</title>
509
488
      <para>
510
489
        Running this <command>&COMMANDNAME;</command> server program
511
490
        should not in itself present any security risk to the host
512
 
        computer running it.  The program switches to a non-root user
513
 
        soon after startup.
 
491
        computer running it.  The program does not need any special
 
492
        privileges to run, and is designed to run as a non-root user.
514
493
      </para>
515
494
    </refsect2>
516
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
517
496
      <title>CLIENTS</title>
518
497
      <para>
519
498
        The server only gives out its stored data to clients which
526
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
506
        <manvolnum>5</manvolnum></citerefentry>)
528
507
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
530
509
      </para>
531
510
      <para>
532
511
        As detailed in <xref linkend="checking"/>, the status of all
543
522
        restarting servers if it is suspected that a client has, in
544
523
        fact, been compromised by parties who may now be running a
545
524
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
 
525
        initial RAM image of the client host.  What should be done in
 
526
        that case (if restarting the server program really is
 
527
        necessary) is to stop the server program, edit the
549
528
        configuration file to omit any suspect clients, and restart
550
529
        the server program.
551
530
      </para>
552
531
      <para>
553
532
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
555
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
535
      </para>
557
536
    </refsect2>
558
537
  </refsect1>
559
 
  
 
538
 
560
539
  <refsect1 id="see_also">
561
540
    <title>SEE ALSO</title>
562
541
    <para>
563
542
      <citerefentry>
 
543
        <refentrytitle>mandos.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
545
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <refentrytitle>password-request</refentrytitle>
569
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
550
      </citerefentry>