/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: 2009-02-25 01:47:45 UTC
  • mfrom: (237.2.18 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20090225014745-8yyzt3b2q56nzk9l
Merge from release branch.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
5
<!ENTITY TIMESTAMP "2009-02-15">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
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
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
70
50
      Gives encrypted passwords to authenticated Mandos clients
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
105
85
      <replaceable>DIRECTORY</replaceable></option></arg>
106
86
      <sbr/>
107
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--no-ipv6</option></arg>
108
92
    </cmdsynopsis>
109
93
    <cmdsynopsis>
110
94
      <command>&COMMANDNAME;</command>
111
95
      <group choice="req">
 
96
        <arg choice="plain"><option>--help</option></arg>
112
97
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
98
      </group>
115
99
    </cmdsynopsis>
116
100
    <cmdsynopsis>
122
106
      <arg choice="plain"><option>--check</option></arg>
123
107
    </cmdsynopsis>
124
108
  </refsynopsisdiv>
125
 
 
 
109
  
126
110
  <refsect1 id="description">
127
111
    <title>DESCRIPTION</title>
128
112
    <para>
137
121
      Any authenticated client is then given the stored pre-encrypted
138
122
      password for that specific client.
139
123
    </para>
140
 
 
141
124
  </refsect1>
142
125
  
143
126
  <refsect1 id="purpose">
144
127
    <title>PURPOSE</title>
145
 
 
146
128
    <para>
147
129
      The purpose of this is to enable <emphasis>remote and unattended
148
130
      rebooting</emphasis> of client host computer with an
149
131
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
132
      linkend="overview"/> for details.
151
133
    </para>
152
 
 
153
134
  </refsect1>
154
135
  
155
136
  <refsect1 id="options">
156
137
    <title>OPTIONS</title>
157
 
 
158
138
    <variablelist>
159
139
      <varlistentry>
 
140
        <term><option>--help</option></term>
160
141
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
142
        <listitem>
163
143
          <para>
164
144
            Show a help message and exit
165
145
          </para>
166
146
        </listitem>
167
147
      </varlistentry>
168
 
 
 
148
      
169
149
      <varlistentry>
 
150
        <term><option>--interface</option>
 
151
        <replaceable>NAME</replaceable></term>
170
152
        <term><option>-i</option>
171
153
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
154
        <listitem>
175
155
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
156
        </listitem>
177
157
      </varlistentry>
178
 
 
 
158
      
179
159
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
160
        <term><option>--address
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <term><option>-a
 
163
        <replaceable>ADDRESS</replaceable></option></term>
182
164
        <listitem>
183
165
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
166
        </listitem>
185
167
      </varlistentry>
186
 
 
 
168
      
187
169
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
170
        <term><option>--port
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <term><option>-p
 
173
        <replaceable>PORT</replaceable></option></term>
190
174
        <listitem>
191
175
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
176
        </listitem>
193
177
      </varlistentry>
194
 
 
 
178
      
195
179
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
180
        <term><option>--check</option></term>
197
181
        <listitem>
198
182
          <para>
199
183
            Run the server’s self-tests.  This includes any unit
201
185
          </para>
202
186
        </listitem>
203
187
      </varlistentry>
204
 
 
 
188
      
205
189
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
190
        <term><option>--debug</option></term>
207
191
        <listitem>
208
192
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
193
        </listitem>
210
194
      </varlistentry>
211
 
 
 
195
      
212
196
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
197
        <term><option>--priority <replaceable>
 
198
        PRIORITY</replaceable></option></term>
215
199
        <listitem>
216
200
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
201
        </listitem>
218
202
      </varlistentry>
219
 
 
 
203
      
220
204
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
205
        <term><option>--servicename
 
206
        <replaceable>NAME</replaceable></option></term>
223
207
        <listitem>
224
208
          <xi:include href="mandos-options.xml"
225
209
                      xpointer="servicename"/>
226
210
        </listitem>
227
211
      </varlistentry>
228
 
 
 
212
      
229
213
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
214
        <term><option>--configdir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
232
216
        <listitem>
233
217
          <para>
234
218
            Directory to search for configuration files.  Default is
240
224
          </para>
241
225
        </listitem>
242
226
      </varlistentry>
243
 
 
 
227
      
244
228
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
229
        <term><option>--version</option></term>
246
230
        <listitem>
247
231
          <para>
248
232
            Prints the program version and exit.
249
233
          </para>
250
234
        </listitem>
251
235
      </varlistentry>
 
236
      
 
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--no-ipv6</option></term>
 
249
        <listitem>
 
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
251
        </listitem>
 
252
      </varlistentry>
252
253
    </variablelist>
253
254
  </refsect1>
254
 
 
 
255
  
255
256
  <refsect1 id="overview">
256
257
    <title>OVERVIEW</title>
257
258
    <xi:include href="overview.xml"/>
258
259
    <para>
259
260
      This program is the server part.  It is a normal server program
260
261
      and will run in a normal system environment, not in an initial
261
 
      RAM disk environment.
 
262
      <acronym>RAM</acronym> disk environment.
262
263
    </para>
263
264
  </refsect1>
264
 
 
 
265
  
265
266
  <refsect1 id="protocol">
266
267
    <title>NETWORK PROTOCOL</title>
267
268
    <para>
319
320
      </row>
320
321
    </tbody></tgroup></table>
321
322
  </refsect1>
322
 
 
 
323
  
323
324
  <refsect1 id="checking">
324
325
    <title>CHECKING</title>
325
326
    <para>
333
334
      <manvolnum>5</manvolnum></citerefentry>.
334
335
    </para>
335
336
  </refsect1>
336
 
 
 
337
  
337
338
  <refsect1 id="logging">
338
339
    <title>LOGGING</title>
339
340
    <para>
343
344
      and also show them on the console.
344
345
    </para>
345
346
  </refsect1>
346
 
 
 
347
  
 
348
  <refsect1 id="dbus_interface">
 
349
    <title>D-BUS INTERFACE</title>
 
350
    <para>
 
351
      The server will by default provide a D-Bus system bus interface.
 
352
      This interface will only be accessible by the root user or a
 
353
      Mandos-specific user, if such a user exists.
 
354
      <!-- XXX -->
 
355
    </para>
 
356
  </refsect1>
 
357
  
347
358
  <refsect1 id="exit_status">
348
359
    <title>EXIT STATUS</title>
349
360
    <para>
351
362
      critical error is encountered.
352
363
    </para>
353
364
  </refsect1>
354
 
 
 
365
  
355
366
  <refsect1 id="environment">
356
367
    <title>ENVIRONMENT</title>
357
368
    <variablelist>
371
382
      </varlistentry>
372
383
    </variablelist>
373
384
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
385
  
 
386
  <refsect1 id="files">
376
387
    <title>FILES</title>
377
388
    <para>
378
389
      Use the <option>--configdir</option> option to change where
401
412
        </listitem>
402
413
      </varlistentry>
403
414
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
415
        <term><filename>/var/run/mandos.pid</filename></term>
405
416
        <listitem>
406
417
          <para>
407
418
            The file containing the process id of
442
453
      Currently, if a client is declared <quote>invalid</quote> due to
443
454
      having timed out, the server does not record this fact onto
444
455
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="CLIENTS"/>.
 
456
      <xref linkend="clients"/>.
446
457
    </para>
447
458
    <para>
448
459
      There is currently no way of querying the server of the current
456
467
      Debug mode is conflated with running in the foreground.
457
468
    </para>
458
469
    <para>
459
 
      The console log messages does not show a timestamp.
 
470
      The console log messages do not show a time stamp.
 
471
    </para>
 
472
    <para>
 
473
      This server does not check the expire time of clients’ OpenPGP
 
474
      keys.
460
475
    </para>
461
476
  </refsect1>
462
477
  
497
512
      </para>
498
513
    </informalexample>
499
514
  </refsect1>
500
 
 
 
515
  
501
516
  <refsect1 id="security">
502
517
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
518
    <refsect2 id="server">
504
519
      <title>SERVER</title>
505
520
      <para>
506
521
        Running this <command>&COMMANDNAME;</command> server program
507
522
        should not in itself present any security risk to the host
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.
 
523
        computer running it.  The program switches to a non-root user
 
524
        soon after startup.
510
525
      </para>
511
526
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
527
    <refsect2 id="clients">
513
528
      <title>CLIENTS</title>
514
529
      <para>
515
530
        The server only gives out its stored data to clients which
522
537
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
538
        <manvolnum>5</manvolnum></citerefentry>)
524
539
        <emphasis>must</emphasis> be made non-readable by anyone
525
 
        except the user running the server.
 
540
        except the user starting the server (usually root).
526
541
      </para>
527
542
      <para>
528
543
        As detailed in <xref linkend="checking"/>, the status of all
539
554
        restarting servers if it is suspected that a client has, in
540
555
        fact, been compromised by parties who may now be running a
541
556
        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
 
557
        initial <acronym>RAM</acronym> image of the client host.  What
 
558
        should be done in that case (if restarting the server program
 
559
        really is necessary) is to stop the server program, edit the
545
560
        configuration file to omit any suspect clients, and restart
546
561
        the server program.
547
562
      </para>
548
563
      <para>
549
564
        For more details on client-side security, see
550
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
565
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
551
566
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
567
      </para>
553
568
    </refsect2>
554
569
  </refsect1>
555
 
 
 
570
  
556
571
  <refsect1 id="see_also">
557
572
    <title>SEE ALSO</title>
558
573
    <para>
561
576
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
577
        <refentrytitle>mandos.conf</refentrytitle>
563
578
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
 
579
        <refentrytitle>mandos-client</refentrytitle>
565
580
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
581
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
582
      </citerefentry>