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