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