/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

* initramfs-tools-hook: Set DEVICE for network hooks.

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