/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: 2009-01-10 06:23:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090110062304-wy7yw1pyuu5cldrg
* plugins.d/splashy.c (main): Do not abort if a process vanishes while
                              investigating it.
* plugins.d/usplash.c (main): - '' -  Also removed unnecessary code.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
10
 
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
30
32
    </authorgroup>
31
33
    <copyright>
32
34
      <year>2008</year>
 
35
      <year>2009</year>
33
36
      <holder>Teddy Hogeborn</holder>
34
37
      <holder>Björn Påhlsson</holder>
35
38
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
39
    <xi:include href="legalnotice.xml"/>
59
40
  </refentryinfo>
60
 
 
 
41
  
61
42
  <refmeta>
62
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
44
    <manvolnum>8</manvolnum>
66
47
  <refnamediv>
67
48
    <refname><command>&COMMANDNAME;</command></refname>
68
49
    <refpurpose>
69
 
      Sends encrypted passwords to authenticated Mandos clients
 
50
      Gives encrypted passwords to authenticated Mandos clients
70
51
    </refpurpose>
71
52
  </refnamediv>
72
 
 
 
53
  
73
54
  <refsynopsisdiv>
74
55
    <cmdsynopsis>
75
56
      <command>&COMMANDNAME;</command>
76
 
      <arg choice="opt">--interface<arg choice="plain">IF</arg></arg>
77
 
      <arg choice="opt">--address<arg choice="plain">ADDRESS</arg></arg>
78
 
      <arg choice="opt">--port<arg choice="plain">PORT</arg></arg>
79
 
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
80
 
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
81
 
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
 
      <arg choice="opt">--debug</arg>
83
 
    </cmdsynopsis>
84
 
    <cmdsynopsis>
85
 
      <command>&COMMANDNAME;</command>
86
 
      <arg choice="opt">-i<arg choice="plain">IF</arg></arg>
87
 
      <arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
88
 
      <arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
89
 
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
90
 
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
91
 
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
 
      <arg choice="opt">--debug</arg>
93
 
    </cmdsynopsis>
94
 
    <cmdsynopsis>
95
 
      <command>&COMMANDNAME;</command>
96
 
      <arg choice="plain">--help</arg>
97
 
    </cmdsynopsis>
98
 
    <cmdsynopsis>
99
 
      <command>&COMMANDNAME;</command>
100
 
      <arg choice="plain">--version</arg>
101
 
    </cmdsynopsis>
102
 
    <cmdsynopsis>
103
 
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--check</arg>
 
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
    </cmdsynopsis>
 
91
    <cmdsynopsis>
 
92
      <command>&COMMANDNAME;</command>
 
93
      <group choice="req">
 
94
        <arg choice="plain"><option>--help</option></arg>
 
95
        <arg choice="plain"><option>-h</option></arg>
 
96
      </group>
 
97
    </cmdsynopsis>
 
98
    <cmdsynopsis>
 
99
      <command>&COMMANDNAME;</command>
 
100
      <arg choice="plain"><option>--version</option></arg>
 
101
    </cmdsynopsis>
 
102
    <cmdsynopsis>
 
103
      <command>&COMMANDNAME;</command>
 
104
      <arg choice="plain"><option>--check</option></arg>
105
105
    </cmdsynopsis>
106
106
  </refsynopsisdiv>
107
 
 
 
107
  
108
108
  <refsect1 id="description">
109
109
    <title>DESCRIPTION</title>
110
110
    <para>
119
119
      Any authenticated client is then given the stored pre-encrypted
120
120
      password for that specific client.
121
121
    </para>
122
 
 
123
122
  </refsect1>
124
123
  
125
124
  <refsect1 id="purpose">
126
125
    <title>PURPOSE</title>
127
 
 
128
126
    <para>
129
127
      The purpose of this is to enable <emphasis>remote and unattended
130
128
      rebooting</emphasis> of client host computer with an
131
129
      <emphasis>encrypted root file system</emphasis>.  See <xref
132
130
      linkend="overview"/> for details.
133
131
    </para>
134
 
 
135
132
  </refsect1>
136
133
  
137
134
  <refsect1 id="options">
138
135
    <title>OPTIONS</title>
139
 
 
140
136
    <variablelist>
141
137
      <varlistentry>
142
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
138
        <term><option>--help</option></term>
 
139
        <term><option>-h</option></term>
143
140
        <listitem>
144
141
          <para>
145
142
            Show a help message and exit
146
143
          </para>
147
144
        </listitem>
148
145
      </varlistentry>
149
 
 
150
 
      <varlistentry>
151
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
152
 
        IF</replaceable></literal></term>
153
 
        <listitem>
154
 
          <para>
155
 
            Only announce the server and listen to requests on network
156
 
            interface <replaceable>IF</replaceable>.  Default is to
157
 
            use all available interfaces.
158
 
          </para>
159
 
        </listitem>
160
 
      </varlistentry>
161
 
 
162
 
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
165
 
        <listitem>
166
 
          <para>
167
 
            If this option is used, the server will only listen to a
168
 
            specific address.  This must currently be an IPv6 address;
169
 
            an IPv4 address can be specified using the
170
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
171
 
            Also, if a link-local address is specified, an interface
172
 
            should be set, since a link-local address is only valid on
173
 
            a single interface.  By default, the server will listen to
174
 
            all available addresses.
175
 
          </para>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
 
179
 
      <varlistentry>
180
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
181
 
        PORT</replaceable></literal></term>
182
 
        <listitem>
183
 
          <para>
184
 
            If this option is used, the server to bind to that
185
 
            port. By default, the server will listen to an arbitrary
186
 
            port given by the operating system.
187
 
          </para>
188
 
        </listitem>
189
 
      </varlistentry>
190
 
 
191
 
      <varlistentry>
192
 
        <term><literal>--check</literal></term>
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>--interface</option>
 
149
        <replaceable>NAME</replaceable></term>
 
150
        <term><option>-i</option>
 
151
        <replaceable>NAME</replaceable></term>
 
152
        <listitem>
 
153
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
      
 
157
      <varlistentry>
 
158
        <term><option>--address
 
159
        <replaceable>ADDRESS</replaceable></option></term>
 
160
        <term><option>-a
 
161
        <replaceable>ADDRESS</replaceable></option></term>
 
162
        <listitem>
 
163
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
      
 
167
      <varlistentry>
 
168
        <term><option>--port
 
169
        <replaceable>PORT</replaceable></option></term>
 
170
        <term><option>-p
 
171
        <replaceable>PORT</replaceable></option></term>
 
172
        <listitem>
 
173
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
174
        </listitem>
 
175
      </varlistentry>
 
176
      
 
177
      <varlistentry>
 
178
        <term><option>--check</option></term>
193
179
        <listitem>
194
180
          <para>
195
181
            Run the server’s self-tests.  This includes any unit
197
183
          </para>
198
184
        </listitem>
199
185
      </varlistentry>
200
 
 
201
 
      <varlistentry>
202
 
        <term><literal>--debug</literal></term>
203
 
        <listitem>
204
 
          <para>
205
 
            If the server is run in debug mode, it will run in the
206
 
            foreground and print a lot of debugging information.  The
207
 
            default is <emphasis>not</emphasis> to run in debug mode.
208
 
          </para>
209
 
        </listitem>
210
 
      </varlistentry>
211
 
 
212
 
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
215
 
        <listitem>
216
 
          <para>
217
 
            GnuTLS priority string for the TLS handshake with the
218
 
            clients.  The default is
219
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
220
 
            See <citerefentry><refentrytitle>gnutls_priority_init
221
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
222
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
223
 
            this may make the TLS handshake fail, making communication
224
 
            with clients impossible.
225
 
          </para>
226
 
        </listitem>
227
 
      </varlistentry>
228
 
 
229
 
      <varlistentry>
230
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
231
 
        </literal></term>
232
 
        <listitem>
233
 
          <para>
234
 
            Zeroconf service name.  The default is
235
 
            <quote><literal>Mandos</literal></quote>.  You only need
236
 
            to change this if you for some reason want to run more
237
 
            than one server on the same <emphasis>host</emphasis>,
238
 
            which would not normally be useful.  If there are name
239
 
            collisions on the same <emphasis>network</emphasis>, the
240
 
            newer server will automatically rename itself to
241
 
            <quote><literal>Mandos #2</literal></quote>, and so on;
242
 
            therefore, this option is not needed in that case.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
 
247
 
      <varlistentry>
248
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
249
 
        </literal></term>
 
186
      
 
187
      <varlistentry>
 
188
        <term><option>--debug</option></term>
 
189
        <listitem>
 
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
191
        </listitem>
 
192
      </varlistentry>
 
193
      
 
194
      <varlistentry>
 
195
        <term><option>--priority <replaceable>
 
196
        PRIORITY</replaceable></option></term>
 
197
        <listitem>
 
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
      
 
202
      <varlistentry>
 
203
        <term><option>--servicename
 
204
        <replaceable>NAME</replaceable></option></term>
 
205
        <listitem>
 
206
          <xi:include href="mandos-options.xml"
 
207
                      xpointer="servicename"/>
 
208
        </listitem>
 
209
      </varlistentry>
 
210
      
 
211
      <varlistentry>
 
212
        <term><option>--configdir
 
213
        <replaceable>DIRECTORY</replaceable></option></term>
250
214
        <listitem>
251
215
          <para>
252
216
            Directory to search for configuration files.  Default is
258
222
          </para>
259
223
        </listitem>
260
224
      </varlistentry>
261
 
 
 
225
      
262
226
      <varlistentry>
263
 
        <term><literal>--version</literal></term>
 
227
        <term><option>--version</option></term>
264
228
        <listitem>
265
229
          <para>
266
230
            Prints the program version and exit.
267
231
          </para>
268
232
        </listitem>
269
233
      </varlistentry>
 
234
      
 
235
      <varlistentry>
 
236
        <term><option>--no-dbus</option></term>
 
237
        <listitem>
 
238
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
239
          <para>
 
240
            See also <xref linkend="dbus_interface"/>.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
270
244
    </variablelist>
271
245
  </refsect1>
272
 
 
 
246
  
273
247
  <refsect1 id="overview">
274
248
    <title>OVERVIEW</title>
275
 
    &OVERVIEW;
 
249
    <xi:include href="overview.xml"/>
276
250
    <para>
277
251
      This program is the server part.  It is a normal server program
278
252
      and will run in a normal system environment, not in an initial
279
 
      RAM disk environment.
 
253
      <acronym>RAM</acronym> disk environment.
280
254
    </para>
281
255
  </refsect1>
282
 
 
 
256
  
283
257
  <refsect1 id="protocol">
284
258
    <title>NETWORK PROTOCOL</title>
285
259
    <para>
311
285
        <entry>-><!-- &rarr; --></entry>
312
286
      </row>
313
287
      <row>
314
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
288
        <entry><quote><literal>1\r\n</literal></quote></entry>
315
289
        <entry>-><!-- &rarr; --></entry>
316
290
      </row>
317
291
      <row>
337
311
      </row>
338
312
    </tbody></tgroup></table>
339
313
  </refsect1>
340
 
 
 
314
  
341
315
  <refsect1 id="checking">
342
316
    <title>CHECKING</title>
343
317
    <para>
347
321
      longer eligible to receive the encrypted password.  The timeout,
348
322
      checker program, and interval between checks can be configured
349
323
      both globally and per client; see <citerefentry>
350
 
      <refentrytitle>mandos.conf</refentrytitle>
351
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
352
324
      <refentrytitle>mandos-clients.conf</refentrytitle>
353
325
      <manvolnum>5</manvolnum></citerefentry>.
354
326
    </para>
355
327
  </refsect1>
356
 
 
 
328
  
357
329
  <refsect1 id="logging">
358
330
    <title>LOGGING</title>
359
331
    <para>
360
 
      The server will send log messaged with various severity levels
361
 
      to <filename>/dev/log</filename>.  With the
 
332
      The server will send log message with various severity levels to
 
333
      <filename>/dev/log</filename>.  With the
362
334
      <option>--debug</option> option, it will log even more messages,
363
335
      and also show them on the console.
364
336
    </para>
365
337
  </refsect1>
 
338
  
 
339
  <refsect1 id="dbus_interface">
 
340
    <title>D-BUS INTERFACE</title>
 
341
    <para>
 
342
      The server will by default provide a D-Bus system bus interface.
 
343
      This interface will only be accessible by the root user or a
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
 
346
    </para>
 
347
  </refsect1>
366
348
 
367
349
  <refsect1 id="exit_status">
368
350
    <title>EXIT STATUS</title>
371
353
      critical error is encountered.
372
354
    </para>
373
355
  </refsect1>
374
 
 
375
 
  <refsect1 id="file">
 
356
  
 
357
  <refsect1 id="environment">
 
358
    <title>ENVIRONMENT</title>
 
359
    <variablelist>
 
360
      <varlistentry>
 
361
        <term><envar>PATH</envar></term>
 
362
        <listitem>
 
363
          <para>
 
364
            To start the configured checker (see <xref
 
365
            linkend="checking"/>), the server uses
 
366
            <filename>/bin/sh</filename>, which in turn uses
 
367
            <varname>PATH</varname> to search for matching commands if
 
368
            an absolute path is not given.  See <citerefentry>
 
369
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
370
            </citerefentry>.
 
371
          </para>
 
372
        </listitem>
 
373
      </varlistentry>
 
374
    </variablelist>
 
375
  </refsect1>
 
376
  
 
377
  <refsect1 id="files">
376
378
    <title>FILES</title>
377
379
    <para>
378
380
      Use the <option>--configdir</option> option to change where
401
403
        </listitem>
402
404
      </varlistentry>
403
405
      <varlistentry>
404
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
406
        <term><filename>/var/run/mandos.pid</filename></term>
405
407
        <listitem>
406
408
          <para>
407
409
            The file containing the process id of
418
420
          </para>
419
421
        </listitem>
420
422
      </varlistentry>
 
423
      <varlistentry>
 
424
        <term><filename>/bin/sh</filename></term>
 
425
        <listitem>
 
426
          <para>
 
427
            This is used to start the configured checker command for
 
428
            each client.  See <citerefentry>
 
429
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
430
            <manvolnum>5</manvolnum></citerefentry> for details.
 
431
          </para>
 
432
        </listitem>
 
433
      </varlistentry>
421
434
    </variablelist>
422
435
  </refsect1>
423
 
 
 
436
  
424
437
  <refsect1 id="bugs">
425
438
    <title>BUGS</title>
426
439
    <para>
427
440
      This server might, on especially fatal errors, emit a Python
428
441
      backtrace.  This could be considered a feature.
429
442
    </para>
 
443
    <para>
 
444
      Currently, if a client is declared <quote>invalid</quote> due to
 
445
      having timed out, the server does not record this fact onto
 
446
      permanent storage.  This has some security implications, see
 
447
      <xref linkend="clients"/>.
 
448
    </para>
 
449
    <para>
 
450
      There is currently no way of querying the server of the current
 
451
      status of clients, other than analyzing its <systemitem
 
452
      class="service">syslog</systemitem> output.
 
453
    </para>
 
454
    <para>
 
455
      There is no fine-grained control over logging and debug output.
 
456
    </para>
 
457
    <para>
 
458
      Debug mode is conflated with running in the foreground.
 
459
    </para>
 
460
    <para>
 
461
      The console log messages does not show a time stamp.
 
462
    </para>
 
463
    <para>
 
464
      This server does not check the expire time of clients’ OpenPGP
 
465
      keys.
 
466
    </para>
430
467
  </refsect1>
431
 
 
432
 
  <refsect1 id="examples">
433
 
    <title>EXAMPLES</title>
 
468
  
 
469
  <refsect1 id="example">
 
470
    <title>EXAMPLE</title>
434
471
    <informalexample>
435
472
      <para>
436
473
        Normal invocation needs no options:
437
474
      </para>
438
475
      <para>
439
 
        <userinput>mandos</userinput>
 
476
        <userinput>&COMMANDNAME;</userinput>
440
477
      </para>
441
478
    </informalexample>
442
479
    <informalexample>
449
486
      <para>
450
487
 
451
488
<!-- do not wrap this line -->
452
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
489
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
453
490
 
454
491
      </para>
455
492
    </informalexample>
461
498
      <para>
462
499
 
463
500
<!-- do not wrap this line -->
464
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
501
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
465
502
 
466
503
      </para>
467
504
    </informalexample>
468
505
  </refsect1>
469
 
 
 
506
  
470
507
  <refsect1 id="security">
471
508
    <title>SECURITY</title>
472
 
    <refsect2>
 
509
    <refsect2 id="server">
473
510
      <title>SERVER</title>
474
511
      <para>
475
 
        Running this &COMMANDNAME; server program should not in itself
476
 
        present any security risk to the host computer running it.
477
 
        The program does not need any special privileges to run, and
478
 
        is designed to run as a non-root user.
 
512
        Running this <command>&COMMANDNAME;</command> server program
 
513
        should not in itself present any security risk to the host
 
514
        computer running it.  The program switches to a non-root user
 
515
        soon after startup.
479
516
      </para>
480
517
    </refsect2>
481
 
    <refsect2>
 
518
    <refsect2 id="clients">
482
519
      <title>CLIENTS</title>
483
520
      <para>
484
521
        The server only gives out its stored data to clients which
491
528
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
492
529
        <manvolnum>5</manvolnum></citerefentry>)
493
530
        <emphasis>must</emphasis> be made non-readable by anyone
494
 
        except the user running the server.
 
531
        except the user starting the server (usually root).
495
532
      </para>
496
533
      <para>
497
534
        As detailed in <xref linkend="checking"/>, the status of all
499
536
        compromised if they are gone for too long.
500
537
      </para>
501
538
      <para>
 
539
        If a client is compromised, its downtime should be duly noted
 
540
        by the server which would therefore declare the client
 
541
        invalid.  But if the server was ever restarted, it would
 
542
        re-read its client list from its configuration file and again
 
543
        regard all clients therein as valid, and hence eligible to
 
544
        receive their passwords.  Therefore, be careful when
 
545
        restarting servers if it is suspected that a client has, in
 
546
        fact, been compromised by parties who may now be running a
 
547
        fake Mandos client with the keys from the non-encrypted
 
548
        initial <acronym>RAM</acronym> image of the client host.  What
 
549
        should be done in that case (if restarting the server program
 
550
        really is necessary) is to stop the server program, edit the
 
551
        configuration file to omit any suspect clients, and restart
 
552
        the server program.
 
553
      </para>
 
554
      <para>
502
555
        For more details on client-side security, see
503
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
556
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
504
557
        <manvolnum>8mandos</manvolnum></citerefentry>.
505
558
      </para>
506
559
    </refsect2>
507
560
  </refsect1>
508
 
 
 
561
  
509
562
  <refsect1 id="see_also">
510
563
    <title>SEE ALSO</title>
 
564
    <para>
 
565
      <citerefentry>
 
566
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
568
        <refentrytitle>mandos.conf</refentrytitle>
 
569
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
570
        <refentrytitle>mandos-client</refentrytitle>
 
571
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
572
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
573
      </citerefentry>
 
574
    </para>
511
575
    <variablelist>
512
576
      <varlistentry>
513
577
        <term>
514
 
          <citerefentry>
515
 
            <refentrytitle>password-request</refentrytitle>
516
 
            <manvolnum>8mandos</manvolnum>
517
 
          </citerefentry>
518
 
        </term>
519
 
        <listitem>
520
 
          <para>
521
 
            This is the actual program which talks to this server.
522
 
            Note that it is normally not invoked directly, and is only
523
 
            run in the initial RAM disk environment, and not on a
524
 
            fully started system.
525
 
          </para>
526
 
        </listitem>
527
 
      </varlistentry>
528
 
      <varlistentry>
529
 
        <term>
530
578
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
531
579
        </term>
532
580
        <listitem>
549
597
      </varlistentry>
550
598
      <varlistentry>
551
599
        <term>
552
 
          <ulink
553
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
600
          <ulink url="http://www.gnu.org/software/gnutls/"
 
601
          >GnuTLS</ulink>
554
602
        </term>
555
603
      <listitem>
556
604
        <para>
562
610
      </varlistentry>
563
611
      <varlistentry>
564
612
        <term>
565
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
 
          Unicast Addresses</citation>
 
613
          RFC 4291: <citetitle>IP Version 6 Addressing
 
614
          Architecture</citetitle>
568
615
        </term>
569
616
        <listitem>
570
 
          <para>
571
 
            The clients use IPv6 link-local addresses, which are
572
 
            immediately usable since a link-local addresses is
573
 
            automatically assigned to a network interfaces when it is
574
 
            brought up.
575
 
          </para>
 
617
          <variablelist>
 
618
            <varlistentry>
 
619
              <term>Section 2.2: <citetitle>Text Representation of
 
620
              Addresses</citetitle></term>
 
621
              <listitem><para/></listitem>
 
622
            </varlistentry>
 
623
            <varlistentry>
 
624
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
625
              Address</citetitle></term>
 
626
              <listitem><para/></listitem>
 
627
            </varlistentry>
 
628
            <varlistentry>
 
629
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
630
            Addresses</citetitle></term>
 
631
            <listitem>
 
632
              <para>
 
633
                The clients use IPv6 link-local addresses, which are
 
634
                immediately usable since a link-local addresses is
 
635
                automatically assigned to a network interfaces when it
 
636
                is brought up.
 
637
              </para>
 
638
            </listitem>
 
639
            </varlistentry>
 
640
          </variablelist>
576
641
        </listitem>
577
642
      </varlistentry>
578
643
      <varlistentry>
579
644
        <term>
580
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
581
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
645
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
646
          Protocol Version 1.1</citetitle>
582
647
        </term>
583
648
      <listitem>
584
649
        <para>
588
653
      </varlistentry>
589
654
      <varlistentry>
590
655
        <term>
591
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
592
 
          Format</citetitle></citation>
 
656
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
593
657
        </term>
594
658
      <listitem>
595
659
        <para>
599
663
      </varlistentry>
600
664
      <varlistentry>
601
665
        <term>
602
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
603
 
          Transport Layer Security</citetitle></citation>
 
666
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
667
          Security</citetitle>
604
668
        </term>
605
669
      <listitem>
606
670
        <para>
612
676
    </variablelist>
613
677
  </refsect1>
614
678
</refentry>
 
679
<!-- Local Variables: -->
 
680
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
681
<!-- time-stamp-end: "[\"']>" -->
 
682
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
683
<!-- End: -->