/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

merge

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