/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

Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

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