/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: teddy at recompile
  • Date: 2011-12-27 12:15:06 UTC
  • Revision ID: teddy@recompile.se-20111227121506-2qqqdy8evr9ts2ub
Add TODO entries about new D-Bus features we should use.

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