/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-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

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 "2010-09-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
32
      <holder>Teddy Hogeborn</holder>
38
33
      <holder>Björn Påhlsson</holder>
39
34
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
41
58
  </refentryinfo>
42
 
  
 
59
 
43
60
  <refmeta>
44
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
62
    <manvolnum>8</manvolnum>
48
65
  <refnamediv>
49
66
    <refname><command>&COMMANDNAME;</command></refname>
50
67
    <refpurpose>
51
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
52
69
    </refpurpose>
53
70
  </refnamediv>
54
 
  
 
71
 
55
72
  <refsynopsisdiv>
56
73
    <cmdsynopsis>
57
74
      <command>&COMMANDNAME;</command>
58
 
      <group>
59
 
        <arg choice="plain"><option>--interface
60
 
        <replaceable>NAME</replaceable></option></arg>
61
 
        <arg choice="plain"><option>-i
62
 
        <replaceable>NAME</replaceable></option></arg>
63
 
      </group>
64
 
      <sbr/>
65
 
      <group>
66
 
        <arg choice="plain"><option>--address
67
 
        <replaceable>ADDRESS</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-a
69
 
        <replaceable>ADDRESS</replaceable></option></arg>
70
 
      </group>
71
 
      <sbr/>
72
 
      <group>
73
 
        <arg choice="plain"><option>--port
74
 
        <replaceable>PORT</replaceable></option></arg>
75
 
        <arg choice="plain"><option>-p
76
 
        <replaceable>PORT</replaceable></option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <arg><option>--priority
80
 
      <replaceable>PRIORITY</replaceable></option></arg>
81
 
      <sbr/>
82
 
      <arg><option>--servicename
83
 
      <replaceable>NAME</replaceable></option></arg>
84
 
      <sbr/>
85
 
      <arg><option>--configdir
86
 
      <replaceable>DIRECTORY</replaceable></option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--debug</option></arg>
89
 
      <sbr/>
90
 
      <arg><option>--debuglevel
91
 
      <replaceable>LEVEL</replaceable></option></arg>
92
 
      <sbr/>
93
 
      <arg><option>--no-dbus</option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--no-ipv6</option></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
79
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
80
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
81
      <arg>--debug</arg>
 
82
    </cmdsynopsis>
 
83
    <cmdsynopsis>
 
84
      <command>&COMMANDNAME;</command>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
 
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
89
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
90
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
91
      <arg>--debug</arg>
96
92
    </cmdsynopsis>
97
93
    <cmdsynopsis>
98
94
      <command>&COMMANDNAME;</command>
99
95
      <group choice="req">
100
 
        <arg choice="plain"><option>--help</option></arg>
101
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
102
98
      </group>
103
99
    </cmdsynopsis>
104
100
    <cmdsynopsis>
105
101
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
107
103
    </cmdsynopsis>
108
104
    <cmdsynopsis>
109
105
      <command>&COMMANDNAME;</command>
110
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
111
107
    </cmdsynopsis>
112
108
  </refsynopsisdiv>
113
 
  
 
109
 
114
110
  <refsect1 id="description">
115
111
    <title>DESCRIPTION</title>
116
112
    <para>
125
121
      Any authenticated client is then given the stored pre-encrypted
126
122
      password for that specific client.
127
123
    </para>
 
124
 
128
125
  </refsect1>
129
126
  
130
127
  <refsect1 id="purpose">
131
128
    <title>PURPOSE</title>
 
129
 
132
130
    <para>
133
131
      The purpose of this is to enable <emphasis>remote and unattended
134
132
      rebooting</emphasis> of client host computer with an
135
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
134
      linkend="overview"/> for details.
137
135
    </para>
 
136
 
138
137
  </refsect1>
139
138
  
140
139
  <refsect1 id="options">
141
140
    <title>OPTIONS</title>
 
141
 
142
142
    <variablelist>
143
143
      <varlistentry>
144
 
        <term><option>--help</option></term>
145
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
146
145
        <listitem>
147
146
          <para>
148
147
            Show a help message and exit
149
148
          </para>
150
149
        </listitem>
151
150
      </varlistentry>
152
 
      
 
151
 
153
152
      <varlistentry>
154
 
        <term><option>--interface</option>
155
 
        <replaceable>NAME</replaceable></term>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
158
155
        <listitem>
159
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
160
157
        </listitem>
161
158
      </varlistentry>
162
 
      
 
159
 
163
160
      <varlistentry>
164
 
        <term><option>--address
165
 
        <replaceable>ADDRESS</replaceable></option></term>
166
 
        <term><option>-a
167
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
168
163
        <listitem>
169
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
165
        </listitem>
171
166
      </varlistentry>
172
 
      
 
167
 
173
168
      <varlistentry>
174
 
        <term><option>--port
175
 
        <replaceable>PORT</replaceable></option></term>
176
 
        <term><option>-p
177
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
178
171
        <listitem>
179
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
180
173
        </listitem>
181
174
      </varlistentry>
182
 
      
 
175
 
183
176
      <varlistentry>
184
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
185
178
        <listitem>
186
179
          <para>
187
180
            Run the server’s self-tests.  This includes any unit
189
182
          </para>
190
183
        </listitem>
191
184
      </varlistentry>
192
 
      
 
185
 
193
186
      <varlistentry>
194
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
195
188
        <listitem>
196
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
197
190
        </listitem>
198
191
      </varlistentry>
199
 
      
200
 
      <varlistentry>
201
 
        <term><option>--debuglevel
202
 
        <replaceable>LEVEL</replaceable></option></term>
203
 
        <listitem>
204
 
          <para>
205
 
            Set the debugging log level.
206
 
            <replaceable>LEVEL</replaceable> is a string, one of
207
 
            <quote><literal>CRITICAL</literal></quote>,
208
 
            <quote><literal>ERROR</literal></quote>,
209
 
            <quote><literal>WARNING</literal></quote>,
210
 
            <quote><literal>INFO</literal></quote>, or
211
 
            <quote><literal>DEBUG</literal></quote>, in order of
212
 
            increasing verbosity.  The default level is
213
 
            <quote><literal>WARNING</literal></quote>.
214
 
          </para>
215
 
        </listitem>
216
 
      </varlistentry>
217
 
      
218
 
      <varlistentry>
219
 
        <term><option>--priority <replaceable>
220
 
        PRIORITY</replaceable></option></term>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
221
196
        <listitem>
222
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
223
198
        </listitem>
224
199
      </varlistentry>
225
 
      
 
200
 
226
201
      <varlistentry>
227
 
        <term><option>--servicename
228
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
229
204
        <listitem>
230
205
          <xi:include href="mandos-options.xml"
231
206
                      xpointer="servicename"/>
232
207
        </listitem>
233
208
      </varlistentry>
234
 
      
 
209
 
235
210
      <varlistentry>
236
 
        <term><option>--configdir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
238
213
        <listitem>
239
214
          <para>
240
215
            Directory to search for configuration files.  Default is
246
221
          </para>
247
222
        </listitem>
248
223
      </varlistentry>
249
 
      
 
224
 
250
225
      <varlistentry>
251
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
252
227
        <listitem>
253
228
          <para>
254
229
            Prints the program version and exit.
255
230
          </para>
256
231
        </listitem>
257
232
      </varlistentry>
258
 
      
259
 
      <varlistentry>
260
 
        <term><option>--no-dbus</option></term>
261
 
        <listitem>
262
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
263
 
          <para>
264
 
            See also <xref linkend="dbus_interface"/>.
265
 
          </para>
266
 
        </listitem>
267
 
      </varlistentry>
268
 
      
269
 
      <varlistentry>
270
 
        <term><option>--no-ipv6</option></term>
271
 
        <listitem>
272
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
 
        </listitem>
274
 
      </varlistentry>
275
233
    </variablelist>
276
234
  </refsect1>
277
 
  
 
235
 
278
236
  <refsect1 id="overview">
279
237
    <title>OVERVIEW</title>
280
238
    <xi:include href="overview.xml"/>
281
239
    <para>
282
240
      This program is the server part.  It is a normal server program
283
241
      and will run in a normal system environment, not in an initial
284
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
285
243
    </para>
286
244
  </refsect1>
287
 
  
 
245
 
288
246
  <refsect1 id="protocol">
289
247
    <title>NETWORK PROTOCOL</title>
290
248
    <para>
316
274
        <entry>-><!-- &rarr; --></entry>
317
275
      </row>
318
276
      <row>
319
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\en</literal></quote></entry>
320
278
        <entry>-><!-- &rarr; --></entry>
321
279
      </row>
322
280
      <row>
342
300
      </row>
343
301
    </tbody></tgroup></table>
344
302
  </refsect1>
345
 
  
 
303
 
346
304
  <refsect1 id="checking">
347
305
    <title>CHECKING</title>
348
306
    <para>
349
307
      The server will, by default, continually check that the clients
350
308
      are still up.  If a client has not been confirmed as being up
351
309
      for some time, the client is assumed to be compromised and is no
352
 
      longer eligible to receive the encrypted password.  (Manual
353
 
      intervention is required to re-enable a client.)  The timeout,
 
310
      longer eligible to receive the encrypted password.  The timeout,
354
311
      checker program, and interval between checks can be configured
355
312
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
358
 
      receiving its password will also be treated as a successful
359
 
      checker run.
360
 
    </para>
361
 
  </refsect1>
362
 
  
363
 
  <refsect1 id="approval">
364
 
    <title>APPROVAL</title>
365
 
    <para>
366
 
      The server can be configured to require manual approval for a
367
 
      client before it is sent its secret.  The delay to wait for such
368
 
      approval and the default action (approve or deny) can be
369
 
      configured both globally and per client; see <citerefentry>
370
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
371
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
372
 
      will be approved immediately without delay.
373
 
    </para>
374
 
    <para>
375
 
      This can be used to deny a client its secret if not manually
376
 
      approved within a specified time.  It can also be used to make
377
 
      the server delay before giving a client its secret, allowing
378
 
      optional manual denying of this specific client.
379
 
    </para>
380
 
    
381
 
  </refsect1>
382
 
  
 
313
      <refentrytitle>mandos.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
316
      <manvolnum>5</manvolnum></citerefentry>.
 
317
    </para>
 
318
  </refsect1>
 
319
 
383
320
  <refsect1 id="logging">
384
321
    <title>LOGGING</title>
385
322
    <para>
386
 
      The server will send log message with various severity levels to
387
 
      <filename>/dev/log</filename>.  With the
 
323
      The server will send log messaged with various severity levels
 
324
      to <filename>/dev/log</filename>.  With the
388
325
      <option>--debug</option> option, it will log even more messages,
389
326
      and also show them on the console.
390
327
    </para>
391
328
  </refsect1>
392
 
  
393
 
  <refsect1 id="dbus_interface">
394
 
    <title>D-BUS INTERFACE</title>
395
 
    <para>
396
 
      The server will by default provide a D-Bus system bus interface.
397
 
      This interface will only be accessible by the root user or a
398
 
      Mandos-specific user, if such a user exists.  For documentation
399
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
400
 
    </para>
401
 
  </refsect1>
402
 
  
 
329
 
403
330
  <refsect1 id="exit_status">
404
331
    <title>EXIT STATUS</title>
405
332
    <para>
407
334
      critical error is encountered.
408
335
    </para>
409
336
  </refsect1>
410
 
  
 
337
 
411
338
  <refsect1 id="environment">
412
339
    <title>ENVIRONMENT</title>
413
340
    <variablelist>
414
341
      <varlistentry>
415
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
416
343
        <listitem>
417
344
          <para>
418
345
            To start the configured checker (see <xref
421
348
            <varname>PATH</varname> to search for matching commands if
422
349
            an absolute path is not given.  See <citerefentry>
423
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
424
 
            </citerefentry>.
 
351
          </citerefentry>
425
352
          </para>
426
353
        </listitem>
427
354
      </varlistentry>
428
355
    </variablelist>
429
356
  </refsect1>
430
 
  
431
 
  <refsect1 id="files">
 
357
 
 
358
  <refsect1 id="file">
432
359
    <title>FILES</title>
433
360
    <para>
434
361
      Use the <option>--configdir</option> option to change where
457
384
        </listitem>
458
385
      </varlistentry>
459
386
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
387
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
461
388
        <listitem>
462
389
          <para>
463
 
            The file containing the process id of the
464
 
            <command>&COMMANDNAME;</command> process started last.
 
390
            The file containing the process id of
 
391
            <command>&COMMANDNAME;</command>.
465
392
          </para>
466
393
        </listitem>
467
394
      </varlistentry>
495
422
      backtrace.  This could be considered a feature.
496
423
    </para>
497
424
    <para>
498
 
      Currently, if a client is disabled due to having timed out, the
499
 
      server does not record this fact onto permanent storage.  This
500
 
      has some security implications, see <xref linkend="clients"/>.
 
425
      Currently, if a client is declared <quote>invalid</quote> due to
 
426
      having timed out, the server does not record this fact onto
 
427
      permanent storage.  This has some security implications, see
 
428
      <xref linkend="CLIENTS"/>.
 
429
    </para>
 
430
    <para>
 
431
      There is currently no way of querying the server of the current
 
432
      status of clients, other than analyzing its <systemitem
 
433
      class="service">syslog</systemitem> output.
501
434
    </para>
502
435
    <para>
503
436
      There is no fine-grained control over logging and debug output.
506
439
      Debug mode is conflated with running in the foreground.
507
440
    </para>
508
441
    <para>
509
 
      The console log messages do not show a time stamp.
510
 
    </para>
511
 
    <para>
512
 
      This server does not check the expire time of clients’ OpenPGP
513
 
      keys.
 
442
      The console log messages does not show a timestamp.
514
443
    </para>
515
444
  </refsect1>
516
445
  
521
450
        Normal invocation needs no options:
522
451
      </para>
523
452
      <para>
524
 
        <userinput>&COMMANDNAME;</userinput>
 
453
        <userinput>mandos</userinput>
525
454
      </para>
526
455
    </informalexample>
527
456
    <informalexample>
534
463
      <para>
535
464
 
536
465
<!-- do not wrap this line -->
537
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
538
467
 
539
468
      </para>
540
469
    </informalexample>
546
475
      <para>
547
476
 
548
477
<!-- do not wrap this line -->
549
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
550
479
 
551
480
      </para>
552
481
    </informalexample>
553
482
  </refsect1>
554
 
  
 
483
 
555
484
  <refsect1 id="security">
556
485
    <title>SECURITY</title>
557
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
558
487
      <title>SERVER</title>
559
488
      <para>
560
489
        Running this <command>&COMMANDNAME;</command> server program
561
490
        should not in itself present any security risk to the host
562
 
        computer running it.  The program switches to a non-root user
563
 
        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.
564
493
      </para>
565
494
    </refsect2>
566
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
567
496
      <title>CLIENTS</title>
568
497
      <para>
569
498
        The server only gives out its stored data to clients which
576
505
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
506
        <manvolnum>5</manvolnum></citerefentry>)
578
507
        <emphasis>must</emphasis> be made non-readable by anyone
579
 
        except the user starting the server (usually root).
 
508
        except the user running the server.
580
509
      </para>
581
510
      <para>
582
511
        As detailed in <xref linkend="checking"/>, the status of all
585
514
      </para>
586
515
      <para>
587
516
        If a client is compromised, its downtime should be duly noted
588
 
        by the server which would therefore disable the client.  But
589
 
        if the server was ever restarted, it would re-read its client
590
 
        list from its configuration file and again regard all clients
591
 
        therein as enabled, and hence eligible to receive their
592
 
        passwords.  Therefore, be careful when restarting servers if
593
 
        it is suspected that a client has, in fact, been compromised
594
 
        by parties who may now be running a fake Mandos client with
595
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
596
 
        image of the client host.  What should be done in that case
597
 
        (if restarting the server program really is necessary) is to
598
 
        stop the server program, edit the configuration file to omit
599
 
        any suspect clients, and restart the server program.
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        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
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
600
530
      </para>
601
531
      <para>
602
532
        For more details on client-side security, see
603
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
533
        <citerefentry><refentrytitle>password-request</refentrytitle>
604
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
605
535
      </para>
606
536
    </refsect2>
607
537
  </refsect1>
608
 
  
 
538
 
609
539
  <refsect1 id="see_also">
610
540
    <title>SEE ALSO</title>
611
 
    <para>
612
 
      <citerefentry>
613
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
614
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
 
        <refentrytitle>mandos.conf</refentrytitle>
616
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
618
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
 
      </citerefentry>
621
 
    </para>
622
541
    <variablelist>
623
542
      <varlistentry>
624
543
        <term>
 
544
          <citerefentry>
 
545
            <refentrytitle>password-request</refentrytitle>
 
546
            <manvolnum>8mandos</manvolnum>
 
547
          </citerefentry>
 
548
        </term>
 
549
        <listitem>
 
550
          <para>
 
551
            This is the actual program which talks to this server.
 
552
            Note that it is normally not invoked directly, and is only
 
553
            run in the initial RAM disk environment, and not on a
 
554
            fully started system.
 
555
          </para>
 
556
        </listitem>
 
557
      </varlistentry>
 
558
      <varlistentry>
 
559
        <term>
625
560
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
626
561
        </term>
627
562
        <listitem>
644
579
      </varlistentry>
645
580
      <varlistentry>
646
581
        <term>
647
 
          <ulink url="http://www.gnu.org/software/gnutls/"
648
 
          >GnuTLS</ulink>
 
582
          <ulink
 
583
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
649
584
        </term>
650
585
      <listitem>
651
586
        <para>
657
592
      </varlistentry>
658
593
      <varlistentry>
659
594
        <term>
660
 
          RFC 4291: <citetitle>IP Version 6 Addressing
661
 
          Architecture</citetitle>
 
595
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
596
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
597
          Unicast Addresses</citation>
662
598
        </term>
663
599
        <listitem>
664
 
          <variablelist>
665
 
            <varlistentry>
666
 
              <term>Section 2.2: <citetitle>Text Representation of
667
 
              Addresses</citetitle></term>
668
 
              <listitem><para/></listitem>
669
 
            </varlistentry>
670
 
            <varlistentry>
671
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
672
 
              Address</citetitle></term>
673
 
              <listitem><para/></listitem>
674
 
            </varlistentry>
675
 
            <varlistentry>
676
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
677
 
            Addresses</citetitle></term>
678
 
            <listitem>
679
 
              <para>
680
 
                The clients use IPv6 link-local addresses, which are
681
 
                immediately usable since a link-local addresses is
682
 
                automatically assigned to a network interfaces when it
683
 
                is brought up.
684
 
              </para>
685
 
            </listitem>
686
 
            </varlistentry>
687
 
          </variablelist>
 
600
          <para>
 
601
            The clients use IPv6 link-local addresses, which are
 
602
            immediately usable since a link-local addresses is
 
603
            automatically assigned to a network interfaces when it is
 
604
            brought up.
 
605
          </para>
688
606
        </listitem>
689
607
      </varlistentry>
690
608
      <varlistentry>
691
609
        <term>
692
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
 
          Protocol Version 1.1</citetitle>
 
610
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
611
          (TLS) Protocol Version 1.1</citetitle></citation>
694
612
        </term>
695
613
      <listitem>
696
614
        <para>
700
618
      </varlistentry>
701
619
      <varlistentry>
702
620
        <term>
703
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
621
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
622
          Format</citetitle></citation>
704
623
        </term>
705
624
      <listitem>
706
625
        <para>
710
629
      </varlistentry>
711
630
      <varlistentry>
712
631
        <term>
713
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
714
 
          Security</citetitle>
 
632
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
633
          Transport Layer Security</citetitle></citation>
715
634
        </term>
716
635
      <listitem>
717
636
        <para>
723
642
    </variablelist>
724
643
  </refsect1>
725
644
</refentry>
726
 
<!-- Local Variables: -->
727
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
728
 
<!-- time-stamp-end: "[\"']>" -->
729
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
730
 
<!-- End: -->