/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2014-07-25 23:39:49 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725233949-rcg0bbj7q3uweh6p
Use the new .total_seconds() method on datetime.timedelta objects.

* mandos (timedelta_to_milliseconds): Removed.  All callers changed to
                                      use ".total_seconds() * 1000".
  (Client.timeout_milliseconds): - '' -
  (Client.extended_timeout_milliseconds): - '' -
  (Client.interval_milliseconds): - '' -
  (Client.approval_delay_milliseconds): - '' -
* mandos-ctl (timedelta_to_milliseconds): - '' -

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