/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: 2008-09-02 06:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902061347-psw61eqt17j425sq
* plugin-runner.c: Changed short option for "--global-env" to "-G",
                   changed short option for "--env-for" to "-E",
                   added new option "--enable" ("-e").

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-02-15">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-01">
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
37
    <xi:include href="legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8</manvolnum>
50
48
      Gives encrypted passwords to authenticated Mandos clients
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
85
83
      <replaceable>DIRECTORY</replaceable></option></arg>
86
84
      <sbr/>
87
85
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
86
    </cmdsynopsis>
93
87
    <cmdsynopsis>
94
88
      <command>&COMMANDNAME;</command>
106
100
      <arg choice="plain"><option>--check</option></arg>
107
101
    </cmdsynopsis>
108
102
  </refsynopsisdiv>
109
 
  
 
103
 
110
104
  <refsect1 id="description">
111
105
    <title>DESCRIPTION</title>
112
106
    <para>
121
115
      Any authenticated client is then given the stored pre-encrypted
122
116
      password for that specific client.
123
117
    </para>
 
118
 
124
119
  </refsect1>
125
120
  
126
121
  <refsect1 id="purpose">
127
122
    <title>PURPOSE</title>
 
123
 
128
124
    <para>
129
125
      The purpose of this is to enable <emphasis>remote and unattended
130
126
      rebooting</emphasis> of client host computer with an
131
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
128
      linkend="overview"/> for details.
133
129
    </para>
 
130
    
134
131
  </refsect1>
135
132
  
136
133
  <refsect1 id="options">
137
134
    <title>OPTIONS</title>
 
135
    
138
136
    <variablelist>
139
137
      <varlistentry>
140
138
        <term><option>--help</option></term>
192
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
191
        </listitem>
194
192
      </varlistentry>
195
 
      
 
193
 
196
194
      <varlistentry>
197
195
        <term><option>--priority <replaceable>
198
196
        PRIORITY</replaceable></option></term>
200
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
199
        </listitem>
202
200
      </varlistentry>
203
 
      
 
201
 
204
202
      <varlistentry>
205
203
        <term><option>--servicename
206
204
        <replaceable>NAME</replaceable></option></term>
209
207
                      xpointer="servicename"/>
210
208
        </listitem>
211
209
      </varlistentry>
212
 
      
 
210
 
213
211
      <varlistentry>
214
212
        <term><option>--configdir
215
213
        <replaceable>DIRECTORY</replaceable></option></term>
224
222
          </para>
225
223
        </listitem>
226
224
      </varlistentry>
227
 
      
 
225
 
228
226
      <varlistentry>
229
227
        <term><option>--version</option></term>
230
228
        <listitem>
233
231
          </para>
234
232
        </listitem>
235
233
      </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>
253
234
    </variablelist>
254
235
  </refsect1>
255
 
  
 
236
 
256
237
  <refsect1 id="overview">
257
238
    <title>OVERVIEW</title>
258
239
    <xi:include href="overview.xml"/>
262
243
      <acronym>RAM</acronym> disk environment.
263
244
    </para>
264
245
  </refsect1>
265
 
  
 
246
 
266
247
  <refsect1 id="protocol">
267
248
    <title>NETWORK PROTOCOL</title>
268
249
    <para>
320
301
      </row>
321
302
    </tbody></tgroup></table>
322
303
  </refsect1>
323
 
  
 
304
 
324
305
  <refsect1 id="checking">
325
306
    <title>CHECKING</title>
326
307
    <para>
334
315
      <manvolnum>5</manvolnum></citerefentry>.
335
316
    </para>
336
317
  </refsect1>
337
 
  
 
318
 
338
319
  <refsect1 id="logging">
339
320
    <title>LOGGING</title>
340
321
    <para>
344
325
      and also show them on the console.
345
326
    </para>
346
327
  </refsect1>
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
 
  
 
328
 
358
329
  <refsect1 id="exit_status">
359
330
    <title>EXIT STATUS</title>
360
331
    <para>
362
333
      critical error is encountered.
363
334
    </para>
364
335
  </refsect1>
365
 
  
 
336
 
366
337
  <refsect1 id="environment">
367
338
    <title>ENVIRONMENT</title>
368
339
    <variablelist>
382
353
      </varlistentry>
383
354
    </variablelist>
384
355
  </refsect1>
385
 
  
386
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
387
358
    <title>FILES</title>
388
359
    <para>
389
360
      Use the <option>--configdir</option> option to change where
412
383
        </listitem>
413
384
      </varlistentry>
414
385
      <varlistentry>
415
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
416
387
        <listitem>
417
388
          <para>
418
389
            The file containing the process id of
453
424
      Currently, if a client is declared <quote>invalid</quote> due to
454
425
      having timed out, the server does not record this fact onto
455
426
      permanent storage.  This has some security implications, see
456
 
      <xref linkend="clients"/>.
 
427
      <xref linkend="CLIENTS"/>.
457
428
    </para>
458
429
    <para>
459
430
      There is currently no way of querying the server of the current
467
438
      Debug mode is conflated with running in the foreground.
468
439
    </para>
469
440
    <para>
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.
 
441
      The console log messages does not show a timestamp.
475
442
    </para>
476
443
  </refsect1>
477
444
  
512
479
      </para>
513
480
    </informalexample>
514
481
  </refsect1>
515
 
  
 
482
 
516
483
  <refsect1 id="security">
517
484
    <title>SECURITY</title>
518
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
519
486
      <title>SERVER</title>
520
487
      <para>
521
488
        Running this <command>&COMMANDNAME;</command> server program
522
489
        should not in itself present any security risk to the host
523
 
        computer running it.  The program switches to a non-root user
524
 
        soon after startup.
 
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.
525
492
      </para>
526
493
    </refsect2>
527
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
528
495
      <title>CLIENTS</title>
529
496
      <para>
530
497
        The server only gives out its stored data to clients which
537
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
538
505
        <manvolnum>5</manvolnum></citerefentry>)
539
506
        <emphasis>must</emphasis> be made non-readable by anyone
540
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
541
508
      </para>
542
509
      <para>
543
510
        As detailed in <xref linkend="checking"/>, the status of all
562
529
      </para>
563
530
      <para>
564
531
        For more details on client-side security, see
565
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
566
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
567
534
      </para>
568
535
    </refsect2>
569
536
  </refsect1>
570
 
  
 
537
 
571
538
  <refsect1 id="see_also">
572
539
    <title>SEE ALSO</title>
573
540
    <para>
576
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
544
        <refentrytitle>mandos.conf</refentrytitle>
578
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
580
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
582
549
      </citerefentry>