/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-02-15">
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>
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>
47
67
  <refnamediv>
48
68
    <refname><command>&COMMANDNAME;</command></refname>
49
69
    <refpurpose>
50
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends 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>
57
 
      <group>
58
 
        <arg choice="plain"><option>--interface
59
 
        <replaceable>NAME</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-i
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--address
66
 
        <replaceable>ADDRESS</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-a
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--port
73
 
        <replaceable>PORT</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-p
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <arg><option>--priority
79
 
      <replaceable>PRIORITY</replaceable></option></arg>
80
 
      <sbr/>
81
 
      <arg><option>--servicename
82
 
      <replaceable>NAME</replaceable></option></arg>
83
 
      <sbr/>
84
 
      <arg><option>--configdir
85
 
      <replaceable>DIRECTORY</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</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>
92
94
    </cmdsynopsis>
93
95
    <cmdsynopsis>
94
96
      <command>&COMMANDNAME;</command>
95
97
      <group choice="req">
96
 
        <arg choice="plain"><option>--help</option></arg>
97
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
98
100
      </group>
99
101
    </cmdsynopsis>
100
102
    <cmdsynopsis>
101
103
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
103
105
    </cmdsynopsis>
104
106
    <cmdsynopsis>
105
107
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
107
109
    </cmdsynopsis>
108
110
  </refsynopsisdiv>
109
 
  
 
111
 
110
112
  <refsect1 id="description">
111
113
    <title>DESCRIPTION</title>
112
114
    <para>
121
123
      Any authenticated client is then given the stored pre-encrypted
122
124
      password for that specific client.
123
125
    </para>
 
126
 
124
127
  </refsect1>
125
128
  
126
129
  <refsect1 id="purpose">
127
130
    <title>PURPOSE</title>
 
131
 
128
132
    <para>
129
133
      The purpose of this is to enable <emphasis>remote and unattended
130
134
      rebooting</emphasis> of client host computer with an
131
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
136
      linkend="overview"/> for details.
133
137
    </para>
 
138
 
134
139
  </refsect1>
135
140
  
136
141
  <refsect1 id="options">
137
142
    <title>OPTIONS</title>
 
143
 
138
144
    <variablelist>
139
145
      <varlistentry>
140
 
        <term><option>--help</option></term>
141
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
142
147
        <listitem>
143
148
          <para>
144
149
            Show a help message and exit
145
150
          </para>
146
151
        </listitem>
147
152
      </varlistentry>
148
 
      
 
153
 
149
154
      <varlistentry>
150
 
        <term><option>--interface</option>
151
 
        <replaceable>NAME</replaceable></term>
152
 
        <term><option>-i</option>
153
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
154
157
        <listitem>
155
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
156
159
        </listitem>
157
160
      </varlistentry>
158
 
      
 
161
 
159
162
      <varlistentry>
160
 
        <term><option>--address
161
 
        <replaceable>ADDRESS</replaceable></option></term>
162
 
        <term><option>-a
163
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
164
165
        <listitem>
165
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
166
167
        </listitem>
167
168
      </varlistentry>
168
 
      
 
169
 
169
170
      <varlistentry>
170
 
        <term><option>--port
171
 
        <replaceable>PORT</replaceable></option></term>
172
 
        <term><option>-p
173
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
174
173
        <listitem>
175
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
176
175
        </listitem>
177
176
      </varlistentry>
178
 
      
 
177
 
179
178
      <varlistentry>
180
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
181
180
        <listitem>
182
181
          <para>
183
182
            Run the server’s self-tests.  This includes any unit
185
184
          </para>
186
185
        </listitem>
187
186
      </varlistentry>
188
 
      
 
187
 
189
188
      <varlistentry>
190
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
191
190
        <listitem>
192
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
193
192
        </listitem>
194
193
      </varlistentry>
195
 
      
 
194
 
196
195
      <varlistentry>
197
 
        <term><option>--priority <replaceable>
198
 
        PRIORITY</replaceable></option></term>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
199
198
        <listitem>
200
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
201
200
        </listitem>
202
201
      </varlistentry>
203
 
      
 
202
 
204
203
      <varlistentry>
205
 
        <term><option>--servicename
206
 
        <replaceable>NAME</replaceable></option></term>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
207
206
        <listitem>
208
207
          <xi:include href="mandos-options.xml"
209
208
                      xpointer="servicename"/>
210
209
        </listitem>
211
210
      </varlistentry>
212
 
      
 
211
 
213
212
      <varlistentry>
214
 
        <term><option>--configdir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
216
215
        <listitem>
217
216
          <para>
218
217
            Directory to search for configuration files.  Default is
224
223
          </para>
225
224
        </listitem>
226
225
      </varlistentry>
227
 
      
 
226
 
228
227
      <varlistentry>
229
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
230
229
        <listitem>
231
230
          <para>
232
231
            Prints the program version and exit.
233
232
          </para>
234
233
        </listitem>
235
234
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
235
    </variablelist>
254
236
  </refsect1>
255
 
  
 
237
 
256
238
  <refsect1 id="overview">
257
239
    <title>OVERVIEW</title>
258
240
    <xi:include href="overview.xml"/>
259
241
    <para>
260
242
      This program is the server part.  It is a normal server program
261
243
      and will run in a normal system environment, not in an initial
262
 
      <acronym>RAM</acronym> disk environment.
 
244
      RAM disk environment.
263
245
    </para>
264
246
  </refsect1>
265
 
  
 
247
 
266
248
  <refsect1 id="protocol">
267
249
    <title>NETWORK PROTOCOL</title>
268
250
    <para>
320
302
      </row>
321
303
    </tbody></tgroup></table>
322
304
  </refsect1>
323
 
  
 
305
 
324
306
  <refsect1 id="checking">
325
307
    <title>CHECKING</title>
326
308
    <para>
334
316
      <manvolnum>5</manvolnum></citerefentry>.
335
317
    </para>
336
318
  </refsect1>
337
 
  
 
319
 
338
320
  <refsect1 id="logging">
339
321
    <title>LOGGING</title>
340
322
    <para>
344
326
      and also show them on the console.
345
327
    </para>
346
328
  </refsect1>
347
 
  
348
 
  <refsect1 id="dbus_interface">
349
 
    <title>D-BUS INTERFACE</title>
350
 
    <para>
351
 
      The server will by default provide a D-Bus system bus interface.
352
 
      This interface will only be accessible by the root user or a
353
 
      Mandos-specific user, if such a user exists.
354
 
      <!-- XXX -->
355
 
    </para>
356
 
  </refsect1>
357
 
  
 
329
 
358
330
  <refsect1 id="exit_status">
359
331
    <title>EXIT STATUS</title>
360
332
    <para>
362
334
      critical error is encountered.
363
335
    </para>
364
336
  </refsect1>
365
 
  
 
337
 
366
338
  <refsect1 id="environment">
367
339
    <title>ENVIRONMENT</title>
368
340
    <variablelist>
369
341
      <varlistentry>
370
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
371
343
        <listitem>
372
344
          <para>
373
345
            To start the configured checker (see <xref
382
354
      </varlistentry>
383
355
    </variablelist>
384
356
  </refsect1>
385
 
  
386
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
387
359
    <title>FILES</title>
388
360
    <para>
389
361
      Use the <option>--configdir</option> option to change where
412
384
        </listitem>
413
385
      </varlistentry>
414
386
      <varlistentry>
415
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
416
388
        <listitem>
417
389
          <para>
418
390
            The file containing the process id of
453
425
      Currently, if a client is declared <quote>invalid</quote> due to
454
426
      having timed out, the server does not record this fact onto
455
427
      permanent storage.  This has some security implications, see
456
 
      <xref linkend="clients"/>.
 
428
      <xref linkend="CLIENTS"/>.
457
429
    </para>
458
430
    <para>
459
431
      There is currently no way of querying the server of the current
467
439
      Debug mode is conflated with running in the foreground.
468
440
    </para>
469
441
    <para>
470
 
      The console log messages do not show a time stamp.
471
 
    </para>
472
 
    <para>
473
 
      This server does not check the expire time of clients’ OpenPGP
474
 
      keys.
 
442
      The console log messages does not show a timestamp.
475
443
    </para>
476
444
  </refsect1>
477
445
  
512
480
      </para>
513
481
    </informalexample>
514
482
  </refsect1>
515
 
  
 
483
 
516
484
  <refsect1 id="security">
517
485
    <title>SECURITY</title>
518
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
519
487
      <title>SERVER</title>
520
488
      <para>
521
489
        Running this <command>&COMMANDNAME;</command> server program
522
490
        should not in itself present any security risk to the host
523
 
        computer running it.  The program switches to a non-root user
524
 
        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.
525
493
      </para>
526
494
    </refsect2>
527
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
528
496
      <title>CLIENTS</title>
529
497
      <para>
530
498
        The server only gives out its stored data to clients which
537
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
538
506
        <manvolnum>5</manvolnum></citerefentry>)
539
507
        <emphasis>must</emphasis> be made non-readable by anyone
540
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
541
509
      </para>
542
510
      <para>
543
511
        As detailed in <xref linkend="checking"/>, the status of all
554
522
        restarting servers if it is suspected that a client has, in
555
523
        fact, been compromised by parties who may now be running a
556
524
        fake Mandos client with the keys from the non-encrypted
557
 
        initial <acronym>RAM</acronym> image of the client host.  What
558
 
        should be done in that case (if restarting the server program
559
 
        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
560
528
        configuration file to omit any suspect clients, and restart
561
529
        the server program.
562
530
      </para>
563
531
      <para>
564
532
        For more details on client-side security, see
565
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
566
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
567
535
      </para>
568
536
    </refsect2>
569
537
  </refsect1>
570
 
  
 
538
 
571
539
  <refsect1 id="see_also">
572
540
    <title>SEE ALSO</title>
573
541
    <para>
574
542
      <citerefentry>
 
543
        <refentrytitle>mandos.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
545
        <refentrytitle>mandos-clients.conf</refentrytitle>
576
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
 
        <refentrytitle>mandos.conf</refentrytitle>
578
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
 
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <refentrytitle>password-request</refentrytitle>
580
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
582
550
      </citerefentry>