/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2012-01-01 21:18:02 UTC
  • mfrom: (237.4.24 release)
  • Revision ID: teddy@recompile.se-20120101211802-zufjnqz4dwh3xknj
Merge from release branch.

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