/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: 2012-06-24 03:45:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20120624034555-7p0dtbpsz0dgsn4d
* mandos (Client.start_checker): Add comment.  Break long line.

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