/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: Björn Påhlsson
  • Date: 2009-01-01 20:09:00 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 245.
  • Revision ID: belorn@braxen-20090101200900-cz42yvy51d330k0x
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-08-29">
 
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>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </copyright>
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>
 
38
    <xi:include href="legalnotice.xml"/>
60
39
  </refentryinfo>
61
 
 
 
40
  
62
41
  <refmeta>
63
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
43
    <manvolnum>8</manvolnum>
67
46
  <refnamediv>
68
47
    <refname><command>&COMMANDNAME;</command></refname>
69
48
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
49
      Gives encrypted passwords to authenticated Mandos clients
71
50
    </refpurpose>
72
51
  </refnamediv>
73
 
 
 
52
  
74
53
  <refsynopsisdiv>
75
54
    <cmdsynopsis>
76
55
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <arg>--debug</arg>
 
56
      <group>
 
57
        <arg choice="plain"><option>--interface
 
58
        <replaceable>NAME</replaceable></option></arg>
 
59
        <arg choice="plain"><option>-i
 
60
        <replaceable>NAME</replaceable></option></arg>
 
61
      </group>
 
62
      <sbr/>
 
63
      <group>
 
64
        <arg choice="plain"><option>--address
 
65
        <replaceable>ADDRESS</replaceable></option></arg>
 
66
        <arg choice="plain"><option>-a
 
67
        <replaceable>ADDRESS</replaceable></option></arg>
 
68
      </group>
 
69
      <sbr/>
 
70
      <group>
 
71
        <arg choice="plain"><option>--port
 
72
        <replaceable>PORT</replaceable></option></arg>
 
73
        <arg choice="plain"><option>-p
 
74
        <replaceable>PORT</replaceable></option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <arg><option>--priority
 
78
      <replaceable>PRIORITY</replaceable></option></arg>
 
79
      <sbr/>
 
80
      <arg><option>--servicename
 
81
      <replaceable>NAME</replaceable></option></arg>
 
82
      <sbr/>
 
83
      <arg><option>--configdir
 
84
      <replaceable>DIRECTORY</replaceable></option></arg>
 
85
      <sbr/>
 
86
      <arg><option>--debug</option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--no-dbus</option></arg>
94
89
    </cmdsynopsis>
95
90
    <cmdsynopsis>
96
91
      <command>&COMMANDNAME;</command>
97
92
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
93
        <arg choice="plain"><option>--help</option></arg>
 
94
        <arg choice="plain"><option>-h</option></arg>
100
95
      </group>
101
96
    </cmdsynopsis>
102
97
    <cmdsynopsis>
103
98
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
99
      <arg choice="plain"><option>--version</option></arg>
105
100
    </cmdsynopsis>
106
101
    <cmdsynopsis>
107
102
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
103
      <arg choice="plain"><option>--check</option></arg>
109
104
    </cmdsynopsis>
110
105
  </refsynopsisdiv>
111
 
 
 
106
  
112
107
  <refsect1 id="description">
113
108
    <title>DESCRIPTION</title>
114
109
    <para>
123
118
      Any authenticated client is then given the stored pre-encrypted
124
119
      password for that specific client.
125
120
    </para>
126
 
 
127
121
  </refsect1>
128
122
  
129
123
  <refsect1 id="purpose">
130
124
    <title>PURPOSE</title>
131
 
 
132
125
    <para>
133
126
      The purpose of this is to enable <emphasis>remote and unattended
134
127
      rebooting</emphasis> of client host computer with an
135
128
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
129
      linkend="overview"/> for details.
137
130
    </para>
138
 
 
139
131
  </refsect1>
140
132
  
141
133
  <refsect1 id="options">
142
134
    <title>OPTIONS</title>
143
 
 
144
135
    <variablelist>
145
136
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
137
        <term><option>--help</option></term>
 
138
        <term><option>-h</option></term>
147
139
        <listitem>
148
140
          <para>
149
141
            Show a help message and exit
150
142
          </para>
151
143
        </listitem>
152
144
      </varlistentry>
153
 
 
 
145
      
154
146
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
147
        <term><option>--interface</option>
 
148
        <replaceable>NAME</replaceable></term>
 
149
        <term><option>-i</option>
 
150
        <replaceable>NAME</replaceable></term>
157
151
        <listitem>
158
152
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
153
        </listitem>
160
154
      </varlistentry>
161
 
 
 
155
      
162
156
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
157
        <term><option>--address
 
158
        <replaceable>ADDRESS</replaceable></option></term>
 
159
        <term><option>-a
 
160
        <replaceable>ADDRESS</replaceable></option></term>
165
161
        <listitem>
166
162
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
163
        </listitem>
168
164
      </varlistentry>
169
 
 
 
165
      
170
166
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
167
        <term><option>--port
 
168
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><option>-p
 
170
        <replaceable>PORT</replaceable></option></term>
173
171
        <listitem>
174
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
173
        </listitem>
176
174
      </varlistentry>
177
 
 
 
175
      
178
176
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
177
        <term><option>--check</option></term>
180
178
        <listitem>
181
179
          <para>
182
180
            Run the server’s self-tests.  This includes any unit
184
182
          </para>
185
183
        </listitem>
186
184
      </varlistentry>
187
 
 
 
185
      
188
186
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
187
        <term><option>--debug</option></term>
190
188
        <listitem>
191
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
190
        </listitem>
193
191
      </varlistentry>
194
 
 
 
192
      
195
193
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
194
        <term><option>--priority <replaceable>
 
195
        PRIORITY</replaceable></option></term>
198
196
        <listitem>
199
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
198
        </listitem>
201
199
      </varlistentry>
202
 
 
 
200
      
203
201
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
202
        <term><option>--servicename
 
203
        <replaceable>NAME</replaceable></option></term>
206
204
        <listitem>
207
205
          <xi:include href="mandos-options.xml"
208
206
                      xpointer="servicename"/>
209
207
        </listitem>
210
208
      </varlistentry>
211
 
 
 
209
      
212
210
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
211
        <term><option>--configdir
 
212
        <replaceable>DIRECTORY</replaceable></option></term>
215
213
        <listitem>
216
214
          <para>
217
215
            Directory to search for configuration files.  Default is
223
221
          </para>
224
222
        </listitem>
225
223
      </varlistentry>
226
 
 
 
224
      
227
225
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
226
        <term><option>--version</option></term>
229
227
        <listitem>
230
228
          <para>
231
229
            Prints the program version and exit.
232
230
          </para>
233
231
        </listitem>
234
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>
235
242
    </variablelist>
236
243
  </refsect1>
237
 
 
 
244
  
238
245
  <refsect1 id="overview">
239
246
    <title>OVERVIEW</title>
240
247
    <xi:include href="overview.xml"/>
241
248
    <para>
242
249
      This program is the server part.  It is a normal server program
243
250
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
251
      <acronym>RAM</acronym> disk environment.
245
252
    </para>
246
253
  </refsect1>
247
 
 
 
254
  
248
255
  <refsect1 id="protocol">
249
256
    <title>NETWORK PROTOCOL</title>
250
257
    <para>
302
309
      </row>
303
310
    </tbody></tgroup></table>
304
311
  </refsect1>
305
 
 
 
312
  
306
313
  <refsect1 id="checking">
307
314
    <title>CHECKING</title>
308
315
    <para>
316
323
      <manvolnum>5</manvolnum></citerefentry>.
317
324
    </para>
318
325
  </refsect1>
319
 
 
 
326
  
320
327
  <refsect1 id="logging">
321
328
    <title>LOGGING</title>
322
329
    <para>
326
333
      and also show them on the console.
327
334
    </para>
328
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>
329
346
 
330
347
  <refsect1 id="exit_status">
331
348
    <title>EXIT STATUS</title>
334
351
      critical error is encountered.
335
352
    </para>
336
353
  </refsect1>
337
 
 
 
354
  
338
355
  <refsect1 id="environment">
339
356
    <title>ENVIRONMENT</title>
340
357
    <variablelist>
341
358
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
359
        <term><envar>PATH</envar></term>
343
360
        <listitem>
344
361
          <para>
345
362
            To start the configured checker (see <xref
354
371
      </varlistentry>
355
372
    </variablelist>
356
373
  </refsect1>
357
 
 
358
 
  <refsect1 id="file">
 
374
  
 
375
  <refsect1 id="files">
359
376
    <title>FILES</title>
360
377
    <para>
361
378
      Use the <option>--configdir</option> option to change where
384
401
        </listitem>
385
402
      </varlistentry>
386
403
      <varlistentry>
387
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
404
        <term><filename>/var/run/mandos.pid</filename></term>
388
405
        <listitem>
389
406
          <para>
390
407
            The file containing the process id of
425
442
      Currently, if a client is declared <quote>invalid</quote> due to
426
443
      having timed out, the server does not record this fact onto
427
444
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
 
445
      <xref linkend="clients"/>.
429
446
    </para>
430
447
    <para>
431
448
      There is currently no way of querying the server of the current
439
456
      Debug mode is conflated with running in the foreground.
440
457
    </para>
441
458
    <para>
442
 
      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.
443
464
    </para>
444
465
  </refsect1>
445
466
  
480
501
      </para>
481
502
    </informalexample>
482
503
  </refsect1>
483
 
 
 
504
  
484
505
  <refsect1 id="security">
485
506
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
507
    <refsect2 id="server">
487
508
      <title>SERVER</title>
488
509
      <para>
489
510
        Running this <command>&COMMANDNAME;</command> server program
490
511
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        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.
493
514
      </para>
494
515
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
516
    <refsect2 id="clients">
496
517
      <title>CLIENTS</title>
497
518
      <para>
498
519
        The server only gives out its stored data to clients which
505
526
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
527
        <manvolnum>5</manvolnum></citerefentry>)
507
528
        <emphasis>must</emphasis> be made non-readable by anyone
508
 
        except the user running the server.
 
529
        except the user starting the server (usually root).
509
530
      </para>
510
531
      <para>
511
532
        As detailed in <xref linkend="checking"/>, the status of all
522
543
        restarting servers if it is suspected that a client has, in
523
544
        fact, been compromised by parties who may now be running a
524
545
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
 
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
528
549
        configuration file to omit any suspect clients, and restart
529
550
        the server program.
530
551
      </para>
531
552
      <para>
532
553
        For more details on client-side security, see
533
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
554
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
555
        <manvolnum>8mandos</manvolnum></citerefentry>.
535
556
      </para>
536
557
    </refsect2>
537
558
  </refsect1>
538
 
 
 
559
  
539
560
  <refsect1 id="see_also">
540
561
    <title>SEE ALSO</title>
541
562
    <para>
544
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
566
        <refentrytitle>mandos.conf</refentrytitle>
546
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>password-request</refentrytitle>
 
568
        <refentrytitle>mandos-client</refentrytitle>
548
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
571
      </citerefentry>