/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-01-06 20:22:18 UTC
  • mfrom: (237.2.14 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090106202218-znyzociuf8ojl93s
Merge from trunk; fixes for debian/changelog suggested by sponsor.

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