/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: 2008-08-25 03:53:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825035342-wheobopjfhf0hive
* Makefile (maintainer-clean): Also remove "confdir".
  (run-client): Also create a key.
  (run-server): Also create a local config including a client.
  (keydir/secring.gpg, keydir/pubring.gpg, keydir/seckey.txt
  keydir/pubkey.txt): New targets used by "run-client".
  (confdir/mandos.conf, confdir/clients.conf): New targets used by
                                               "run-server".

* mandos-keygen (KEYLENGTH): Changed default to "2048".

* mandos-keygen.xml (OPTIONS): Changed default value for "--length".

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