/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: teddy at bsnet
  • Date: 2010-09-27 16:27:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927162713-jucnyd63612ximvw
* mandos-monitor: Change key for removing a client from "r" to "R".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
7
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
8
8
]>
9
9
 
10
 
<refentry>
11
 
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
40
    <xi:include href="legalnotice.xml"/>
60
41
  </refentryinfo>
61
 
 
 
42
  
62
43
  <refmeta>
63
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
45
    <manvolnum>8</manvolnum>
67
48
  <refnamediv>
68
49
    <refname><command>&COMMANDNAME;</command></refname>
69
50
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
51
      Gives encrypted passwords to authenticated Mandos clients
71
52
    </refpurpose>
72
53
  </refnamediv>
73
 
 
 
54
  
74
55
  <refsynopsisdiv>
75
56
    <cmdsynopsis>
76
57
      <command>&COMMANDNAME;</command>
77
 
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
 
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
 
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
 
      <arg choice='opt'>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
 
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
 
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
 
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
 
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
 
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
 
      <arg choice='opt'>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <arg choice='plain'>--help</arg>
98
 
    </cmdsynopsis>
99
 
    <cmdsynopsis>
100
 
      <command>&COMMANDNAME;</command>
101
 
      <arg choice='plain'>--version</arg>
102
 
    </cmdsynopsis>
103
 
    <cmdsynopsis>
104
 
      <command>&COMMANDNAME;</command>
105
 
      <arg choice='plain'>--check</arg>
 
58
      <group>
 
59
        <arg choice="plain"><option>--interface
 
60
        <replaceable>NAME</replaceable></option></arg>
 
61
        <arg choice="plain"><option>-i
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
      </group>
 
64
      <sbr/>
 
65
      <group>
 
66
        <arg choice="plain"><option>--address
 
67
        <replaceable>ADDRESS</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-a
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
      </group>
 
71
      <sbr/>
 
72
      <group>
 
73
        <arg choice="plain"><option>--port
 
74
        <replaceable>PORT</replaceable></option></arg>
 
75
        <arg choice="plain"><option>-p
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
      </group>
 
78
      <sbr/>
 
79
      <arg><option>--priority
 
80
      <replaceable>PRIORITY</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--servicename
 
83
      <replaceable>NAME</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--configdir
 
86
      <replaceable>DIRECTORY</replaceable></option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--debug</option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <group choice="req">
 
97
        <arg choice="plain"><option>--help</option></arg>
 
98
        <arg choice="plain"><option>-h</option></arg>
 
99
      </group>
 
100
    </cmdsynopsis>
 
101
    <cmdsynopsis>
 
102
      <command>&COMMANDNAME;</command>
 
103
      <arg choice="plain"><option>--version</option></arg>
 
104
    </cmdsynopsis>
 
105
    <cmdsynopsis>
 
106
      <command>&COMMANDNAME;</command>
 
107
      <arg choice="plain"><option>--check</option></arg>
106
108
    </cmdsynopsis>
107
109
  </refsynopsisdiv>
108
 
 
 
110
  
109
111
  <refsect1 id="description">
110
112
    <title>DESCRIPTION</title>
111
113
    <para>
112
114
      <command>&COMMANDNAME;</command> is a server daemon which
113
115
      handles incoming request for passwords for a pre-defined list of
114
116
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
117
      announce itself on the local network, and uses TLS to
 
118
      communicate securely with and to authenticate the clients.  The
 
119
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
120
      link-local addresses, since the clients will probably not have
 
121
      any other addresses configured (see <xref linkend="overview"/>).
 
122
      Any authenticated client is then given the stored pre-encrypted
 
123
      password for that specific client.
121
124
    </para>
122
 
 
123
125
  </refsect1>
124
126
  
125
127
  <refsect1 id="purpose">
126
128
    <title>PURPOSE</title>
127
 
 
128
129
    <para>
129
130
      The purpose of this is to enable <emphasis>remote and unattended
130
 
      rebooting</emphasis> of any client host computer with an
131
 
      <emphasis>encrypted root file system</emphasis>.  The client
132
 
      host computer should start a Mandos client in the initial RAM
133
 
      disk environment, the Mandos client program communicates with
134
 
      this server program to get an encrypted password, which is then
135
 
      decrypted and used to unlock the encrypted root file system.
136
 
      The client host computer can then continue its boot sequence
137
 
      normally.
 
131
      rebooting</emphasis> of client host computer with an
 
132
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
133
      linkend="overview"/> for details.
138
134
    </para>
139
 
 
140
135
  </refsect1>
141
136
  
142
137
  <refsect1 id="options">
143
138
    <title>OPTIONS</title>
144
 
 
145
139
    <variablelist>
146
140
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
141
        <term><option>--help</option></term>
 
142
        <term><option>-h</option></term>
148
143
        <listitem>
149
144
          <para>
150
145
            Show a help message and exit
151
146
          </para>
152
147
        </listitem>
153
148
      </varlistentry>
154
 
 
155
 
      <varlistentry>
156
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
157
 
        IF</replaceable></literal></term>
158
 
        <listitem>
159
 
          <para>
160
 
            Only announce the server and listen to requests on network
161
 
            interface <replaceable>IF</replaceable>.  Default is to
162
 
            use all available interfaces.
163
 
          </para>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
 
167
 
      <varlistentry>
168
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
 
        ADDRESS</replaceable></literal></term>
170
 
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
149
      
 
150
      <varlistentry>
 
151
        <term><option>--interface</option>
 
152
        <replaceable>NAME</replaceable></term>
 
153
        <term><option>-i</option>
 
154
        <replaceable>NAME</replaceable></term>
 
155
        <listitem>
 
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
157
        </listitem>
 
158
      </varlistentry>
 
159
      
 
160
      <varlistentry>
 
161
        <term><option>--address
 
162
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><option>-a
 
164
        <replaceable>ADDRESS</replaceable></option></term>
 
165
        <listitem>
 
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
167
        </listitem>
 
168
      </varlistentry>
 
169
      
 
170
      <varlistentry>
 
171
        <term><option>--port
 
172
        <replaceable>PORT</replaceable></option></term>
 
173
        <term><option>-p
 
174
        <replaceable>PORT</replaceable></option></term>
 
175
        <listitem>
 
176
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
177
        </listitem>
 
178
      </varlistentry>
 
179
      
 
180
      <varlistentry>
 
181
        <term><option>--check</option></term>
 
182
        <listitem>
 
183
          <para>
 
184
            Run the server’s self-tests.  This includes any unit
201
185
            tests, etc.
202
186
          </para>
203
187
        </listitem>
204
188
      </varlistentry>
205
 
 
206
 
      <varlistentry>
207
 
        <term><literal>--debug</literal></term>
208
 
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
 
217
 
      <varlistentry>
218
 
        <term><literal>--priority <replaceable>
219
 
        PRIORITY</replaceable></literal></term>
220
 
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  See
224
 
            <citerefentry><refentrytitle>gnutls_priority_init
225
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
 
            for the syntax.  The default is
227
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
 
        </literal></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            <quote><literal>Mandos</literal></quote>.  You only need
242
 
            to change this if you for some reason want to run more
243
 
            than one server on the same <emphasis>host</emphasis>,
244
 
            which would not normally be useful.  If there are name
245
 
            collisions on the same <emphasis>network</emphasis>, the
246
 
            newer server will automatically rename itself to
247
 
            <quote><literal>Mandos #2</literal></quote>, and so on,
248
 
            therefore this option is not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
189
      
 
190
      <varlistentry>
 
191
        <term><option>--debug</option></term>
 
192
        <listitem>
 
193
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
194
        </listitem>
 
195
      </varlistentry>
 
196
      
 
197
      <varlistentry>
 
198
        <term><option>--priority <replaceable>
 
199
        PRIORITY</replaceable></option></term>
 
200
        <listitem>
 
201
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--servicename
 
207
        <replaceable>NAME</replaceable></option></term>
 
208
        <listitem>
 
209
          <xi:include href="mandos-options.xml"
 
210
                      xpointer="servicename"/>
 
211
        </listitem>
 
212
      </varlistentry>
 
213
      
 
214
      <varlistentry>
 
215
        <term><option>--configdir
 
216
        <replaceable>DIRECTORY</replaceable></option></term>
256
217
        <listitem>
257
218
          <para>
258
219
            Directory to search for configuration files.  Default is
264
225
          </para>
265
226
        </listitem>
266
227
      </varlistentry>
267
 
 
 
228
      
268
229
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
230
        <term><option>--version</option></term>
270
231
        <listitem>
271
232
          <para>
272
233
            Prints the program version and exit.
273
234
          </para>
274
235
        </listitem>
275
236
      </varlistentry>
 
237
      
 
238
      <varlistentry>
 
239
        <term><option>--no-dbus</option></term>
 
240
        <listitem>
 
241
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
242
          <para>
 
243
            See also <xref linkend="dbus_interface"/>.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--no-ipv6</option></term>
 
250
        <listitem>
 
251
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
252
        </listitem>
 
253
      </varlistentry>
276
254
    </variablelist>
277
255
  </refsect1>
278
 
 
 
256
  
 
257
  <refsect1 id="overview">
 
258
    <title>OVERVIEW</title>
 
259
    <xi:include href="overview.xml"/>
 
260
    <para>
 
261
      This program is the server part.  It is a normal server program
 
262
      and will run in a normal system environment, not in an initial
 
263
      <acronym>RAM</acronym> disk environment.
 
264
    </para>
 
265
  </refsect1>
 
266
  
279
267
  <refsect1 id="protocol">
280
268
    <title>NETWORK PROTOCOL</title>
281
269
    <para>
307
295
        <entry>-><!-- &rarr; --></entry>
308
296
      </row>
309
297
      <row>
310
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
298
        <entry><quote><literal>1\r\n</literal></quote></entry>
311
299
        <entry>-><!-- &rarr; --></entry>
312
300
      </row>
313
301
      <row>
333
321
      </row>
334
322
    </tbody></tgroup></table>
335
323
  </refsect1>
336
 
 
 
324
  
337
325
  <refsect1 id="checking">
338
326
    <title>CHECKING</title>
339
327
    <para>
340
328
      The server will, by default, continually check that the clients
341
329
      are still up.  If a client has not been confirmed as being up
342
330
      for some time, the client is assumed to be compromised and is no
343
 
      longer eligible to receive the encrypted password.  The timeout,
344
 
      checker program and interval between checks can be configured
 
331
      longer eligible to receive the encrypted password.  (Manual
 
332
      intervention is required to re-enable a client.)  The timeout,
 
333
      checker program, and interval between checks can be configured
345
334
      both globally and per client; see <citerefentry>
346
 
      <refentrytitle>mandos.conf</refentrytitle>
347
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
348
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
 
      <manvolnum>5</manvolnum></citerefentry>.
350
 
    </para>
351
 
  </refsect1>
352
 
 
 
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
336
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
337
      receiving its password will also be treated as a successful
 
338
      checker run.
 
339
    </para>
 
340
  </refsect1>
 
341
  
 
342
  <refsect1 id="approval">
 
343
    <title>APPROVAL</title>
 
344
    <para>
 
345
      The server can be configured to require manual approval for a
 
346
      client before it is sent its secret.  The delay to wait for such
 
347
      approval and the default action (approve or deny) can be
 
348
      configured both globally and per client; see <citerefentry>
 
349
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
350
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
351
      will be approved immediately without delay.
 
352
    </para>
 
353
    <para>
 
354
      This can be used to deny a client its secret if not manually
 
355
      approved within a specified time.  It can also be used to make
 
356
      the server delay before giving a client its secret, allowing
 
357
      optional manual denying of this specific client.
 
358
    </para>
 
359
    
 
360
  </refsect1>
 
361
  
353
362
  <refsect1 id="logging">
354
363
    <title>LOGGING</title>
355
364
    <para>
356
 
      The server will send log messaged with various severity levels
357
 
      to <filename>/dev/log</filename>.  With the
 
365
      The server will send log message with various severity levels to
 
366
      <filename>/dev/log</filename>.  With the
358
367
      <option>--debug</option> option, it will log even more messages,
359
368
      and also show them on the console.
360
369
    </para>
361
370
  </refsect1>
362
 
 
 
371
  
 
372
  <refsect1 id="dbus_interface">
 
373
    <title>D-BUS INTERFACE</title>
 
374
    <para>
 
375
      The server will by default provide a D-Bus system bus interface.
 
376
      This interface will only be accessible by the root user or a
 
377
      Mandos-specific user, if such a user exists.  For documentation
 
378
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
379
    </para>
 
380
  </refsect1>
 
381
  
363
382
  <refsect1 id="exit_status">
364
383
    <title>EXIT STATUS</title>
365
384
    <para>
367
386
      critical error is encountered.
368
387
    </para>
369
388
  </refsect1>
370
 
 
371
 
  <refsect1 id="file">
 
389
  
 
390
  <refsect1 id="environment">
 
391
    <title>ENVIRONMENT</title>
 
392
    <variablelist>
 
393
      <varlistentry>
 
394
        <term><envar>PATH</envar></term>
 
395
        <listitem>
 
396
          <para>
 
397
            To start the configured checker (see <xref
 
398
            linkend="checking"/>), the server uses
 
399
            <filename>/bin/sh</filename>, which in turn uses
 
400
            <varname>PATH</varname> to search for matching commands if
 
401
            an absolute path is not given.  See <citerefentry>
 
402
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
403
            </citerefentry>.
 
404
          </para>
 
405
        </listitem>
 
406
      </varlistentry>
 
407
    </variablelist>
 
408
  </refsect1>
 
409
  
 
410
  <refsect1 id="files">
372
411
    <title>FILES</title>
373
412
    <para>
374
413
      Use the <option>--configdir</option> option to change where
397
436
        </listitem>
398
437
      </varlistentry>
399
438
      <varlistentry>
400
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
439
        <term><filename>/var/run/mandos.pid</filename></term>
401
440
        <listitem>
402
441
          <para>
403
 
            The file containing the process id of
404
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
405
444
          </para>
406
445
        </listitem>
407
446
      </varlistentry>
414
453
          </para>
415
454
        </listitem>
416
455
      </varlistentry>
 
456
      <varlistentry>
 
457
        <term><filename>/bin/sh</filename></term>
 
458
        <listitem>
 
459
          <para>
 
460
            This is used to start the configured checker command for
 
461
            each client.  See <citerefentry>
 
462
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
463
            <manvolnum>5</manvolnum></citerefentry> for details.
 
464
          </para>
 
465
        </listitem>
 
466
      </varlistentry>
417
467
    </variablelist>
418
468
  </refsect1>
419
 
 
 
469
  
420
470
  <refsect1 id="bugs">
421
471
    <title>BUGS</title>
422
472
    <para>
423
473
      This server might, on especially fatal errors, emit a Python
424
474
      backtrace.  This could be considered a feature.
425
475
    </para>
 
476
    <para>
 
477
      Currently, if a client is disabled due to having timed out, the
 
478
      server does not record this fact onto permanent storage.  This
 
479
      has some security implications, see <xref linkend="clients"/>.
 
480
    </para>
 
481
    <para>
 
482
      There is no fine-grained control over logging and debug output.
 
483
    </para>
 
484
    <para>
 
485
      Debug mode is conflated with running in the foreground.
 
486
    </para>
 
487
    <para>
 
488
      The console log messages do not show a time stamp.
 
489
    </para>
 
490
    <para>
 
491
      This server does not check the expire time of clients’ OpenPGP
 
492
      keys.
 
493
    </para>
426
494
  </refsect1>
427
 
 
428
 
  <refsect1 id="examples">
429
 
    <title>EXAMPLES</title>
 
495
  
 
496
  <refsect1 id="example">
 
497
    <title>EXAMPLE</title>
430
498
    <informalexample>
431
499
      <para>
432
500
        Normal invocation needs no options:
433
501
      </para>
434
502
      <para>
435
 
        <userinput>mandos</userinput>
 
503
        <userinput>&COMMANDNAME;</userinput>
436
504
      </para>
437
505
    </informalexample>
438
506
    <informalexample>
439
507
      <para>
440
 
        Run the server in debug mode and read configuration files from
441
 
        the <filename>~/mandos</filename> directory:
 
508
        Run the server in debug mode, read configuration files from
 
509
        the <filename>~/mandos</filename> directory, and use the
 
510
        Zeroconf service name <quote>Test</quote> to not collide with
 
511
        any other official Mandos server on this host:
442
512
      </para>
443
513
      <para>
444
514
 
445
515
<!-- do not wrap this line -->
446
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
516
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
447
517
 
448
518
      </para>
449
519
    </informalexample>
455
525
      <para>
456
526
 
457
527
<!-- do not wrap this line -->
458
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
528
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
459
529
 
460
530
      </para>
461
531
    </informalexample>
462
532
  </refsect1>
463
 
 
 
533
  
464
534
  <refsect1 id="security">
465
535
    <title>SECURITY</title>
466
 
    <refsect2>
 
536
    <refsect2 id="server">
467
537
      <title>SERVER</title>
468
538
      <para>
469
 
        Running the server should not in itself present any security
470
 
        risk to the host computer running it.
 
539
        Running this <command>&COMMANDNAME;</command> server program
 
540
        should not in itself present any security risk to the host
 
541
        computer running it.  The program switches to a non-root user
 
542
        soon after startup.
471
543
      </para>
472
544
    </refsect2>
473
 
    <refsect2>
 
545
    <refsect2 id="clients">
474
546
      <title>CLIENTS</title>
475
547
      <para>
476
548
        The server only gives out its stored data to clients which
481
553
        itself and looks up the fingerprint in its list of
482
554
        clients. The <filename>clients.conf</filename> file (see
483
555
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
 
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
 
        by anyone except the user running the server.
 
556
        <manvolnum>5</manvolnum></citerefentry>)
 
557
        <emphasis>must</emphasis> be made non-readable by anyone
 
558
        except the user starting the server (usually root).
 
559
      </para>
 
560
      <para>
 
561
        As detailed in <xref linkend="checking"/>, the status of all
 
562
        client computers will continually be checked and be assumed
 
563
        compromised if they are gone for too long.
 
564
      </para>
 
565
      <para>
 
566
        If a client is compromised, its downtime should be duly noted
 
567
        by the server which would therefore disable the client.  But
 
568
        if the server was ever restarted, it would re-read its client
 
569
        list from its configuration file and again regard all clients
 
570
        therein as enabled, and hence eligible to receive their
 
571
        passwords.  Therefore, be careful when restarting servers if
 
572
        it is suspected that a client has, in fact, been compromised
 
573
        by parties who may now be running a fake Mandos client with
 
574
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
575
        image of the client host.  What should be done in that case
 
576
        (if restarting the server program really is necessary) is to
 
577
        stop the server program, edit the configuration file to omit
 
578
        any suspect clients, and restart the server program.
486
579
      </para>
487
580
      <para>
488
581
        For more details on client-side security, see
489
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
582
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
490
583
        <manvolnum>8mandos</manvolnum></citerefentry>.
491
584
      </para>
492
585
    </refsect2>
493
586
  </refsect1>
494
 
 
 
587
  
495
588
  <refsect1 id="see_also">
496
589
    <title>SEE ALSO</title>
497
 
    <itemizedlist spacing="compact">
498
 
      <listitem><para>
499
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
500
 
        <manvolnum>8mandos</manvolnum></citerefentry>
501
 
      </para></listitem>
502
 
      
503
 
      <listitem><para>
504
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
 
        <manvolnum>8mandos</manvolnum></citerefentry>
506
 
      </para></listitem>
507
 
      
508
 
      <listitem><para>
509
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
510
 
      </para></listitem>
511
 
      
512
 
      <listitem><para>
513
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
514
 
      </para></listitem>
515
 
      
516
 
      <listitem><para>
517
 
        <ulink
518
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
519
 
      </para></listitem>
520
 
      
521
 
      <listitem><para>
522
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
523
 
        Format</citetitle></citation>
524
 
      </para></listitem>
525
 
      
526
 
      <listitem><para>
527
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
 
        Transport Layer Security</citetitle></citation>
529
 
      </para></listitem>
530
 
      
531
 
      <listitem><para>
532
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
 
        Unicast Addresses</citation>
535
 
      </para></listitem>
536
 
    </itemizedlist>
 
590
    <para>
 
591
      <citerefentry>
 
592
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
593
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
594
        <refentrytitle>mandos.conf</refentrytitle>
 
595
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
596
        <refentrytitle>mandos-client</refentrytitle>
 
597
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
598
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
599
      </citerefentry>
 
600
    </para>
 
601
    <variablelist>
 
602
      <varlistentry>
 
603
        <term>
 
604
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
605
        </term>
 
606
        <listitem>
 
607
          <para>
 
608
            Zeroconf is the network protocol standard used by clients
 
609
            for finding this Mandos server on the local network.
 
610
          </para>
 
611
        </listitem>
 
612
      </varlistentry>
 
613
      <varlistentry>
 
614
        <term>
 
615
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
616
        </term>
 
617
      <listitem>
 
618
        <para>
 
619
          Avahi is the library this server calls to implement
 
620
          Zeroconf service announcements.
 
621
        </para>
 
622
      </listitem>
 
623
      </varlistentry>
 
624
      <varlistentry>
 
625
        <term>
 
626
          <ulink url="http://www.gnu.org/software/gnutls/"
 
627
          >GnuTLS</ulink>
 
628
        </term>
 
629
      <listitem>
 
630
        <para>
 
631
          GnuTLS is the library this server uses to implement TLS for
 
632
          communicating securely with the client, and at the same time
 
633
          confidently get the client’s public OpenPGP key.
 
634
        </para>
 
635
      </listitem>
 
636
      </varlistentry>
 
637
      <varlistentry>
 
638
        <term>
 
639
          RFC 4291: <citetitle>IP Version 6 Addressing
 
640
          Architecture</citetitle>
 
641
        </term>
 
642
        <listitem>
 
643
          <variablelist>
 
644
            <varlistentry>
 
645
              <term>Section 2.2: <citetitle>Text Representation of
 
646
              Addresses</citetitle></term>
 
647
              <listitem><para/></listitem>
 
648
            </varlistentry>
 
649
            <varlistentry>
 
650
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
651
              Address</citetitle></term>
 
652
              <listitem><para/></listitem>
 
653
            </varlistentry>
 
654
            <varlistentry>
 
655
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
656
            Addresses</citetitle></term>
 
657
            <listitem>
 
658
              <para>
 
659
                The clients use IPv6 link-local addresses, which are
 
660
                immediately usable since a link-local addresses is
 
661
                automatically assigned to a network interfaces when it
 
662
                is brought up.
 
663
              </para>
 
664
            </listitem>
 
665
            </varlistentry>
 
666
          </variablelist>
 
667
        </listitem>
 
668
      </varlistentry>
 
669
      <varlistentry>
 
670
        <term>
 
671
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
672
          Protocol Version 1.1</citetitle>
 
673
        </term>
 
674
      <listitem>
 
675
        <para>
 
676
          TLS 1.1 is the protocol implemented by GnuTLS.
 
677
        </para>
 
678
      </listitem>
 
679
      </varlistentry>
 
680
      <varlistentry>
 
681
        <term>
 
682
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
683
        </term>
 
684
      <listitem>
 
685
        <para>
 
686
          The data sent to clients is binary encrypted OpenPGP data.
 
687
        </para>
 
688
      </listitem>
 
689
      </varlistentry>
 
690
      <varlistentry>
 
691
        <term>
 
692
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
693
          Security</citetitle>
 
694
        </term>
 
695
      <listitem>
 
696
        <para>
 
697
          This is implemented by GnuTLS and used by this server so
 
698
          that OpenPGP keys can be used.
 
699
        </para>
 
700
      </listitem>
 
701
      </varlistentry>
 
702
    </variablelist>
537
703
  </refsect1>
538
704
</refentry>
 
705
<!-- Local Variables: -->
 
706
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
707
<!-- time-stamp-end: "[\"']>" -->
 
708
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
709
<!-- End: -->