/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-01-04 21:26:57 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104212657-cl3kz35co2v3g3eo
* mandos (MandosServer.Quit): New.

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-09-01">
 
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>
36
37
    </copyright>
37
38
    <xi:include href="legalnotice.xml"/>
38
39
  </refentryinfo>
39
 
 
 
40
  
40
41
  <refmeta>
41
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
43
    <manvolnum>8</manvolnum>
48
49
      Gives encrypted passwords to authenticated Mandos clients
49
50
    </refpurpose>
50
51
  </refnamediv>
51
 
 
 
52
  
52
53
  <refsynopsisdiv>
53
54
    <cmdsynopsis>
54
55
      <command>&COMMANDNAME;</command>
83
84
      <replaceable>DIRECTORY</replaceable></option></arg>
84
85
      <sbr/>
85
86
      <arg><option>--debug</option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--no-dbus</option></arg>
86
89
    </cmdsynopsis>
87
90
    <cmdsynopsis>
88
91
      <command>&COMMANDNAME;</command>
100
103
      <arg choice="plain"><option>--check</option></arg>
101
104
    </cmdsynopsis>
102
105
  </refsynopsisdiv>
103
 
 
 
106
  
104
107
  <refsect1 id="description">
105
108
    <title>DESCRIPTION</title>
106
109
    <para>
115
118
      Any authenticated client is then given the stored pre-encrypted
116
119
      password for that specific client.
117
120
    </para>
118
 
 
119
121
  </refsect1>
120
122
  
121
123
  <refsect1 id="purpose">
122
124
    <title>PURPOSE</title>
123
 
 
124
125
    <para>
125
126
      The purpose of this is to enable <emphasis>remote and unattended
126
127
      rebooting</emphasis> of client host computer with an
127
128
      <emphasis>encrypted root file system</emphasis>.  See <xref
128
129
      linkend="overview"/> for details.
129
130
    </para>
130
 
    
131
131
  </refsect1>
132
132
  
133
133
  <refsect1 id="options">
134
134
    <title>OPTIONS</title>
135
 
    
136
135
    <variablelist>
137
136
      <varlistentry>
138
137
        <term><option>--help</option></term>
190
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
190
        </listitem>
192
191
      </varlistentry>
193
 
 
 
192
      
194
193
      <varlistentry>
195
194
        <term><option>--priority <replaceable>
196
195
        PRIORITY</replaceable></option></term>
198
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
198
        </listitem>
200
199
      </varlistentry>
201
 
 
 
200
      
202
201
      <varlistentry>
203
202
        <term><option>--servicename
204
203
        <replaceable>NAME</replaceable></option></term>
207
206
                      xpointer="servicename"/>
208
207
        </listitem>
209
208
      </varlistentry>
210
 
 
 
209
      
211
210
      <varlistentry>
212
211
        <term><option>--configdir
213
212
        <replaceable>DIRECTORY</replaceable></option></term>
222
221
          </para>
223
222
        </listitem>
224
223
      </varlistentry>
225
 
 
 
224
      
226
225
      <varlistentry>
227
226
        <term><option>--version</option></term>
228
227
        <listitem>
231
230
          </para>
232
231
        </listitem>
233
232
      </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_interface"/>.
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
234
243
    </variablelist>
235
244
  </refsect1>
236
 
 
 
245
  
237
246
  <refsect1 id="overview">
238
247
    <title>OVERVIEW</title>
239
248
    <xi:include href="overview.xml"/>
243
252
      <acronym>RAM</acronym> disk environment.
244
253
    </para>
245
254
  </refsect1>
246
 
 
 
255
  
247
256
  <refsect1 id="protocol">
248
257
    <title>NETWORK PROTOCOL</title>
249
258
    <para>
301
310
      </row>
302
311
    </tbody></tgroup></table>
303
312
  </refsect1>
304
 
 
 
313
  
305
314
  <refsect1 id="checking">
306
315
    <title>CHECKING</title>
307
316
    <para>
315
324
      <manvolnum>5</manvolnum></citerefentry>.
316
325
    </para>
317
326
  </refsect1>
318
 
 
 
327
  
319
328
  <refsect1 id="logging">
320
329
    <title>LOGGING</title>
321
330
    <para>
325
334
      and also show them on the console.
326
335
    </para>
327
336
  </refsect1>
 
337
  
 
338
  <refsect1 id="dbus_interface">
 
339
    <title>D-BUS INTERFACE</title>
 
340
    <para>
 
341
      The server will by default provide a D-Bus system bus interface.
 
342
      This interface will only be accessible by the root user or a
 
343
      Mandos-specific user, if such a user exists.
 
344
      <!-- XXX -->
 
345
    </para>
 
346
  </refsect1>
328
347
 
329
348
  <refsect1 id="exit_status">
330
349
    <title>EXIT STATUS</title>
333
352
      critical error is encountered.
334
353
    </para>
335
354
  </refsect1>
336
 
 
 
355
  
337
356
  <refsect1 id="environment">
338
357
    <title>ENVIRONMENT</title>
339
358
    <variablelist>
353
372
      </varlistentry>
354
373
    </variablelist>
355
374
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
375
  
 
376
  <refsect1 id="files">
358
377
    <title>FILES</title>
359
378
    <para>
360
379
      Use the <option>--configdir</option> option to change where
383
402
        </listitem>
384
403
      </varlistentry>
385
404
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
405
        <term><filename>/var/run/mandos.pid</filename></term>
387
406
        <listitem>
388
407
          <para>
389
408
            The file containing the process id of
424
443
      Currently, if a client is declared <quote>invalid</quote> due to
425
444
      having timed out, the server does not record this fact onto
426
445
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
446
      <xref linkend="clients"/>.
428
447
    </para>
429
448
    <para>
430
449
      There is currently no way of querying the server of the current
438
457
      Debug mode is conflated with running in the foreground.
439
458
    </para>
440
459
    <para>
441
 
      The console log messages does not show a timestamp.
 
460
      The console log messages does not show a time stamp.
 
461
    </para>
 
462
    <para>
 
463
      This server does not check the expire time of clients’ OpenPGP
 
464
      keys.
442
465
    </para>
443
466
  </refsect1>
444
467
  
479
502
      </para>
480
503
    </informalexample>
481
504
  </refsect1>
482
 
 
 
505
  
483
506
  <refsect1 id="security">
484
507
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
508
    <refsect2 id="server">
486
509
      <title>SERVER</title>
487
510
      <para>
488
511
        Running this <command>&COMMANDNAME;</command> server program
489
512
        should not in itself present any security risk to the host
490
 
        computer running it.  The program does not need any special
491
 
        privileges to run, and is designed to run as a non-root user.
 
513
        computer running it.  The program switches to a non-root user
 
514
        soon after startup.
492
515
      </para>
493
516
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
517
    <refsect2 id="clients">
495
518
      <title>CLIENTS</title>
496
519
      <para>
497
520
        The server only gives out its stored data to clients which
504
527
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
528
        <manvolnum>5</manvolnum></citerefentry>)
506
529
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
530
        except the user starting the server (usually root).
508
531
      </para>
509
532
      <para>
510
533
        As detailed in <xref linkend="checking"/>, the status of all
529
552
      </para>
530
553
      <para>
531
554
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
555
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
556
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
557
      </para>
535
558
    </refsect2>
536
559
  </refsect1>
537
 
 
 
560
  
538
561
  <refsect1 id="see_also">
539
562
    <title>SEE ALSO</title>
540
563
    <para>
543
566
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
567
        <refentrytitle>mandos.conf</refentrytitle>
545
568
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
569
        <refentrytitle>mandos-client</refentrytitle>
547
570
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
571
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
572
      </citerefentry>