/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: 2008-08-27 01:18:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080827011825-ka3ni6xvy2ehi1y8
* .bzrignore: New.

* clients.conf ([foo]): Remove Radix-64 checksum.

* mandos (AvahiService.rename, server_state_changed,
          entry_group_state_changed): Make Avahi log messages more
                                      clear that they are about
                                      Zeroconf.
  (fingerprint): Use plain "0" instead of "ctypes.c_uint(0)".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2015-07-20">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
6
]>
9
7
 
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
  <refentryinfo>
 
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
12
    <productname>&COMMANDNAME;</productname>
 
13
    <productnumber>&VERSION;</productnumber>
17
14
    <authorgroup>
18
15
      <author>
19
16
        <firstname>Björn</firstname>
20
17
        <surname>Påhlsson</surname>
21
18
        <address>
22
 
          <email>belorn@recompile.se</email>
 
19
          <email>belorn@fukt.bsnet.se</email>
23
20
        </address>
24
21
      </author>
25
22
      <author>
26
23
        <firstname>Teddy</firstname>
27
24
        <surname>Hogeborn</surname>
28
25
        <address>
29
 
          <email>teddy@recompile.se</email>
 
26
          <email>teddy@fukt.bsnet.se</email>
30
27
        </address>
31
28
      </author>
32
29
    </authorgroup>
33
30
    <copyright>
34
31
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
32
      <holder>Teddy Hogeborn</holder>
41
33
      <holder>Björn Påhlsson</holder>
42
34
    </copyright>
43
 
    <xi:include href="legalnotice.xml"/>
 
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>
44
58
  </refentryinfo>
45
 
  
 
59
 
46
60
  <refmeta>
47
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
48
62
    <manvolnum>8</manvolnum>
51
65
  <refnamediv>
52
66
    <refname><command>&COMMANDNAME;</command></refname>
53
67
    <refpurpose>
54
 
      Gives encrypted passwords to authenticated Mandos clients
 
68
      Sends encrypted passwords to authenticated Mandos clients
55
69
    </refpurpose>
56
70
  </refnamediv>
57
 
  
 
71
 
58
72
  <refsynopsisdiv>
59
73
    <cmdsynopsis>
60
74
      <command>&COMMANDNAME;</command>
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>
 
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>
111
92
    </cmdsynopsis>
112
93
    <cmdsynopsis>
113
94
      <command>&COMMANDNAME;</command>
114
95
      <group choice="req">
115
 
        <arg choice="plain"><option>--help</option></arg>
116
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
117
98
      </group>
118
99
    </cmdsynopsis>
119
100
    <cmdsynopsis>
120
101
      <command>&COMMANDNAME;</command>
121
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
122
103
    </cmdsynopsis>
123
104
    <cmdsynopsis>
124
105
      <command>&COMMANDNAME;</command>
125
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
126
107
    </cmdsynopsis>
127
108
  </refsynopsisdiv>
128
 
  
 
109
 
129
110
  <refsect1 id="description">
130
111
    <title>DESCRIPTION</title>
131
112
    <para>
132
113
      <command>&COMMANDNAME;</command> is a server daemon which
133
114
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
144
123
    </para>
 
124
 
145
125
  </refsect1>
146
126
  
147
127
  <refsect1 id="purpose">
148
128
    <title>PURPOSE</title>
 
129
 
149
130
    <para>
150
131
      The purpose of this is to enable <emphasis>remote and unattended
151
132
      rebooting</emphasis> of client host computer with an
152
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
153
134
      linkend="overview"/> for details.
154
135
    </para>
 
136
 
155
137
  </refsect1>
156
138
  
157
139
  <refsect1 id="options">
158
140
    <title>OPTIONS</title>
 
141
 
159
142
    <variablelist>
160
143
      <varlistentry>
161
 
        <term><option>--help</option></term>
162
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
163
145
        <listitem>
164
146
          <para>
165
147
            Show a help message and exit
166
148
          </para>
167
149
        </listitem>
168
150
      </varlistentry>
169
 
      
 
151
 
170
152
      <varlistentry>
171
 
        <term><option>--interface</option>
172
 
        <replaceable>NAME</replaceable></term>
173
 
        <term><option>-i</option>
174
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
175
155
        <listitem>
176
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
177
157
        </listitem>
178
158
      </varlistentry>
179
 
      
 
159
 
180
160
      <varlistentry>
181
 
        <term><option>--address
182
 
        <replaceable>ADDRESS</replaceable></option></term>
183
 
        <term><option>-a
184
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
185
163
        <listitem>
186
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
187
165
        </listitem>
188
166
      </varlistentry>
189
 
      
 
167
 
190
168
      <varlistentry>
191
 
        <term><option>--port
192
 
        <replaceable>PORT</replaceable></option></term>
193
 
        <term><option>-p
194
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
195
171
        <listitem>
196
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
197
173
        </listitem>
198
174
      </varlistentry>
199
 
      
 
175
 
200
176
      <varlistentry>
201
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
202
178
        <listitem>
203
179
          <para>
204
180
            Run the server’s self-tests.  This includes any unit
206
182
          </para>
207
183
        </listitem>
208
184
      </varlistentry>
209
 
      
 
185
 
210
186
      <varlistentry>
211
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
212
188
        <listitem>
213
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
190
        </listitem>
215
191
      </varlistentry>
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>
 
192
 
 
193
      <varlistentry>
 
194
        <term><literal>--priority <replaceable>
 
195
        PRIORITY</replaceable></literal></term>
238
196
        <listitem>
239
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
240
198
        </listitem>
241
199
      </varlistentry>
242
 
      
 
200
 
243
201
      <varlistentry>
244
 
        <term><option>--servicename
245
 
        <replaceable>NAME</replaceable></option></term>
 
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
203
        </literal></term>
246
204
        <listitem>
247
205
          <xi:include href="mandos-options.xml"
248
206
                      xpointer="servicename"/>
249
207
        </listitem>
250
208
      </varlistentry>
251
 
      
 
209
 
252
210
      <varlistentry>
253
 
        <term><option>--configdir
254
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
255
213
        <listitem>
256
214
          <para>
257
215
            Directory to search for configuration files.  Default is
263
221
          </para>
264
222
        </listitem>
265
223
      </varlistentry>
266
 
      
 
224
 
267
225
      <varlistentry>
268
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
269
227
        <listitem>
270
228
          <para>
271
229
            Prints the program version and exit.
272
230
          </para>
273
231
        </listitem>
274
232
      </varlistentry>
275
 
      
276
 
      <varlistentry>
277
 
        <term><option>--no-dbus</option></term>
278
 
        <listitem>
279
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
280
 
          <para>
281
 
            See also <xref linkend="dbus_interface"/>.
282
 
          </para>
283
 
        </listitem>
284
 
      </varlistentry>
285
 
      
286
 
      <varlistentry>
287
 
        <term><option>--no-ipv6</option></term>
288
 
        <listitem>
289
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>--no-restore</option></term>
295
 
        <listitem>
296
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
297
 
          <para>
298
 
            See also <xref linkend="persistent_state"/>.
299
 
          </para>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
      
303
 
      <varlistentry>
304
 
        <term><option>--statedir
305
 
        <replaceable>DIRECTORY</replaceable></option></term>
306
 
        <listitem>
307
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
 
        </listitem>
309
 
      </varlistentry>
310
 
      
311
 
      <varlistentry>
312
 
        <term><option>--socket
313
 
        <replaceable>FD</replaceable></option></term>
314
 
        <listitem>
315
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--foreground</option></term>
321
 
        <listitem>
322
 
          <xi:include href="mandos-options.xml"
323
 
                      xpointer="foreground"/>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--no-zeroconf</option></term>
329
 
        <listitem>
330
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
233
    </variablelist>
335
234
  </refsect1>
336
 
  
 
235
 
337
236
  <refsect1 id="overview">
338
237
    <title>OVERVIEW</title>
339
238
    <xi:include href="overview.xml"/>
340
239
    <para>
341
240
      This program is the server part.  It is a normal server program
342
241
      and will run in a normal system environment, not in an initial
343
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
344
243
    </para>
345
244
  </refsect1>
346
 
  
 
245
 
347
246
  <refsect1 id="protocol">
348
247
    <title>NETWORK PROTOCOL</title>
349
248
    <para>
401
300
      </row>
402
301
    </tbody></tgroup></table>
403
302
  </refsect1>
404
 
  
 
303
 
405
304
  <refsect1 id="checking">
406
305
    <title>CHECKING</title>
407
306
    <para>
408
307
      The server will, by default, continually check that the clients
409
308
      are still up.  If a client has not been confirmed as being up
410
309
      for some time, the client is assumed to be compromised and is no
411
 
      longer eligible to receive the encrypted password.  (Manual
412
 
      intervention is required to re-enable a client.)  The timeout,
413
 
      extended timeout, checker program, and interval between checks
414
 
      can be configured both globally and per client; see
415
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
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>
 
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
416
314
      <manvolnum>5</manvolnum></citerefentry>.
417
315
    </para>
418
316
  </refsect1>
419
 
  
420
 
  <refsect1 id="approval">
421
 
    <title>APPROVAL</title>
422
 
    <para>
423
 
      The server can be configured to require manual approval for a
424
 
      client before it is sent its secret.  The delay to wait for such
425
 
      approval and the default action (approve or deny) can be
426
 
      configured both globally and per client; see <citerefentry>
427
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
428
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
429
 
      will be approved immediately without delay.
430
 
    </para>
431
 
    <para>
432
 
      This can be used to deny a client its secret if not manually
433
 
      approved within a specified time.  It can also be used to make
434
 
      the server delay before giving a client its secret, allowing
435
 
      optional manual denying of this specific client.
436
 
    </para>
437
 
    
438
 
  </refsect1>
439
 
  
 
317
 
440
318
  <refsect1 id="logging">
441
319
    <title>LOGGING</title>
442
320
    <para>
443
321
      The server will send log message with various severity levels to
444
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
445
323
      <option>--debug</option> option, it will log even more messages,
446
324
      and also show them on the console.
447
325
    </para>
448
326
  </refsect1>
449
 
  
450
 
  <refsect1 id="persistent_state">
451
 
    <title>PERSISTENT STATE</title>
452
 
    <para>
453
 
      Client settings, initially read from
454
 
      <filename>clients.conf</filename>, are persistent across
455
 
      restarts, and run-time changes will override settings in
456
 
      <filename>clients.conf</filename>.  However, if a setting is
457
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
 
      <filename>clients.conf</filename>, this will take precedence.
459
 
    </para>
460
 
  </refsect1>
461
 
  
462
 
  <refsect1 id="dbus_interface">
463
 
    <title>D-BUS INTERFACE</title>
464
 
    <para>
465
 
      The server will by default provide a D-Bus system bus interface.
466
 
      This interface will only be accessible by the root user or a
467
 
      Mandos-specific user, if such a user exists.  For documentation
468
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
469
 
    </para>
470
 
  </refsect1>
471
 
  
 
327
 
472
328
  <refsect1 id="exit_status">
473
329
    <title>EXIT STATUS</title>
474
330
    <para>
476
332
      critical error is encountered.
477
333
    </para>
478
334
  </refsect1>
479
 
  
 
335
 
480
336
  <refsect1 id="environment">
481
337
    <title>ENVIRONMENT</title>
482
338
    <variablelist>
483
339
      <varlistentry>
484
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
485
341
        <listitem>
486
342
          <para>
487
343
            To start the configured checker (see <xref
496
352
      </varlistentry>
497
353
    </variablelist>
498
354
  </refsect1>
499
 
  
500
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
501
357
    <title>FILES</title>
502
358
    <para>
503
359
      Use the <option>--configdir</option> option to change where
526
382
        </listitem>
527
383
      </varlistentry>
528
384
      <varlistentry>
529
 
        <term><filename>/run/mandos.pid</filename></term>
530
 
        <listitem>
531
 
          <para>
532
 
            The file containing the process id of the
533
 
            <command>&COMMANDNAME;</command> process started last.
534
 
            <emphasis >Note:</emphasis> If the <filename
535
 
            class="directory">/run</filename> directory does not
536
 
            exist, <filename>/var/run/mandos.pid</filename> will be
537
 
            used instead.
538
 
          </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
      <varlistentry>
542
 
        <term><filename class="devicefile">/dev/log</filename></term>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term><filename
546
 
        class="directory">/var/lib/mandos</filename></term>
547
 
        <listitem>
548
 
          <para>
549
 
            Directory where persistent state will be saved.  Change
550
 
            this with the <option>--statedir</option> option.  See
551
 
            also the <option>--no-restore</option> option.
 
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>.
552
390
          </para>
553
391
        </listitem>
554
392
      </varlistentry>
582
420
      backtrace.  This could be considered a feature.
583
421
    </para>
584
422
    <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>
585
434
      There is no fine-grained control over logging and debug output.
586
435
    </para>
587
436
    <para>
588
 
      This server does not check the expire time of clients’ OpenPGP
589
 
      keys.
 
437
      Debug mode is conflated with running in the foreground.
 
438
    </para>
 
439
    <para>
 
440
      The console log messages does not show a timestamp.
590
441
    </para>
591
442
  </refsect1>
592
443
  
597
448
        Normal invocation needs no options:
598
449
      </para>
599
450
      <para>
600
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
601
452
      </para>
602
453
    </informalexample>
603
454
    <informalexample>
604
455
      <para>
605
456
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
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:
609
460
      </para>
610
461
      <para>
611
462
 
612
463
<!-- do not wrap this line -->
613
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
614
465
 
615
466
      </para>
616
467
    </informalexample>
622
473
      <para>
623
474
 
624
475
<!-- do not wrap this line -->
625
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
626
477
 
627
478
      </para>
628
479
    </informalexample>
629
480
  </refsect1>
630
 
  
 
481
 
631
482
  <refsect1 id="security">
632
483
    <title>SECURITY</title>
633
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
634
485
      <title>SERVER</title>
635
486
      <para>
636
487
        Running this <command>&COMMANDNAME;</command> server program
637
488
        should not in itself present any security risk to the host
638
 
        computer running it.  The program switches to a non-root user
639
 
        soon after startup.
 
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
491
      </para>
641
492
    </refsect2>
642
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
643
494
      <title>CLIENTS</title>
644
495
      <para>
645
496
        The server only gives out its stored data to clients which
652
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
504
        <manvolnum>5</manvolnum></citerefentry>)
654
505
        <emphasis>must</emphasis> be made non-readable by anyone
655
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
656
507
      </para>
657
508
      <para>
658
509
        As detailed in <xref linkend="checking"/>, the status of all
660
511
        compromised if they are gone for too long.
661
512
      </para>
662
513
      <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>
663
530
        For more details on client-side security, see
664
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
665
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
666
533
      </para>
667
534
    </refsect2>
668
535
  </refsect1>
669
 
  
 
536
 
670
537
  <refsect1 id="see_also">
671
538
    <title>SEE ALSO</title>
672
539
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <manvolnum>1</manvolnum></citerefentry>
 
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>
683
549
    </para>
684
550
    <variablelist>
685
551
      <varlistentry>
706
572
      </varlistentry>
707
573
      <varlistentry>
708
574
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
575
          <ulink url="http://www.gnu.org/software/gnutls/"
 
576
          >GnuTLS</ulink>
710
577
        </term>
711
578
      <listitem>
712
579
        <para>
750
617
      </varlistentry>
751
618
      <varlistentry>
752
619
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
620
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
621
          Protocol Version 1.1</citetitle>
755
622
        </term>
756
623
      <listitem>
757
624
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
625
          TLS 1.1 is the protocol implemented by GnuTLS.
759
626
        </para>
760
627
      </listitem>
761
628
      </varlistentry>
771
638
      </varlistentry>
772
639
      <varlistentry>
773
640
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
641
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
642
          Security</citetitle>
776
643
        </term>
777
644
      <listitem>
778
645
        <para>
784
651
    </variablelist>
785
652
  </refsect1>
786
653
</refentry>
787
 
<!-- Local Variables: -->
788
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
789
 
<!-- time-stamp-end: "[\"']>" -->
790
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
791
 
<!-- End: -->