/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

Added enable/disable

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 "2008-12-28">
 
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"/>.
 
240
        </listitem>
 
241
      </varlistentry>
234
242
    </variablelist>
235
243
  </refsect1>
236
 
 
 
244
  
237
245
  <refsect1 id="overview">
238
246
    <title>OVERVIEW</title>
239
247
    <xi:include href="overview.xml"/>
243
251
      <acronym>RAM</acronym> disk environment.
244
252
    </para>
245
253
  </refsect1>
246
 
 
 
254
  
247
255
  <refsect1 id="protocol">
248
256
    <title>NETWORK PROTOCOL</title>
249
257
    <para>
301
309
      </row>
302
310
    </tbody></tgroup></table>
303
311
  </refsect1>
304
 
 
 
312
  
305
313
  <refsect1 id="checking">
306
314
    <title>CHECKING</title>
307
315
    <para>
315
323
      <manvolnum>5</manvolnum></citerefentry>.
316
324
    </para>
317
325
  </refsect1>
318
 
 
 
326
  
319
327
  <refsect1 id="logging">
320
328
    <title>LOGGING</title>
321
329
    <para>
325
333
      and also show them on the console.
326
334
    </para>
327
335
  </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>
328
346
 
329
347
  <refsect1 id="exit_status">
330
348
    <title>EXIT STATUS</title>
333
351
      critical error is encountered.
334
352
    </para>
335
353
  </refsect1>
336
 
 
 
354
  
337
355
  <refsect1 id="environment">
338
356
    <title>ENVIRONMENT</title>
339
357
    <variablelist>
353
371
      </varlistentry>
354
372
    </variablelist>
355
373
  </refsect1>
356
 
 
357
 
  <refsect1 id="file">
 
374
  
 
375
  <refsect1 id="files">
358
376
    <title>FILES</title>
359
377
    <para>
360
378
      Use the <option>--configdir</option> option to change where
383
401
        </listitem>
384
402
      </varlistentry>
385
403
      <varlistentry>
386
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos.pid</filename></term>
387
405
        <listitem>
388
406
          <para>
389
407
            The file containing the process id of
424
442
      Currently, if a client is declared <quote>invalid</quote> due to
425
443
      having timed out, the server does not record this fact onto
426
444
      permanent storage.  This has some security implications, see
427
 
      <xref linkend="CLIENTS"/>.
 
445
      <xref linkend="clients"/>.
428
446
    </para>
429
447
    <para>
430
448
      There is currently no way of querying the server of the current
438
456
      Debug mode is conflated with running in the foreground.
439
457
    </para>
440
458
    <para>
441
 
      The console log messages does not show a timestamp.
 
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
464
    </para>
443
465
  </refsect1>
444
466
  
479
501
      </para>
480
502
    </informalexample>
481
503
  </refsect1>
482
 
 
 
504
  
483
505
  <refsect1 id="security">
484
506
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
507
    <refsect2 id="server">
486
508
      <title>SERVER</title>
487
509
      <para>
488
510
        Running this <command>&COMMANDNAME;</command> server program
489
511
        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.
 
512
        computer running it.  The program switches to a non-root user
 
513
        soon after startup.
492
514
      </para>
493
515
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
516
    <refsect2 id="clients">
495
517
      <title>CLIENTS</title>
496
518
      <para>
497
519
        The server only gives out its stored data to clients which
504
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
527
        <manvolnum>5</manvolnum></citerefentry>)
506
528
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
529
        except the user starting the server (usually root).
508
530
      </para>
509
531
      <para>
510
532
        As detailed in <xref linkend="checking"/>, the status of all
529
551
      </para>
530
552
      <para>
531
553
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
554
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
556
      </para>
535
557
    </refsect2>
536
558
  </refsect1>
537
 
 
 
559
  
538
560
  <refsect1 id="see_also">
539
561
    <title>SEE ALSO</title>
540
562
    <para>
543
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
566
        <refentrytitle>mandos.conf</refentrytitle>
545
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
 
568
        <refentrytitle>mandos-client</refentrytitle>
547
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
571
      </citerefentry>