/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2014-02-16 02:42:42 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 309.
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

Show diffs side-by-side

added added

removed removed

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