/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 Hogeborn
  • Date: 2009-01-04 21:20:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104212050-cl2px2i2oz7wlxw1
* debian/control (Build-Depends): Bug fix: Added "docbook-xml".

* mandos (main): Keep running even if no clients are defined.

* mandos.xml (OPTIONS): Bug fix: Close unclosed <para> tag.
  (D-BUS INTERFACE): Changed id to "dbus_interface".  All references
                     changed.

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