/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

todo

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