/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: 2008-08-31 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

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 "2011-02-27">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
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
 
      <year>2010</year>
37
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <xi:include href="legalnotice.xml"/>
 
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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
52
70
      Gives encrypted passwords to authenticated Mandos clients
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
87
105
      <replaceable>DIRECTORY</replaceable></option></arg>
88
106
      <sbr/>
89
107
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
108
    </cmdsynopsis>
98
109
    <cmdsynopsis>
99
110
      <command>&COMMANDNAME;</command>
111
122
      <arg choice="plain"><option>--check</option></arg>
112
123
    </cmdsynopsis>
113
124
  </refsynopsisdiv>
114
 
  
 
125
 
115
126
  <refsect1 id="description">
116
127
    <title>DESCRIPTION</title>
117
128
    <para>
126
137
      Any authenticated client is then given the stored pre-encrypted
127
138
      password for that specific client.
128
139
    </para>
 
140
 
129
141
  </refsect1>
130
142
  
131
143
  <refsect1 id="purpose">
132
144
    <title>PURPOSE</title>
 
145
 
133
146
    <para>
134
147
      The purpose of this is to enable <emphasis>remote and unattended
135
148
      rebooting</emphasis> of client host computer with an
136
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
137
150
      linkend="overview"/> for details.
138
151
    </para>
 
152
    
139
153
  </refsect1>
140
154
  
141
155
  <refsect1 id="options">
142
156
    <title>OPTIONS</title>
 
157
    
143
158
    <variablelist>
144
159
      <varlistentry>
145
160
        <term><option>--help</option></term>
197
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
198
213
        </listitem>
199
214
      </varlistentry>
200
 
      
201
 
      <varlistentry>
202
 
        <term><option>--debuglevel
203
 
        <replaceable>LEVEL</replaceable></option></term>
204
 
        <listitem>
205
 
          <para>
206
 
            Set the debugging log level.
207
 
            <replaceable>LEVEL</replaceable> is a string, one of
208
 
            <quote><literal>CRITICAL</literal></quote>,
209
 
            <quote><literal>ERROR</literal></quote>,
210
 
            <quote><literal>WARNING</literal></quote>,
211
 
            <quote><literal>INFO</literal></quote>, or
212
 
            <quote><literal>DEBUG</literal></quote>, in order of
213
 
            increasing verbosity.  The default level is
214
 
            <quote><literal>WARNING</literal></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
 
215
 
219
216
      <varlistentry>
220
217
        <term><option>--priority <replaceable>
221
218
        PRIORITY</replaceable></option></term>
223
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
224
221
        </listitem>
225
222
      </varlistentry>
226
 
      
 
223
 
227
224
      <varlistentry>
228
225
        <term><option>--servicename
229
226
        <replaceable>NAME</replaceable></option></term>
232
229
                      xpointer="servicename"/>
233
230
        </listitem>
234
231
      </varlistentry>
235
 
      
 
232
 
236
233
      <varlistentry>
237
234
        <term><option>--configdir
238
235
        <replaceable>DIRECTORY</replaceable></option></term>
247
244
          </para>
248
245
        </listitem>
249
246
      </varlistentry>
250
 
      
 
247
 
251
248
      <varlistentry>
252
249
        <term><option>--version</option></term>
253
250
        <listitem>
256
253
          </para>
257
254
        </listitem>
258
255
      </varlistentry>
259
 
      
260
 
      <varlistentry>
261
 
        <term><option>--no-dbus</option></term>
262
 
        <listitem>
263
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
264
 
          <para>
265
 
            See also <xref linkend="dbus_interface"/>.
266
 
          </para>
267
 
        </listitem>
268
 
      </varlistentry>
269
 
      
270
 
      <varlistentry>
271
 
        <term><option>--no-ipv6</option></term>
272
 
        <listitem>
273
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
 
        </listitem>
275
 
      </varlistentry>
276
256
    </variablelist>
277
257
  </refsect1>
278
 
  
 
258
 
279
259
  <refsect1 id="overview">
280
260
    <title>OVERVIEW</title>
281
261
    <xi:include href="overview.xml"/>
282
262
    <para>
283
263
      This program is the server part.  It is a normal server program
284
264
      and will run in a normal system environment, not in an initial
285
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
286
266
    </para>
287
267
  </refsect1>
288
 
  
 
268
 
289
269
  <refsect1 id="protocol">
290
270
    <title>NETWORK PROTOCOL</title>
291
271
    <para>
343
323
      </row>
344
324
    </tbody></tgroup></table>
345
325
  </refsect1>
346
 
  
 
326
 
347
327
  <refsect1 id="checking">
348
328
    <title>CHECKING</title>
349
329
    <para>
350
330
      The server will, by default, continually check that the clients
351
331
      are still up.  If a client has not been confirmed as being up
352
332
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  (Manual
354
 
      intervention is required to re-enable a client.)  The timeout,
 
333
      longer eligible to receive the encrypted password.  The timeout,
355
334
      checker program, and interval between checks can be configured
356
335
      both globally and per client; see <citerefentry>
357
336
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="approval">
365
 
    <title>APPROVAL</title>
366
 
    <para>
367
 
      The server can be configured to require manual approval for a
368
 
      client before it is sent its secret.  The delay to wait for such
369
 
      approval and the default action (approve or deny) can be
370
 
      configured both globally and per client; see <citerefentry>
371
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
372
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
373
 
      will be approved immediately without delay.
374
 
    </para>
375
 
    <para>
376
 
      This can be used to deny a client its secret if not manually
377
 
      approved within a specified time.  It can also be used to make
378
 
      the server delay before giving a client its secret, allowing
379
 
      optional manual denying of this specific client.
380
 
    </para>
381
 
    
382
 
  </refsect1>
383
 
  
 
337
      <manvolnum>5</manvolnum></citerefentry>.
 
338
    </para>
 
339
  </refsect1>
 
340
 
384
341
  <refsect1 id="logging">
385
342
    <title>LOGGING</title>
386
343
    <para>
390
347
      and also show them on the console.
391
348
    </para>
392
349
  </refsect1>
393
 
  
394
 
  <refsect1 id="dbus_interface">
395
 
    <title>D-BUS INTERFACE</title>
396
 
    <para>
397
 
      The server will by default provide a D-Bus system bus interface.
398
 
      This interface will only be accessible by the root user or a
399
 
      Mandos-specific user, if such a user exists.  For documentation
400
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
401
 
    </para>
402
 
  </refsect1>
403
 
  
 
350
 
404
351
  <refsect1 id="exit_status">
405
352
    <title>EXIT STATUS</title>
406
353
    <para>
408
355
      critical error is encountered.
409
356
    </para>
410
357
  </refsect1>
411
 
  
 
358
 
412
359
  <refsect1 id="environment">
413
360
    <title>ENVIRONMENT</title>
414
361
    <variablelist>
428
375
      </varlistentry>
429
376
    </variablelist>
430
377
  </refsect1>
431
 
  
432
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
433
380
    <title>FILES</title>
434
381
    <para>
435
382
      Use the <option>--configdir</option> option to change where
458
405
        </listitem>
459
406
      </varlistentry>
460
407
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
462
409
        <listitem>
463
410
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
411
            The file containing the process id of
 
412
            <command>&COMMANDNAME;</command>.
466
413
          </para>
467
414
        </listitem>
468
415
      </varlistentry>
496
443
      backtrace.  This could be considered a feature.
497
444
    </para>
498
445
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
 
446
      Currently, if a client is declared <quote>invalid</quote> due to
 
447
      having timed out, the server does not record this fact onto
 
448
      permanent storage.  This has some security implications, see
 
449
      <xref linkend="CLIENTS"/>.
 
450
    </para>
 
451
    <para>
 
452
      There is currently no way of querying the server of the current
 
453
      status of clients, other than analyzing its <systemitem
 
454
      class="service">syslog</systemitem> output.
502
455
    </para>
503
456
    <para>
504
457
      There is no fine-grained control over logging and debug output.
507
460
      Debug mode is conflated with running in the foreground.
508
461
    </para>
509
462
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
 
      This server does not check the expire time of clients’ OpenPGP
514
 
      keys.
 
463
      The console log messages does not show a timestamp.
515
464
    </para>
516
465
  </refsect1>
517
466
  
552
501
      </para>
553
502
    </informalexample>
554
503
  </refsect1>
555
 
  
 
504
 
556
505
  <refsect1 id="security">
557
506
    <title>SECURITY</title>
558
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
559
508
      <title>SERVER</title>
560
509
      <para>
561
510
        Running this <command>&COMMANDNAME;</command> server program
562
511
        should not in itself present any security risk to the host
563
 
        computer running it.  The program switches to a non-root user
564
 
        soon after startup.
 
512
        computer running it.  The program does not need any special
 
513
        privileges to run, and is designed to run as a non-root user.
565
514
      </para>
566
515
    </refsect2>
567
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
568
517
      <title>CLIENTS</title>
569
518
      <para>
570
519
        The server only gives out its stored data to clients which
577
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
578
527
        <manvolnum>5</manvolnum></citerefentry>)
579
528
        <emphasis>must</emphasis> be made non-readable by anyone
580
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
581
530
      </para>
582
531
      <para>
583
532
        As detailed in <xref linkend="checking"/>, the status of all
586
535
      </para>
587
536
      <para>
588
537
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
 
538
        by the server which would therefore declare the client
 
539
        invalid.  But if the server was ever restarted, it would
 
540
        re-read its client list from its configuration file and again
 
541
        regard all clients therein as valid, and hence eligible to
 
542
        receive their passwords.  Therefore, be careful when
 
543
        restarting servers if it is suspected that a client has, in
 
544
        fact, been compromised by parties who may now be running a
 
545
        fake Mandos client with the keys from the non-encrypted
 
546
        initial RAM image of the client host.  What should be done in
 
547
        that case (if restarting the server program really is
 
548
        necessary) is to stop the server program, edit the
 
549
        configuration file to omit any suspect clients, and restart
 
550
        the server program.
601
551
      </para>
602
552
      <para>
603
553
        For more details on client-side security, see
604
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
605
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
606
556
      </para>
607
557
    </refsect2>
608
558
  </refsect1>
609
 
  
 
559
 
610
560
  <refsect1 id="see_also">
611
561
    <title>SEE ALSO</title>
612
562
    <para>
615
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
566
        <refentrytitle>mandos.conf</refentrytitle>
617
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
 
568
        <refentrytitle>password-request</refentrytitle>
619
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
571
      </citerefentry>