/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2013-10-20 22:20:11 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131020222011-g2fvjicx5lrv4h4e
* mandos-change-keytype: Bug fix: call mandos-keygen from $PATH, not
                         current directory.

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 "2013-10-20">
 
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>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
32
40
      <holder>Teddy Hogeborn</holder>
33
41
      <holder>Björn Påhlsson</holder>
34
42
    </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>
 
43
    <xi:include href="legalnotice.xml"/>
58
44
  </refentryinfo>
59
 
 
 
45
  
60
46
  <refmeta>
61
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
48
    <manvolnum>8</manvolnum>
65
51
  <refnamediv>
66
52
    <refname><command>&COMMANDNAME;</command></refname>
67
53
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
54
      Gives encrypted passwords to authenticated Mandos clients
69
55
    </refpurpose>
70
56
  </refnamediv>
71
 
 
 
57
  
72
58
  <refsynopsisdiv>
73
59
    <cmdsynopsis>
74
60
      <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>
 
61
      <group>
 
62
        <arg choice="plain"><option>--interface
 
63
        <replaceable>NAME</replaceable></option></arg>
 
64
        <arg choice="plain"><option>-i
 
65
        <replaceable>NAME</replaceable></option></arg>
 
66
      </group>
 
67
      <sbr/>
 
68
      <group>
 
69
        <arg choice="plain"><option>--address
 
70
        <replaceable>ADDRESS</replaceable></option></arg>
 
71
        <arg choice="plain"><option>-a
 
72
        <replaceable>ADDRESS</replaceable></option></arg>
 
73
      </group>
 
74
      <sbr/>
 
75
      <group>
 
76
        <arg choice="plain"><option>--port
 
77
        <replaceable>PORT</replaceable></option></arg>
 
78
        <arg choice="plain"><option>-p
 
79
        <replaceable>PORT</replaceable></option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <arg><option>--priority
 
83
      <replaceable>PRIORITY</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--servicename
 
86
      <replaceable>NAME</replaceable></option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--configdir
 
89
      <replaceable>DIRECTORY</replaceable></option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debug</option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-restore</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--statedir
 
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
92
109
    </cmdsynopsis>
93
110
    <cmdsynopsis>
94
111
      <command>&COMMANDNAME;</command>
95
112
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
113
        <arg choice="plain"><option>--help</option></arg>
 
114
        <arg choice="plain"><option>-h</option></arg>
98
115
      </group>
99
116
    </cmdsynopsis>
100
117
    <cmdsynopsis>
101
118
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
119
      <arg choice="plain"><option>--version</option></arg>
103
120
    </cmdsynopsis>
104
121
    <cmdsynopsis>
105
122
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
123
      <arg choice="plain"><option>--check</option></arg>
107
124
    </cmdsynopsis>
108
125
  </refsynopsisdiv>
109
 
 
 
126
  
110
127
  <refsect1 id="description">
111
128
    <title>DESCRIPTION</title>
112
129
    <para>
113
130
      <command>&COMMANDNAME;</command> is a server daemon which
114
131
      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.
 
132
      client host computers. For an introduction, see
 
133
      <citerefentry><refentrytitle>intro</refentrytitle>
 
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
135
      uses Zeroconf to announce itself on the local network, and uses
 
136
      TLS to communicate securely with and to authenticate the
 
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
138
      use IPv6 link-local addresses, since the clients will probably
 
139
      not have any other addresses configured (see <xref
 
140
      linkend="overview"/>).  Any authenticated client is then given
 
141
      the stored pre-encrypted password for that specific client.
123
142
    </para>
124
 
 
125
143
  </refsect1>
126
144
  
127
145
  <refsect1 id="purpose">
128
146
    <title>PURPOSE</title>
129
 
 
130
147
    <para>
131
148
      The purpose of this is to enable <emphasis>remote and unattended
132
149
      rebooting</emphasis> of client host computer with an
133
150
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
151
      linkend="overview"/> for details.
135
152
    </para>
136
 
 
137
153
  </refsect1>
138
154
  
139
155
  <refsect1 id="options">
140
156
    <title>OPTIONS</title>
141
 
 
142
157
    <variablelist>
143
158
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
159
        <term><option>--help</option></term>
 
160
        <term><option>-h</option></term>
145
161
        <listitem>
146
162
          <para>
147
163
            Show a help message and exit
148
164
          </para>
149
165
        </listitem>
150
166
      </varlistentry>
151
 
 
 
167
      
152
168
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
169
        <term><option>--interface</option>
 
170
        <replaceable>NAME</replaceable></term>
 
171
        <term><option>-i</option>
 
172
        <replaceable>NAME</replaceable></term>
155
173
        <listitem>
156
174
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
175
        </listitem>
158
176
      </varlistentry>
159
 
 
 
177
      
160
178
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
179
        <term><option>--address
 
180
        <replaceable>ADDRESS</replaceable></option></term>
 
181
        <term><option>-a
 
182
        <replaceable>ADDRESS</replaceable></option></term>
163
183
        <listitem>
164
184
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
185
        </listitem>
166
186
      </varlistentry>
167
 
 
 
187
      
168
188
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
189
        <term><option>--port
 
190
        <replaceable>PORT</replaceable></option></term>
 
191
        <term><option>-p
 
192
        <replaceable>PORT</replaceable></option></term>
171
193
        <listitem>
172
194
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
195
        </listitem>
174
196
      </varlistentry>
175
 
 
 
197
      
176
198
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
199
        <term><option>--check</option></term>
178
200
        <listitem>
179
201
          <para>
180
202
            Run the server’s self-tests.  This includes any unit
182
204
          </para>
183
205
        </listitem>
184
206
      </varlistentry>
185
 
 
 
207
      
186
208
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
209
        <term><option>--debug</option></term>
188
210
        <listitem>
189
211
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
212
        </listitem>
191
213
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
214
      
 
215
      <varlistentry>
 
216
        <term><option>--debuglevel
 
217
        <replaceable>LEVEL</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Set the debugging log level.
 
221
            <replaceable>LEVEL</replaceable> is a string, one of
 
222
            <quote><literal>CRITICAL</literal></quote>,
 
223
            <quote><literal>ERROR</literal></quote>,
 
224
            <quote><literal>WARNING</literal></quote>,
 
225
            <quote><literal>INFO</literal></quote>, or
 
226
            <quote><literal>DEBUG</literal></quote>, in order of
 
227
            increasing verbosity.  The default level is
 
228
            <quote><literal>WARNING</literal></quote>.
 
229
          </para>
 
230
        </listitem>
 
231
      </varlistentry>
 
232
      
 
233
      <varlistentry>
 
234
        <term><option>--priority <replaceable>
 
235
        PRIORITY</replaceable></option></term>
196
236
        <listitem>
197
237
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
238
        </listitem>
199
239
      </varlistentry>
200
 
 
 
240
      
201
241
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
242
        <term><option>--servicename
 
243
        <replaceable>NAME</replaceable></option></term>
204
244
        <listitem>
205
245
          <xi:include href="mandos-options.xml"
206
246
                      xpointer="servicename"/>
207
247
        </listitem>
208
248
      </varlistentry>
209
 
 
 
249
      
210
250
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
251
        <term><option>--configdir
 
252
        <replaceable>DIRECTORY</replaceable></option></term>
213
253
        <listitem>
214
254
          <para>
215
255
            Directory to search for configuration files.  Default is
221
261
          </para>
222
262
        </listitem>
223
263
      </varlistentry>
224
 
 
 
264
      
225
265
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
266
        <term><option>--version</option></term>
227
267
        <listitem>
228
268
          <para>
229
269
            Prints the program version and exit.
230
270
          </para>
231
271
        </listitem>
232
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-dbus</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
278
          <para>
 
279
            See also <xref linkend="dbus_interface"/>.
 
280
          </para>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-ipv6</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-restore</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
295
          <para>
 
296
            See also <xref linkend="persistent_state"/>.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
      
 
301
      <varlistentry>
 
302
        <term><option>--statedir
 
303
        <replaceable>DIRECTORY</replaceable></option></term>
 
304
        <listitem>
 
305
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--socket
 
311
        <replaceable>FD</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--foreground</option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml"
 
321
                      xpointer="foreground"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
233
325
    </variablelist>
234
326
  </refsect1>
235
 
 
 
327
  
236
328
  <refsect1 id="overview">
237
329
    <title>OVERVIEW</title>
238
330
    <xi:include href="overview.xml"/>
239
331
    <para>
240
332
      This program is the server part.  It is a normal server program
241
333
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
334
      <acronym>RAM</acronym> disk environment.
243
335
    </para>
244
336
  </refsect1>
245
 
 
 
337
  
246
338
  <refsect1 id="protocol">
247
339
    <title>NETWORK PROTOCOL</title>
248
340
    <para>
300
392
      </row>
301
393
    </tbody></tgroup></table>
302
394
  </refsect1>
303
 
 
 
395
  
304
396
  <refsect1 id="checking">
305
397
    <title>CHECKING</title>
306
398
    <para>
307
399
      The server will, by default, continually check that the clients
308
400
      are still up.  If a client has not been confirmed as being up
309
401
      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>
 
402
      longer eligible to receive the encrypted password.  (Manual
 
403
      intervention is required to re-enable a client.)  The timeout,
 
404
      extended timeout, checker program, and interval between checks
 
405
      can be configured both globally and per client; see
 
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
407
      <manvolnum>5</manvolnum></citerefentry>.
 
408
    </para>
 
409
  </refsect1>
 
410
  
 
411
  <refsect1 id="approval">
 
412
    <title>APPROVAL</title>
 
413
    <para>
 
414
      The server can be configured to require manual approval for a
 
415
      client before it is sent its secret.  The delay to wait for such
 
416
      approval and the default action (approve or deny) can be
 
417
      configured both globally and per client; see <citerefentry>
313
418
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
419
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
420
      will be approved immediately without delay.
 
421
    </para>
 
422
    <para>
 
423
      This can be used to deny a client its secret if not manually
 
424
      approved within a specified time.  It can also be used to make
 
425
      the server delay before giving a client its secret, allowing
 
426
      optional manual denying of this specific client.
 
427
    </para>
 
428
    
316
429
  </refsect1>
317
 
 
 
430
  
318
431
  <refsect1 id="logging">
319
432
    <title>LOGGING</title>
320
433
    <para>
321
434
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
323
436
      <option>--debug</option> option, it will log even more messages,
324
437
      and also show them on the console.
325
438
    </para>
326
439
  </refsect1>
327
 
 
 
440
  
 
441
  <refsect1 id="persistent_state">
 
442
    <title>PERSISTENT STATE</title>
 
443
    <para>
 
444
      Client settings, initially read from
 
445
      <filename>clients.conf</filename>, are persistent across
 
446
      restarts, and run-time changes will override settings in
 
447
      <filename>clients.conf</filename>.  However, if a setting is
 
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
449
      <filename>clients.conf</filename>, this will take precedence.
 
450
    </para>
 
451
  </refsect1>
 
452
  
 
453
  <refsect1 id="dbus_interface">
 
454
    <title>D-BUS INTERFACE</title>
 
455
    <para>
 
456
      The server will by default provide a D-Bus system bus interface.
 
457
      This interface will only be accessible by the root user or a
 
458
      Mandos-specific user, if such a user exists.  For documentation
 
459
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
460
    </para>
 
461
  </refsect1>
 
462
  
328
463
  <refsect1 id="exit_status">
329
464
    <title>EXIT STATUS</title>
330
465
    <para>
332
467
      critical error is encountered.
333
468
    </para>
334
469
  </refsect1>
335
 
 
 
470
  
336
471
  <refsect1 id="environment">
337
472
    <title>ENVIRONMENT</title>
338
473
    <variablelist>
339
474
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
475
        <term><envar>PATH</envar></term>
341
476
        <listitem>
342
477
          <para>
343
478
            To start the configured checker (see <xref
352
487
      </varlistentry>
353
488
    </variablelist>
354
489
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
490
  
 
491
  <refsect1 id="files">
357
492
    <title>FILES</title>
358
493
    <para>
359
494
      Use the <option>--configdir</option> option to change where
382
517
        </listitem>
383
518
      </varlistentry>
384
519
      <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>.
 
520
        <term><filename>/run/mandos.pid</filename></term>
 
521
        <listitem>
 
522
          <para>
 
523
            The file containing the process id of the
 
524
            <command>&COMMANDNAME;</command> process started last.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
 
532
        <term><filename
 
533
        class="directory">/var/lib/mandos</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            Directory where persistent state will be saved.  Change
 
537
            this with the <option>--statedir</option> option.  See
 
538
            also the <option>--no-restore</option> option.
390
539
          </para>
391
540
        </listitem>
392
541
      </varlistentry>
420
569
      backtrace.  This could be considered a feature.
421
570
    </para>
422
571
    <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
572
      There is no fine-grained control over logging and debug output.
435
573
    </para>
436
574
    <para>
437
 
      Debug mode is conflated with running in the foreground.
438
 
    </para>
439
 
    <para>
440
 
      The console log messages does not show a timestamp.
 
575
      This server does not check the expire time of clients’ OpenPGP
 
576
      keys.
441
577
    </para>
442
578
  </refsect1>
443
579
  
448
584
        Normal invocation needs no options:
449
585
      </para>
450
586
      <para>
451
 
        <userinput>mandos</userinput>
 
587
        <userinput>&COMMANDNAME;</userinput>
452
588
      </para>
453
589
    </informalexample>
454
590
    <informalexample>
455
591
      <para>
456
592
        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:
 
593
        the <filename class="directory">~/mandos</filename> directory,
 
594
        and use the Zeroconf service name <quote>Test</quote> to not
 
595
        collide with any other official Mandos server on this host:
460
596
      </para>
461
597
      <para>
462
598
 
463
599
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
600
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
601
 
466
602
      </para>
467
603
    </informalexample>
473
609
      <para>
474
610
 
475
611
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
612
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
613
 
478
614
      </para>
479
615
    </informalexample>
480
616
  </refsect1>
481
 
 
 
617
  
482
618
  <refsect1 id="security">
483
619
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
620
    <refsect2 id="server">
485
621
      <title>SERVER</title>
486
622
      <para>
487
623
        Running this <command>&COMMANDNAME;</command> server program
488
624
        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.
 
625
        computer running it.  The program switches to a non-root user
 
626
        soon after startup.
491
627
      </para>
492
628
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
629
    <refsect2 id="clients">
494
630
      <title>CLIENTS</title>
495
631
      <para>
496
632
        The server only gives out its stored data to clients which
503
639
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
640
        <manvolnum>5</manvolnum></citerefentry>)
505
641
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
642
        except the user starting the server (usually root).
507
643
      </para>
508
644
      <para>
509
645
        As detailed in <xref linkend="checking"/>, the status of all
511
647
        compromised if they are gone for too long.
512
648
      </para>
513
649
      <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
650
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
651
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
652
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
653
      </para>
534
654
    </refsect2>
535
655
  </refsect1>
536
 
 
 
656
  
537
657
  <refsect1 id="see_also">
538
658
    <title>SEE ALSO</title>
539
659
    <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>
 
660
      <citerefentry><refentrytitle>intro</refentrytitle>
 
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
663
      <manvolnum>5</manvolnum></citerefentry>,
 
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
665
      <manvolnum>5</manvolnum></citerefentry>,
 
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
668
      <citerefentry><refentrytitle>sh</refentrytitle>
 
669
      <manvolnum>1</manvolnum></citerefentry>
549
670
    </para>
550
671
    <variablelist>
551
672
      <varlistentry>
572
693
      </varlistentry>
573
694
      <varlistentry>
574
695
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
696
          <ulink url="http://www.gnu.org/software/gnutls/"
 
697
          >GnuTLS</ulink>
577
698
        </term>
578
699
      <listitem>
579
700
        <para>
585
706
      </varlistentry>
586
707
      <varlistentry>
587
708
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
709
          RFC 4291: <citetitle>IP Version 6 Addressing
 
710
          Architecture</citetitle>
591
711
        </term>
592
712
        <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>
 
713
          <variablelist>
 
714
            <varlistentry>
 
715
              <term>Section 2.2: <citetitle>Text Representation of
 
716
              Addresses</citetitle></term>
 
717
              <listitem><para/></listitem>
 
718
            </varlistentry>
 
719
            <varlistentry>
 
720
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
721
              Address</citetitle></term>
 
722
              <listitem><para/></listitem>
 
723
            </varlistentry>
 
724
            <varlistentry>
 
725
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
726
            Addresses</citetitle></term>
 
727
            <listitem>
 
728
              <para>
 
729
                The clients use IPv6 link-local addresses, which are
 
730
                immediately usable since a link-local addresses is
 
731
                automatically assigned to a network interfaces when it
 
732
                is brought up.
 
733
              </para>
 
734
            </listitem>
 
735
            </varlistentry>
 
736
          </variablelist>
599
737
        </listitem>
600
738
      </varlistentry>
601
739
      <varlistentry>
602
740
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
741
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
742
          Protocol Version 1.1</citetitle>
605
743
        </term>
606
744
      <listitem>
607
745
        <para>
611
749
      </varlistentry>
612
750
      <varlistentry>
613
751
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
752
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
753
        </term>
617
754
      <listitem>
618
755
        <para>
622
759
      </varlistentry>
623
760
      <varlistentry>
624
761
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
762
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
763
          Security</citetitle>
627
764
        </term>
628
765
      <listitem>
629
766
        <para>
635
772
    </variablelist>
636
773
  </refsect1>
637
774
</refentry>
 
775
<!-- Local Variables: -->
 
776
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
777
<!-- time-stamp-end: "[\"']>" -->
 
778
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
779
<!-- End: -->