/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-29 07:09:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829070904-i6u8xb0aueytvfii
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
                                                          "Mandos
                                                          Manual".

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