/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-08-31 10:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           Moved long options before
                                           short.

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-01-04">
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
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
 
    <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>
40
60
  </refentryinfo>
41
 
  
 
61
 
42
62
  <refmeta>
43
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
    <manvolnum>8</manvolnum>
50
70
      Gives encrypted passwords to authenticated Mandos clients
51
71
    </refpurpose>
52
72
  </refnamediv>
53
 
  
 
73
 
54
74
  <refsynopsisdiv>
55
75
    <cmdsynopsis>
56
76
      <command>&COMMANDNAME;</command>
85
105
      <replaceable>DIRECTORY</replaceable></option></arg>
86
106
      <sbr/>
87
107
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
108
    </cmdsynopsis>
91
109
    <cmdsynopsis>
92
110
      <command>&COMMANDNAME;</command>
104
122
      <arg choice="plain"><option>--check</option></arg>
105
123
    </cmdsynopsis>
106
124
  </refsynopsisdiv>
107
 
  
 
125
 
108
126
  <refsect1 id="description">
109
127
    <title>DESCRIPTION</title>
110
128
    <para>
119
137
      Any authenticated client is then given the stored pre-encrypted
120
138
      password for that specific client.
121
139
    </para>
 
140
 
122
141
  </refsect1>
123
142
  
124
143
  <refsect1 id="purpose">
125
144
    <title>PURPOSE</title>
 
145
 
126
146
    <para>
127
147
      The purpose of this is to enable <emphasis>remote and unattended
128
148
      rebooting</emphasis> of client host computer with an
129
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
130
150
      linkend="overview"/> for details.
131
151
    </para>
 
152
    
132
153
  </refsect1>
133
154
  
134
155
  <refsect1 id="options">
135
156
    <title>OPTIONS</title>
 
157
    
136
158
    <variablelist>
137
159
      <varlistentry>
138
160
        <term><option>--help</option></term>
190
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
191
213
        </listitem>
192
214
      </varlistentry>
193
 
      
 
215
 
194
216
      <varlistentry>
195
217
        <term><option>--priority <replaceable>
196
218
        PRIORITY</replaceable></option></term>
198
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
199
221
        </listitem>
200
222
      </varlistentry>
201
 
      
 
223
 
202
224
      <varlistentry>
203
225
        <term><option>--servicename
204
226
        <replaceable>NAME</replaceable></option></term>
207
229
                      xpointer="servicename"/>
208
230
        </listitem>
209
231
      </varlistentry>
210
 
      
 
232
 
211
233
      <varlistentry>
212
234
        <term><option>--configdir
213
235
        <replaceable>DIRECTORY</replaceable></option></term>
222
244
          </para>
223
245
        </listitem>
224
246
      </varlistentry>
225
 
      
 
247
 
226
248
      <varlistentry>
227
249
        <term><option>--version</option></term>
228
250
        <listitem>
231
253
          </para>
232
254
        </listitem>
233
255
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--no-dbus</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
239
 
          <para>
240
 
            See also <xref linkend="dbus_interface"/>.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
256
    </variablelist>
245
257
  </refsect1>
246
 
  
 
258
 
247
259
  <refsect1 id="overview">
248
260
    <title>OVERVIEW</title>
249
261
    <xi:include href="overview.xml"/>
250
262
    <para>
251
263
      This program is the server part.  It is a normal server program
252
264
      and will run in a normal system environment, not in an initial
253
 
      <acronym>RAM</acronym> disk environment.
 
265
      RAM disk environment.
254
266
    </para>
255
267
  </refsect1>
256
 
  
 
268
 
257
269
  <refsect1 id="protocol">
258
270
    <title>NETWORK PROTOCOL</title>
259
271
    <para>
311
323
      </row>
312
324
    </tbody></tgroup></table>
313
325
  </refsect1>
314
 
  
 
326
 
315
327
  <refsect1 id="checking">
316
328
    <title>CHECKING</title>
317
329
    <para>
325
337
      <manvolnum>5</manvolnum></citerefentry>.
326
338
    </para>
327
339
  </refsect1>
328
 
  
 
340
 
329
341
  <refsect1 id="logging">
330
342
    <title>LOGGING</title>
331
343
    <para>
335
347
      and also show them on the console.
336
348
    </para>
337
349
  </refsect1>
338
 
  
339
 
  <refsect1 id="dbus_interface">
340
 
    <title>D-BUS INTERFACE</title>
341
 
    <para>
342
 
      The server will by default provide a D-Bus system bus interface.
343
 
      This interface will only be accessible by the root user or a
344
 
      Mandos-specific user, if such a user exists.
345
 
      <!-- XXX -->
346
 
    </para>
347
 
  </refsect1>
348
350
 
349
351
  <refsect1 id="exit_status">
350
352
    <title>EXIT STATUS</title>
353
355
      critical error is encountered.
354
356
    </para>
355
357
  </refsect1>
356
 
  
 
358
 
357
359
  <refsect1 id="environment">
358
360
    <title>ENVIRONMENT</title>
359
361
    <variablelist>
373
375
      </varlistentry>
374
376
    </variablelist>
375
377
  </refsect1>
376
 
  
377
 
  <refsect1 id="files">
 
378
 
 
379
  <refsect1 id="file">
378
380
    <title>FILES</title>
379
381
    <para>
380
382
      Use the <option>--configdir</option> option to change where
403
405
        </listitem>
404
406
      </varlistentry>
405
407
      <varlistentry>
406
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
408
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
407
409
        <listitem>
408
410
          <para>
409
411
            The file containing the process id of
444
446
      Currently, if a client is declared <quote>invalid</quote> due to
445
447
      having timed out, the server does not record this fact onto
446
448
      permanent storage.  This has some security implications, see
447
 
      <xref linkend="clients"/>.
 
449
      <xref linkend="CLIENTS"/>.
448
450
    </para>
449
451
    <para>
450
452
      There is currently no way of querying the server of the current
458
460
      Debug mode is conflated with running in the foreground.
459
461
    </para>
460
462
    <para>
461
 
      The console log messages does not show a time stamp.
462
 
    </para>
463
 
    <para>
464
 
      This server does not check the expire time of clients’ OpenPGP
465
 
      keys.
 
463
      The console log messages does not show a timestamp.
466
464
    </para>
467
465
  </refsect1>
468
466
  
503
501
      </para>
504
502
    </informalexample>
505
503
  </refsect1>
506
 
  
 
504
 
507
505
  <refsect1 id="security">
508
506
    <title>SECURITY</title>
509
 
    <refsect2 id="server">
 
507
    <refsect2 id="SERVER">
510
508
      <title>SERVER</title>
511
509
      <para>
512
510
        Running this <command>&COMMANDNAME;</command> server program
513
511
        should not in itself present any security risk to the host
514
 
        computer running it.  The program switches to a non-root user
515
 
        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.
516
514
      </para>
517
515
    </refsect2>
518
 
    <refsect2 id="clients">
 
516
    <refsect2 id="CLIENTS">
519
517
      <title>CLIENTS</title>
520
518
      <para>
521
519
        The server only gives out its stored data to clients which
528
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
527
        <manvolnum>5</manvolnum></citerefentry>)
530
528
        <emphasis>must</emphasis> be made non-readable by anyone
531
 
        except the user starting the server (usually root).
 
529
        except the user running the server.
532
530
      </para>
533
531
      <para>
534
532
        As detailed in <xref linkend="checking"/>, the status of all
545
543
        restarting servers if it is suspected that a client has, in
546
544
        fact, been compromised by parties who may now be running a
547
545
        fake Mandos client with the keys from the non-encrypted
548
 
        initial <acronym>RAM</acronym> image of the client host.  What
549
 
        should be done in that case (if restarting the server program
550
 
        really is necessary) is to stop the server program, edit the
 
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
551
549
        configuration file to omit any suspect clients, and restart
552
550
        the server program.
553
551
      </para>
554
552
      <para>
555
553
        For more details on client-side security, see
556
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
554
        <citerefentry><refentrytitle>password-request</refentrytitle>
557
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
558
556
      </para>
559
557
    </refsect2>
560
558
  </refsect1>
561
 
  
 
559
 
562
560
  <refsect1 id="see_also">
563
561
    <title>SEE ALSO</title>
564
562
    <para>
567
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
566
        <refentrytitle>mandos.conf</refentrytitle>
569
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
 
        <refentrytitle>mandos-client</refentrytitle>
 
568
        <refentrytitle>password-request</refentrytitle>
571
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
571
      </citerefentry>