/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-24 06:17:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824061702-zxrru4r1vxmx4tuq
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
  (install-server, install-client): Use "install --directory" instead
                                    of mkdir.

* mandos-keygen: New options --subtype and --sublength.
  (trap): Added semicolons and backslashes.
  (gpg): Added "--enable-dsa2" to all invocations.

* mandos-keygen.xml: Changed single quotes to double quotes for
                     consistency.
  (/refentry/refentryinfo/copyright) Split copyright holders.
  (SYNOPSIS): Added "--subtype", "--sublength", "-s", and "-L".
  (OPTIONS): Document the subtype and sublength options.
  (SECURITY): Also note the "--subtype" and "--sublength" options.

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 "2013-10-26">
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>
 
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>
109
92
    </cmdsynopsis>
110
93
    <cmdsynopsis>
111
94
      <command>&COMMANDNAME;</command>
112
95
      <group choice="req">
113
 
        <arg choice="plain"><option>--help</option></arg>
114
 
        <arg choice="plain"><option>-h</option></arg>
 
96
        <arg choice="plain">-h</arg>
 
97
        <arg choice="plain">--help</arg>
115
98
      </group>
116
99
    </cmdsynopsis>
117
100
    <cmdsynopsis>
118
101
      <command>&COMMANDNAME;</command>
119
 
      <arg choice="plain"><option>--version</option></arg>
 
102
      <arg choice="plain">--version</arg>
120
103
    </cmdsynopsis>
121
104
    <cmdsynopsis>
122
105
      <command>&COMMANDNAME;</command>
123
 
      <arg choice="plain"><option>--check</option></arg>
 
106
      <arg choice="plain">--check</arg>
124
107
    </cmdsynopsis>
125
108
  </refsynopsisdiv>
126
 
  
 
109
 
127
110
  <refsect1 id="description">
128
111
    <title>DESCRIPTION</title>
129
112
    <para>
130
113
      <command>&COMMANDNAME;</command> is a server daemon which
131
114
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
142
123
    </para>
 
124
 
143
125
  </refsect1>
144
126
  
145
127
  <refsect1 id="purpose">
146
128
    <title>PURPOSE</title>
 
129
 
147
130
    <para>
148
131
      The purpose of this is to enable <emphasis>remote and unattended
149
132
      rebooting</emphasis> of client host computer with an
150
133
      <emphasis>encrypted root file system</emphasis>.  See <xref
151
134
      linkend="overview"/> for details.
152
135
    </para>
 
136
 
153
137
  </refsect1>
154
138
  
155
139
  <refsect1 id="options">
156
140
    <title>OPTIONS</title>
 
141
 
157
142
    <variablelist>
158
143
      <varlistentry>
159
 
        <term><option>--help</option></term>
160
 
        <term><option>-h</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
161
145
        <listitem>
162
146
          <para>
163
147
            Show a help message and exit
164
148
          </para>
165
149
        </listitem>
166
150
      </varlistentry>
167
 
      
 
151
 
168
152
      <varlistentry>
169
 
        <term><option>--interface</option>
170
 
        <replaceable>NAME</replaceable></term>
171
 
        <term><option>-i</option>
172
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
173
155
        <listitem>
174
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
175
157
        </listitem>
176
158
      </varlistentry>
177
 
      
 
159
 
178
160
      <varlistentry>
179
 
        <term><option>--address
180
 
        <replaceable>ADDRESS</replaceable></option></term>
181
 
        <term><option>-a
182
 
        <replaceable>ADDRESS</replaceable></option></term>
 
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
162
        ADDRESS</replaceable></literal></term>
183
163
        <listitem>
184
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
185
165
        </listitem>
186
166
      </varlistentry>
187
 
      
 
167
 
188
168
      <varlistentry>
189
 
        <term><option>--port
190
 
        <replaceable>PORT</replaceable></option></term>
191
 
        <term><option>-p
192
 
        <replaceable>PORT</replaceable></option></term>
 
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
170
        PORT</replaceable></literal></term>
193
171
        <listitem>
194
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
195
173
        </listitem>
196
174
      </varlistentry>
197
 
      
 
175
 
198
176
      <varlistentry>
199
 
        <term><option>--check</option></term>
 
177
        <term><literal>--check</literal></term>
200
178
        <listitem>
201
179
          <para>
202
180
            Run the server’s self-tests.  This includes any unit
204
182
          </para>
205
183
        </listitem>
206
184
      </varlistentry>
207
 
      
 
185
 
208
186
      <varlistentry>
209
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
210
188
        <listitem>
211
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
212
190
        </listitem>
213
191
      </varlistentry>
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>
 
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>
245
204
        <listitem>
246
205
          <xi:include href="mandos-options.xml"
247
206
                      xpointer="servicename"/>
248
207
        </listitem>
249
208
      </varlistentry>
250
 
      
 
209
 
251
210
      <varlistentry>
252
 
        <term><option>--configdir
253
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
211
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
212
        </literal></term>
254
213
        <listitem>
255
214
          <para>
256
215
            Directory to search for configuration files.  Default is
262
221
          </para>
263
222
        </listitem>
264
223
      </varlistentry>
265
 
      
 
224
 
266
225
      <varlistentry>
267
 
        <term><option>--version</option></term>
 
226
        <term><literal>--version</literal></term>
268
227
        <listitem>
269
228
          <para>
270
229
            Prints the program version and exit.
271
230
          </para>
272
231
        </listitem>
273
232
      </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
 
      
326
233
    </variablelist>
327
234
  </refsect1>
328
 
  
 
235
 
329
236
  <refsect1 id="overview">
330
237
    <title>OVERVIEW</title>
331
238
    <xi:include href="overview.xml"/>
332
239
    <para>
333
240
      This program is the server part.  It is a normal server program
334
241
      and will run in a normal system environment, not in an initial
335
 
      <acronym>RAM</acronym> disk environment.
 
242
      RAM disk environment.
336
243
    </para>
337
244
  </refsect1>
338
 
  
 
245
 
339
246
  <refsect1 id="protocol">
340
247
    <title>NETWORK PROTOCOL</title>
341
248
    <para>
393
300
      </row>
394
301
    </tbody></tgroup></table>
395
302
  </refsect1>
396
 
  
 
303
 
397
304
  <refsect1 id="checking">
398
305
    <title>CHECKING</title>
399
306
    <para>
400
307
      The server will, by default, continually check that the clients
401
308
      are still up.  If a client has not been confirmed as being up
402
309
      for some time, the client is assumed to be compromised and is no
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>
 
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>
408
314
      <manvolnum>5</manvolnum></citerefentry>.
409
315
    </para>
410
316
  </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>
419
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
430
 
  </refsect1>
431
 
  
 
317
 
432
318
  <refsect1 id="logging">
433
319
    <title>LOGGING</title>
434
320
    <para>
435
321
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
322
      <filename>/dev/log</filename>.  With the
437
323
      <option>--debug</option> option, it will log even more messages,
438
324
      and also show them on the console.
439
325
    </para>
440
326
  </refsect1>
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
 
  
 
327
 
464
328
  <refsect1 id="exit_status">
465
329
    <title>EXIT STATUS</title>
466
330
    <para>
468
332
      critical error is encountered.
469
333
    </para>
470
334
  </refsect1>
471
 
  
 
335
 
472
336
  <refsect1 id="environment">
473
337
    <title>ENVIRONMENT</title>
474
338
    <variablelist>
475
339
      <varlistentry>
476
 
        <term><envar>PATH</envar></term>
 
340
        <term><varname>PATH</varname></term>
477
341
        <listitem>
478
342
          <para>
479
343
            To start the configured checker (see <xref
488
352
      </varlistentry>
489
353
    </variablelist>
490
354
  </refsect1>
491
 
  
492
 
  <refsect1 id="files">
 
355
 
 
356
  <refsect1 id="file">
493
357
    <title>FILES</title>
494
358
    <para>
495
359
      Use the <option>--configdir</option> option to change where
518
382
        </listitem>
519
383
      </varlistentry>
520
384
      <varlistentry>
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.
 
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>.
544
390
          </para>
545
391
        </listitem>
546
392
      </varlistentry>
574
420
      backtrace.  This could be considered a feature.
575
421
    </para>
576
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>
577
434
      There is no fine-grained control over logging and debug output.
578
435
    </para>
579
436
    <para>
580
 
      This server does not check the expire time of clients’ OpenPGP
581
 
      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.
582
441
    </para>
583
442
  </refsect1>
584
443
  
589
448
        Normal invocation needs no options:
590
449
      </para>
591
450
      <para>
592
 
        <userinput>&COMMANDNAME;</userinput>
 
451
        <userinput>mandos</userinput>
593
452
      </para>
594
453
    </informalexample>
595
454
    <informalexample>
596
455
      <para>
597
456
        Run the server in debug mode, read configuration files from
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:
 
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:
601
460
      </para>
602
461
      <para>
603
462
 
604
463
<!-- do not wrap this line -->
605
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
464
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
606
465
 
607
466
      </para>
608
467
    </informalexample>
614
473
      <para>
615
474
 
616
475
<!-- do not wrap this line -->
617
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
618
477
 
619
478
      </para>
620
479
    </informalexample>
621
480
  </refsect1>
622
 
  
 
481
 
623
482
  <refsect1 id="security">
624
483
    <title>SECURITY</title>
625
 
    <refsect2 id="server">
 
484
    <refsect2 id="SERVER">
626
485
      <title>SERVER</title>
627
486
      <para>
628
487
        Running this <command>&COMMANDNAME;</command> server program
629
488
        should not in itself present any security risk to the host
630
 
        computer running it.  The program switches to a non-root user
631
 
        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.
632
491
      </para>
633
492
    </refsect2>
634
 
    <refsect2 id="clients">
 
493
    <refsect2 id="CLIENTS">
635
494
      <title>CLIENTS</title>
636
495
      <para>
637
496
        The server only gives out its stored data to clients which
644
503
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
504
        <manvolnum>5</manvolnum></citerefentry>)
646
505
        <emphasis>must</emphasis> be made non-readable by anyone
647
 
        except the user starting the server (usually root).
 
506
        except the user running the server.
648
507
      </para>
649
508
      <para>
650
509
        As detailed in <xref linkend="checking"/>, the status of all
652
511
        compromised if they are gone for too long.
653
512
      </para>
654
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>
655
530
        For more details on client-side security, see
656
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
531
        <citerefentry><refentrytitle>password-request</refentrytitle>
657
532
        <manvolnum>8mandos</manvolnum></citerefentry>.
658
533
      </para>
659
534
    </refsect2>
660
535
  </refsect1>
661
 
  
 
536
 
662
537
  <refsect1 id="see_also">
663
538
    <title>SEE ALSO</title>
664
539
    <para>
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>
 
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>password-request</refentrytitle>
 
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
548
      </citerefentry>
675
549
    </para>
676
550
    <variablelist>
677
551
      <varlistentry>
698
572
      </varlistentry>
699
573
      <varlistentry>
700
574
        <term>
701
 
          <ulink url="http://www.gnu.org/software/gnutls/"
702
 
          >GnuTLS</ulink>
 
575
          <ulink
 
576
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
703
577
        </term>
704
578
      <listitem>
705
579
        <para>
711
585
      </varlistentry>
712
586
      <varlistentry>
713
587
        <term>
714
 
          RFC 4291: <citetitle>IP Version 6 Addressing
715
 
          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>
716
591
        </term>
717
592
        <listitem>
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>
 
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>
742
599
        </listitem>
743
600
      </varlistentry>
744
601
      <varlistentry>
745
602
        <term>
746
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
747
 
          Protocol Version 1.1</citetitle>
 
603
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
604
          (TLS) Protocol Version 1.1</citetitle></citation>
748
605
        </term>
749
606
      <listitem>
750
607
        <para>
754
611
      </varlistentry>
755
612
      <varlistentry>
756
613
        <term>
757
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
614
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
615
          Format</citetitle></citation>
758
616
        </term>
759
617
      <listitem>
760
618
        <para>
764
622
      </varlistentry>
765
623
      <varlistentry>
766
624
        <term>
767
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
768
 
          Security</citetitle>
 
625
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
626
          Transport Layer Security</citetitle></citation>
769
627
        </term>
770
628
      <listitem>
771
629
        <para>
777
635
    </variablelist>
778
636
  </refsect1>
779
637
</refentry>
780
 
<!-- Local Variables: -->
781
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
782
 
<!-- time-stamp-end: "[\"']>" -->
783
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
784
 
<!-- End: -->