/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: Björn Påhlsson
  • Date: 2011-12-25 10:33:25 UTC
  • Revision ID: belorn@recompile.se-20111225103325-wlbwm89iy21c7mg0
renamed some foomax values to what they actually represent
fixed a very small exitstatus bug in plugin-runner

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