/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: 2008-08-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2012-05-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
8
]>
9
9
 
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>
 
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>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
34
      <holder>Teddy Hogeborn</holder>
40
35
      <holder>Björn Påhlsson</holder>
41
36
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
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>
43
60
  </refentryinfo>
44
 
  
 
61
 
45
62
  <refmeta>
46
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
47
64
    <manvolnum>8</manvolnum>
50
67
  <refnamediv>
51
68
    <refname><command>&COMMANDNAME;</command></refname>
52
69
    <refpurpose>
53
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
54
71
    </refpurpose>
55
72
  </refnamediv>
56
 
  
 
73
 
57
74
  <refsynopsisdiv>
58
75
    <cmdsynopsis>
59
76
      <command>&COMMANDNAME;</command>
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>
 
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>
121
106
    </cmdsynopsis>
122
107
  </refsynopsisdiv>
123
 
  
 
108
 
124
109
  <refsect1 id="description">
125
110
    <title>DESCRIPTION</title>
126
111
    <para>
127
112
      <command>&COMMANDNAME;</command> is a server daemon which
128
113
      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.
 
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.
139
121
    </para>
 
122
 
140
123
  </refsect1>
141
124
  
142
125
  <refsect1 id="purpose">
143
126
    <title>PURPOSE</title>
 
127
 
144
128
    <para>
145
129
      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.
 
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.
149
138
    </para>
 
139
 
150
140
  </refsect1>
151
141
  
152
142
  <refsect1 id="options">
153
143
    <title>OPTIONS</title>
 
144
 
154
145
    <variablelist>
155
146
      <varlistentry>
156
 
        <term><option>--help</option></term>
157
 
        <term><option>-h</option></term>
 
147
        <term><literal>-h</literal>, <literal>--help</literal></term>
158
148
        <listitem>
159
149
          <para>
160
150
            Show a help message and exit
161
151
          </para>
162
152
        </listitem>
163
153
      </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
 
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
200
201
            tests, etc.
201
202
          </para>
202
203
        </listitem>
203
204
      </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>
 
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>
250
256
        <listitem>
251
257
          <para>
252
258
            Directory to search for configuration files.  Default is
258
264
          </para>
259
265
        </listitem>
260
266
      </varlistentry>
261
 
      
 
267
 
262
268
      <varlistentry>
263
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
264
270
        <listitem>
265
271
          <para>
266
272
            Prints the program version and exit.
267
273
          </para>
268
274
        </listitem>
269
275
      </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
276
    </variablelist>
315
277
  </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
 
  
 
278
 
327
279
  <refsect1 id="protocol">
328
280
    <title>NETWORK PROTOCOL</title>
329
281
    <para>
355
307
        <entry>-><!-- &rarr; --></entry>
356
308
      </row>
357
309
      <row>
358
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
310
        <entry><quote><literal>1\r\en</literal></quote></entry>
359
311
        <entry>-><!-- &rarr; --></entry>
360
312
      </row>
361
313
      <row>
381
333
      </row>
382
334
    </tbody></tgroup></table>
383
335
  </refsect1>
384
 
  
 
336
 
385
337
  <refsect1 id="checking">
386
338
    <title>CHECKING</title>
387
339
    <para>
388
340
      The server will, by default, continually check that the clients
389
341
      are still up.  If a client has not been confirmed as being up
390
342
      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>
 
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>
 
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
396
349
      <manvolnum>5</manvolnum></citerefentry>.
397
350
    </para>
398
351
  </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
 
  
 
352
 
420
353
  <refsect1 id="logging">
421
354
    <title>LOGGING</title>
422
355
    <para>
423
 
      The server will send log message with various severity levels to
424
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
356
      The server will send log messaged with various severity levels
 
357
      to <filename>/dev/log</filename>.  With the
425
358
      <option>--debug</option> option, it will log even more messages,
426
359
      and also show them on the console.
427
360
    </para>
428
361
  </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
 
  
 
362
 
452
363
  <refsect1 id="exit_status">
453
364
    <title>EXIT STATUS</title>
454
365
    <para>
456
367
      critical error is encountered.
457
368
    </para>
458
369
  </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">
 
370
 
 
371
  <refsect1 id="file">
481
372
    <title>FILES</title>
482
373
    <para>
483
374
      Use the <option>--configdir</option> option to change where
506
397
        </listitem>
507
398
      </varlistentry>
508
399
      <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.
 
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>.
528
405
          </para>
529
406
        </listitem>
530
407
      </varlistentry>
537
414
          </para>
538
415
        </listitem>
539
416
      </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
417
    </variablelist>
552
418
  </refsect1>
553
 
  
 
419
 
554
420
  <refsect1 id="bugs">
555
421
    <title>BUGS</title>
556
422
    <para>
557
423
      This server might, on especially fatal errors, emit a Python
558
424
      backtrace.  This could be considered a feature.
559
425
    </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
426
  </refsect1>
571
 
  
572
 
  <refsect1 id="example">
573
 
    <title>EXAMPLE</title>
 
427
 
 
428
  <refsect1 id="examples">
 
429
    <title>EXAMPLES</title>
574
430
    <informalexample>
575
431
      <para>
576
432
        Normal invocation needs no options:
577
433
      </para>
578
434
      <para>
579
 
        <userinput>&COMMANDNAME;</userinput>
 
435
        <userinput>mandos</userinput>
580
436
      </para>
581
437
    </informalexample>
582
438
    <informalexample>
583
439
      <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:
 
440
        Run the server in debug mode and read configuration files from
 
441
        the <filename>~/mandos</filename> directory:
588
442
      </para>
589
443
      <para>
590
444
 
591
445
<!-- do not wrap this line -->
592
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
446
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
593
447
 
594
448
      </para>
595
449
    </informalexample>
601
455
      <para>
602
456
 
603
457
<!-- do not wrap this line -->
604
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
605
459
 
606
460
      </para>
607
461
    </informalexample>
608
462
  </refsect1>
609
 
  
 
463
 
610
464
  <refsect1 id="security">
611
465
    <title>SECURITY</title>
612
 
    <refsect2 id="server">
 
466
    <refsect2>
613
467
      <title>SERVER</title>
614
468
      <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.
 
469
        Running the server should not in itself present any security
 
470
        risk to the host computer running it.
619
471
      </para>
620
472
    </refsect2>
621
 
    <refsect2 id="clients">
 
473
    <refsect2>
622
474
      <title>CLIENTS</title>
623
475
      <para>
624
476
        The server only gives out its stored data to clients which
629
481
        itself and looks up the fingerprint in its list of
630
482
        clients. The <filename>clients.conf</filename> file (see
631
483
        <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.
 
484
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
 
485
        by anyone except the user running the server.
640
486
      </para>
641
487
      <para>
642
488
        For more details on client-side security, see
643
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
489
        <citerefentry><refentrytitle>password-request</refentrytitle>
644
490
        <manvolnum>8mandos</manvolnum></citerefentry>.
645
491
      </para>
646
492
    </refsect2>
647
493
  </refsect1>
648
 
  
 
494
 
649
495
  <refsect1 id="see_also">
650
496
    <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>
764
 
    </variablelist>
 
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>
765
537
  </refsect1>
766
538
</refentry>
767
 
<!-- Local Variables: -->
768
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
769
 
<!-- time-stamp-end: "[\"']>" -->
770
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
771
 
<!-- End: -->