/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 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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