/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: 2017-02-23 21:14:58 UTC
  • mfrom: (237.4.90 release)
  • Revision ID: teddy@recompile.se-20170223211458-2rv7ec5bxmk4ts81
Merge from release branch

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 "2017-02-23">
 
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>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
32
44
      <holder>Teddy Hogeborn</holder>
33
45
      <holder>Björn Påhlsson</holder>
34
46
    </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>
 
47
    <xi:include href="legalnotice.xml"/>
58
48
  </refentryinfo>
59
 
 
 
49
  
60
50
  <refmeta>
61
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
52
    <manvolnum>8</manvolnum>
65
55
  <refnamediv>
66
56
    <refname><command>&COMMANDNAME;</command></refname>
67
57
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
58
      Gives encrypted passwords to authenticated Mandos clients
69
59
    </refpurpose>
70
60
  </refnamediv>
71
 
 
 
61
  
72
62
  <refsynopsisdiv>
73
63
    <cmdsynopsis>
74
64
      <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>
 
65
      <group>
 
66
        <arg choice="plain"><option>--interface
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-i
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--address
 
74
        <replaceable>ADDRESS</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-a
 
76
        <replaceable>ADDRESS</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <group>
 
80
        <arg choice="plain"><option>--port
 
81
        <replaceable>PORT</replaceable></option></arg>
 
82
        <arg choice="plain"><option>-p
 
83
        <replaceable>PORT</replaceable></option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <arg><option>--priority
 
87
      <replaceable>PRIORITY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--servicename
 
90
      <replaceable>NAME</replaceable></option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--configdir
 
93
      <replaceable>DIRECTORY</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--debug</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--debuglevel
 
98
      <replaceable>LEVEL</replaceable></option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-dbus</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--no-ipv6</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--no-restore</option></arg>
 
105
      <sbr/>
 
106
      <arg><option>--statedir
 
107
      <replaceable>DIRECTORY</replaceable></option></arg>
 
108
      <sbr/>
 
109
      <arg><option>--socket
 
110
      <replaceable>FD</replaceable></option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--foreground</option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--no-zeroconf</option></arg>
92
115
    </cmdsynopsis>
93
116
    <cmdsynopsis>
94
117
      <command>&COMMANDNAME;</command>
95
118
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
119
        <arg choice="plain"><option>--help</option></arg>
 
120
        <arg choice="plain"><option>-h</option></arg>
98
121
      </group>
99
122
    </cmdsynopsis>
100
123
    <cmdsynopsis>
101
124
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
125
      <arg choice="plain"><option>--version</option></arg>
103
126
    </cmdsynopsis>
104
127
    <cmdsynopsis>
105
128
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
129
      <arg choice="plain"><option>--check</option></arg>
107
130
    </cmdsynopsis>
108
131
  </refsynopsisdiv>
109
 
 
 
132
  
110
133
  <refsect1 id="description">
111
134
    <title>DESCRIPTION</title>
112
135
    <para>
113
136
      <command>&COMMANDNAME;</command> is a server daemon which
114
137
      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.
 
138
      client host computers. For an introduction, see
 
139
      <citerefentry><refentrytitle>intro</refentrytitle>
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
141
      uses Zeroconf to announce itself on the local network, and uses
 
142
      TLS to communicate securely with and to authenticate the
 
143
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
144
      use IPv6 link-local addresses, since the clients will probably
 
145
      not have any other addresses configured (see <xref
 
146
      linkend="overview"/>).  Any authenticated client is then given
 
147
      the stored pre-encrypted password for that specific client.
123
148
    </para>
124
 
 
125
149
  </refsect1>
126
150
  
127
151
  <refsect1 id="purpose">
128
152
    <title>PURPOSE</title>
129
 
 
130
153
    <para>
131
154
      The purpose of this is to enable <emphasis>remote and unattended
132
155
      rebooting</emphasis> of client host computer with an
133
156
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
157
      linkend="overview"/> for details.
135
158
    </para>
136
 
 
137
159
  </refsect1>
138
160
  
139
161
  <refsect1 id="options">
140
162
    <title>OPTIONS</title>
141
 
 
142
163
    <variablelist>
143
164
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
165
        <term><option>--help</option></term>
 
166
        <term><option>-h</option></term>
145
167
        <listitem>
146
168
          <para>
147
169
            Show a help message and exit
148
170
          </para>
149
171
        </listitem>
150
172
      </varlistentry>
151
 
 
 
173
      
152
174
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
175
        <term><option>--interface</option>
 
176
        <replaceable>NAME</replaceable></term>
 
177
        <term><option>-i</option>
 
178
        <replaceable>NAME</replaceable></term>
155
179
        <listitem>
156
180
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
181
        </listitem>
158
182
      </varlistentry>
159
 
 
 
183
      
160
184
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
185
        <term><option>--address
 
186
        <replaceable>ADDRESS</replaceable></option></term>
 
187
        <term><option>-a
 
188
        <replaceable>ADDRESS</replaceable></option></term>
163
189
        <listitem>
164
190
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
191
        </listitem>
166
192
      </varlistentry>
167
 
 
 
193
      
168
194
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
195
        <term><option>--port
 
196
        <replaceable>PORT</replaceable></option></term>
 
197
        <term><option>-p
 
198
        <replaceable>PORT</replaceable></option></term>
171
199
        <listitem>
172
200
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
201
        </listitem>
174
202
      </varlistentry>
175
 
 
 
203
      
176
204
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
205
        <term><option>--check</option></term>
178
206
        <listitem>
179
207
          <para>
180
208
            Run the server’s self-tests.  This includes any unit
182
210
          </para>
183
211
        </listitem>
184
212
      </varlistentry>
185
 
 
 
213
      
186
214
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
215
        <term><option>--debug</option></term>
188
216
        <listitem>
189
217
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
218
        </listitem>
191
219
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
220
      
 
221
      <varlistentry>
 
222
        <term><option>--debuglevel
 
223
        <replaceable>LEVEL</replaceable></option></term>
 
224
        <listitem>
 
225
          <para>
 
226
            Set the debugging log level.
 
227
            <replaceable>LEVEL</replaceable> is a string, one of
 
228
            <quote><literal>CRITICAL</literal></quote>,
 
229
            <quote><literal>ERROR</literal></quote>,
 
230
            <quote><literal>WARNING</literal></quote>,
 
231
            <quote><literal>INFO</literal></quote>, or
 
232
            <quote><literal>DEBUG</literal></quote>, in order of
 
233
            increasing verbosity.  The default level is
 
234
            <quote><literal>WARNING</literal></quote>.
 
235
          </para>
 
236
        </listitem>
 
237
      </varlistentry>
 
238
      
 
239
      <varlistentry>
 
240
        <term><option>--priority <replaceable>
 
241
        PRIORITY</replaceable></option></term>
196
242
        <listitem>
197
243
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
244
        </listitem>
199
245
      </varlistentry>
200
 
 
 
246
      
201
247
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
248
        <term><option>--servicename
 
249
        <replaceable>NAME</replaceable></option></term>
204
250
        <listitem>
205
251
          <xi:include href="mandos-options.xml"
206
252
                      xpointer="servicename"/>
207
253
        </listitem>
208
254
      </varlistentry>
209
 
 
 
255
      
210
256
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
257
        <term><option>--configdir
 
258
        <replaceable>DIRECTORY</replaceable></option></term>
213
259
        <listitem>
214
260
          <para>
215
261
            Directory to search for configuration files.  Default is
221
267
          </para>
222
268
        </listitem>
223
269
      </varlistentry>
224
 
 
 
270
      
225
271
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
272
        <term><option>--version</option></term>
227
273
        <listitem>
228
274
          <para>
229
275
            Prints the program version and exit.
230
276
          </para>
231
277
        </listitem>
232
278
      </varlistentry>
 
279
      
 
280
      <varlistentry>
 
281
        <term><option>--no-dbus</option></term>
 
282
        <listitem>
 
283
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
284
          <para>
 
285
            See also <xref linkend="dbus_interface"/>.
 
286
          </para>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      
 
290
      <varlistentry>
 
291
        <term><option>--no-ipv6</option></term>
 
292
        <listitem>
 
293
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
294
        </listitem>
 
295
      </varlistentry>
 
296
      
 
297
      <varlistentry>
 
298
        <term><option>--no-restore</option></term>
 
299
        <listitem>
 
300
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
301
          <para>
 
302
            See also <xref linkend="persistent_state"/>.
 
303
          </para>
 
304
        </listitem>
 
305
      </varlistentry>
 
306
      
 
307
      <varlistentry>
 
308
        <term><option>--statedir
 
309
        <replaceable>DIRECTORY</replaceable></option></term>
 
310
        <listitem>
 
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
312
        </listitem>
 
313
      </varlistentry>
 
314
      
 
315
      <varlistentry>
 
316
        <term><option>--socket
 
317
        <replaceable>FD</replaceable></option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>--foreground</option></term>
 
325
        <listitem>
 
326
          <xi:include href="mandos-options.xml"
 
327
                      xpointer="foreground"/>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--no-zeroconf</option></term>
 
333
        <listitem>
 
334
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
335
        </listitem>
 
336
      </varlistentry>
 
337
      
233
338
    </variablelist>
234
339
  </refsect1>
235
 
 
 
340
  
236
341
  <refsect1 id="overview">
237
342
    <title>OVERVIEW</title>
238
343
    <xi:include href="overview.xml"/>
239
344
    <para>
240
345
      This program is the server part.  It is a normal server program
241
346
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
347
      <acronym>RAM</acronym> disk environment.
243
348
    </para>
244
349
  </refsect1>
245
 
 
 
350
  
246
351
  <refsect1 id="protocol">
247
352
    <title>NETWORK PROTOCOL</title>
248
353
    <para>
300
405
      </row>
301
406
    </tbody></tgroup></table>
302
407
  </refsect1>
303
 
 
 
408
  
304
409
  <refsect1 id="checking">
305
410
    <title>CHECKING</title>
306
411
    <para>
307
412
      The server will, by default, continually check that the clients
308
413
      are still up.  If a client has not been confirmed as being up
309
414
      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>
 
415
      longer eligible to receive the encrypted password.  (Manual
 
416
      intervention is required to re-enable a client.)  The timeout,
 
417
      extended timeout, checker program, and interval between checks
 
418
      can be configured both globally and per client; see
 
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
420
      <manvolnum>5</manvolnum></citerefentry>.
 
421
    </para>
 
422
  </refsect1>
 
423
  
 
424
  <refsect1 id="approval">
 
425
    <title>APPROVAL</title>
 
426
    <para>
 
427
      The server can be configured to require manual approval for a
 
428
      client before it is sent its secret.  The delay to wait for such
 
429
      approval and the default action (approve or deny) can be
 
430
      configured both globally and per client; see <citerefentry>
313
431
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
432
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
433
      will be approved immediately without delay.
 
434
    </para>
 
435
    <para>
 
436
      This can be used to deny a client its secret if not manually
 
437
      approved within a specified time.  It can also be used to make
 
438
      the server delay before giving a client its secret, allowing
 
439
      optional manual denying of this specific client.
 
440
    </para>
 
441
    
316
442
  </refsect1>
317
 
 
 
443
  
318
444
  <refsect1 id="logging">
319
445
    <title>LOGGING</title>
320
446
    <para>
321
447
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
448
      <filename class="devicefile">/dev/log</filename>.  With the
323
449
      <option>--debug</option> option, it will log even more messages,
324
450
      and also show them on the console.
325
451
    </para>
326
452
  </refsect1>
327
 
 
 
453
  
 
454
  <refsect1 id="persistent_state">
 
455
    <title>PERSISTENT STATE</title>
 
456
    <para>
 
457
      Client settings, initially read from
 
458
      <filename>clients.conf</filename>, are persistent across
 
459
      restarts, and run-time changes will override settings in
 
460
      <filename>clients.conf</filename>.  However, if a setting is
 
461
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
462
      <filename>clients.conf</filename>, this will take precedence.
 
463
    </para>
 
464
  </refsect1>
 
465
  
 
466
  <refsect1 id="dbus_interface">
 
467
    <title>D-BUS INTERFACE</title>
 
468
    <para>
 
469
      The server will by default provide a D-Bus system bus interface.
 
470
      This interface will only be accessible by the root user or a
 
471
      Mandos-specific user, if such a user exists.  For documentation
 
472
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
473
    </para>
 
474
  </refsect1>
 
475
  
328
476
  <refsect1 id="exit_status">
329
477
    <title>EXIT STATUS</title>
330
478
    <para>
332
480
      critical error is encountered.
333
481
    </para>
334
482
  </refsect1>
335
 
 
 
483
  
336
484
  <refsect1 id="environment">
337
485
    <title>ENVIRONMENT</title>
338
486
    <variablelist>
339
487
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
488
        <term><envar>PATH</envar></term>
341
489
        <listitem>
342
490
          <para>
343
491
            To start the configured checker (see <xref
352
500
      </varlistentry>
353
501
    </variablelist>
354
502
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
503
  
 
504
  <refsect1 id="files">
357
505
    <title>FILES</title>
358
506
    <para>
359
507
      Use the <option>--configdir</option> option to change where
382
530
        </listitem>
383
531
      </varlistentry>
384
532
      <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>.
390
 
          </para>
391
 
        </listitem>
392
 
      </varlistentry>
393
 
      <varlistentry>
394
 
        <term><filename>/dev/log</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            The file containing the process id of the
 
537
            <command>&COMMANDNAME;</command> process started last.
 
538
            <emphasis >Note:</emphasis> If the <filename
 
539
            class="directory">/run</filename> directory does not
 
540
            exist, <filename>/var/run/mandos.pid</filename> will be
 
541
            used instead.
 
542
          </para>
 
543
        </listitem>
 
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.
 
553
          </para>
 
554
        </listitem>
 
555
      </varlistentry>
 
556
      <varlistentry>
 
557
        <term><filename class="devicefile">/dev/log</filename></term>
395
558
        <listitem>
396
559
          <para>
397
560
            The Unix domain socket to where local syslog messages are
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.
441
 
    </para>
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
 
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
442
593
  </refsect1>
443
594
  
444
595
  <refsect1 id="example">
448
599
        Normal invocation needs no options:
449
600
      </para>
450
601
      <para>
451
 
        <userinput>mandos</userinput>
 
602
        <userinput>&COMMANDNAME;</userinput>
452
603
      </para>
453
604
    </informalexample>
454
605
    <informalexample>
455
606
      <para>
456
607
        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:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
460
611
      </para>
461
612
      <para>
462
613
 
463
614
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
615
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
616
 
466
617
      </para>
467
618
    </informalexample>
473
624
      <para>
474
625
 
475
626
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
627
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
628
 
478
629
      </para>
479
630
    </informalexample>
480
631
  </refsect1>
481
 
 
 
632
  
482
633
  <refsect1 id="security">
483
634
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
635
    <refsect2 id="server">
485
636
      <title>SERVER</title>
486
637
      <para>
487
638
        Running this <command>&COMMANDNAME;</command> server program
488
639
        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.
 
640
        computer running it.  The program switches to a non-root user
 
641
        soon after startup.
491
642
      </para>
492
643
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
644
    <refsect2 id="clients">
494
645
      <title>CLIENTS</title>
495
646
      <para>
496
647
        The server only gives out its stored data to clients which
503
654
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
655
        <manvolnum>5</manvolnum></citerefentry>)
505
656
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
657
        except the user starting the server (usually root).
507
658
      </para>
508
659
      <para>
509
660
        As detailed in <xref linkend="checking"/>, the status of all
511
662
        compromised if they are gone for too long.
512
663
      </para>
513
664
      <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
665
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
668
      </para>
534
669
    </refsect2>
535
670
  </refsect1>
536
 
 
 
671
  
537
672
  <refsect1 id="see_also">
538
673
    <title>SEE ALSO</title>
539
674
    <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>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
549
685
    </para>
550
686
    <variablelist>
551
687
      <varlistentry>
572
708
      </varlistentry>
573
709
      <varlistentry>
574
710
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">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 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
605
757
        </term>
606
758
      <listitem>
607
759
        <para>
608
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
609
761
        </para>
610
762
      </listitem>
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 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</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: -->