/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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