/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-01-15">
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
 
    </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>
 
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>
118
106
    </cmdsynopsis>
119
107
  </refsynopsisdiv>
120
 
  
 
108
 
121
109
  <refsect1 id="description">
122
110
    <title>DESCRIPTION</title>
123
111
    <para>
124
112
      <command>&COMMANDNAME;</command> is a server daemon which
125
113
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
136
121
    </para>
 
122
 
137
123
  </refsect1>
138
124
  
139
125
  <refsect1 id="purpose">
140
126
    <title>PURPOSE</title>
 
127
 
141
128
    <para>
142
129
      The purpose of this is to enable <emphasis>remote and unattended
143
 
      rebooting</emphasis> of client host computer with an
144
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
 
      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.
146
138
    </para>
 
139
 
147
140
  </refsect1>
148
141
  
149
142
  <refsect1 id="options">
150
143
    <title>OPTIONS</title>
 
144
 
151
145
    <variablelist>
152
146
      <varlistentry>
153
 
        <term><option>--help</option></term>
154
 
        <term><option>-h</option></term>
 
147
        <term><literal>-h</literal>, <literal>--help</literal></term>
155
148
        <listitem>
156
149
          <para>
157
150
            Show a help message and exit
158
151
          </para>
159
152
        </listitem>
160
153
      </varlistentry>
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
 
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
197
201
            tests, etc.
198
202
          </para>
199
203
        </listitem>
200
204
      </varlistentry>
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>
 
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>
247
256
        <listitem>
248
257
          <para>
249
258
            Directory to search for configuration files.  Default is
255
264
          </para>
256
265
        </listitem>
257
266
      </varlistentry>
258
 
      
 
267
 
259
268
      <varlistentry>
260
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
261
270
        <listitem>
262
271
          <para>
263
272
            Prints the program version and exit.
264
273
          </para>
265
274
        </listitem>
266
275
      </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>
302
276
    </variablelist>
303
277
  </refsect1>
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
 
  
 
278
 
315
279
  <refsect1 id="protocol">
316
280
    <title>NETWORK PROTOCOL</title>
317
281
    <para>
343
307
        <entry>-><!-- &rarr; --></entry>
344
308
      </row>
345
309
      <row>
346
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
310
        <entry><quote><literal>1\r\en</literal></quote></entry>
347
311
        <entry>-><!-- &rarr; --></entry>
348
312
      </row>
349
313
      <row>
369
333
      </row>
370
334
    </tbody></tgroup></table>
371
335
  </refsect1>
372
 
  
 
336
 
373
337
  <refsect1 id="checking">
374
338
    <title>CHECKING</title>
375
339
    <para>
376
340
      The server will, by default, continually check that the clients
377
341
      are still up.  If a client has not been confirmed as being up
378
342
      for some time, the client is assumed to be compromised and is no
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>
 
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>
384
349
      <manvolnum>5</manvolnum></citerefentry>.
385
350
    </para>
386
351
  </refsect1>
387
 
  
388
 
  <refsect1 id="approval">
389
 
    <title>APPROVAL</title>
390
 
    <para>
391
 
      The server can be configured to require manual approval for a
392
 
      client before it is sent its secret.  The delay to wait for such
393
 
      approval and the default action (approve or deny) can be
394
 
      configured both globally and per client; see <citerefentry>
395
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
396
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
397
 
      will be approved immediately without delay.
398
 
    </para>
399
 
    <para>
400
 
      This can be used to deny a client its secret if not manually
401
 
      approved within a specified time.  It can also be used to make
402
 
      the server delay before giving a client its secret, allowing
403
 
      optional manual denying of this specific client.
404
 
    </para>
405
 
    
406
 
  </refsect1>
407
 
  
 
352
 
408
353
  <refsect1 id="logging">
409
354
    <title>LOGGING</title>
410
355
    <para>
411
 
      The server will send log message with various severity levels to
412
 
      <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
413
358
      <option>--debug</option> option, it will log even more messages,
414
359
      and also show them on the console.
415
360
    </para>
416
361
  </refsect1>
417
 
  
418
 
  <refsect1 id="persistent_state">
419
 
    <title>PERSISTENT STATE</title>
420
 
    <para>
421
 
      Client settings, initially read from
422
 
      <filename>clients.conf</filename>, are persistent across
423
 
      restarts, and run-time changes will override settings in
424
 
      <filename>clients.conf</filename>.  However, if a setting is
425
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
426
 
      <filename>clients.conf</filename>, this will take precedence.
427
 
    </para>
428
 
  </refsect1>
429
 
  
430
 
  <refsect1 id="dbus_interface">
431
 
    <title>D-BUS INTERFACE</title>
432
 
    <para>
433
 
      The server will by default provide a D-Bus system bus interface.
434
 
      This interface will only be accessible by the root user or a
435
 
      Mandos-specific user, if such a user exists.  For documentation
436
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
437
 
    </para>
438
 
  </refsect1>
439
 
  
 
362
 
440
363
  <refsect1 id="exit_status">
441
364
    <title>EXIT STATUS</title>
442
365
    <para>
444
367
      critical error is encountered.
445
368
    </para>
446
369
  </refsect1>
447
 
  
448
 
  <refsect1 id="environment">
449
 
    <title>ENVIRONMENT</title>
450
 
    <variablelist>
451
 
      <varlistentry>
452
 
        <term><envar>PATH</envar></term>
453
 
        <listitem>
454
 
          <para>
455
 
            To start the configured checker (see <xref
456
 
            linkend="checking"/>), the server uses
457
 
            <filename>/bin/sh</filename>, which in turn uses
458
 
            <varname>PATH</varname> to search for matching commands if
459
 
            an absolute path is not given.  See <citerefentry>
460
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
461
 
            </citerefentry>.
462
 
          </para>
463
 
        </listitem>
464
 
      </varlistentry>
465
 
    </variablelist>
466
 
  </refsect1>
467
 
  
468
 
  <refsect1 id="files">
 
370
 
 
371
  <refsect1 id="file">
469
372
    <title>FILES</title>
470
373
    <para>
471
374
      Use the <option>--configdir</option> option to change where
494
397
        </listitem>
495
398
      </varlistentry>
496
399
      <varlistentry>
497
 
        <term><filename>/var/run/mandos.pid</filename></term>
498
 
        <listitem>
499
 
          <para>
500
 
            The file containing the process id of the
501
 
            <command>&COMMANDNAME;</command> process started last.
502
 
          </para>
503
 
        </listitem>
504
 
      </varlistentry>
505
 
      <varlistentry>
506
 
        <term><filename class="devicefile">/dev/log</filename></term>
507
 
      </varlistentry>
508
 
      <varlistentry>
509
 
        <term><filename
510
 
        class="directory">/var/lib/mandos</filename></term>
511
 
        <listitem>
512
 
          <para>
513
 
            Directory where persistent state will be saved.  Change
514
 
            this with the <option>--statedir</option> option.  See
515
 
            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>.
516
405
          </para>
517
406
        </listitem>
518
407
      </varlistentry>
525
414
          </para>
526
415
        </listitem>
527
416
      </varlistentry>
528
 
      <varlistentry>
529
 
        <term><filename>/bin/sh</filename></term>
530
 
        <listitem>
531
 
          <para>
532
 
            This is used to start the configured checker command for
533
 
            each client.  See <citerefentry>
534
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
535
 
            <manvolnum>5</manvolnum></citerefentry> for details.
536
 
          </para>
537
 
        </listitem>
538
 
      </varlistentry>
539
417
    </variablelist>
540
418
  </refsect1>
541
 
  
 
419
 
542
420
  <refsect1 id="bugs">
543
421
    <title>BUGS</title>
544
422
    <para>
545
423
      This server might, on especially fatal errors, emit a Python
546
424
      backtrace.  This could be considered a feature.
547
425
    </para>
548
 
    <para>
549
 
      There is no fine-grained control over logging and debug output.
550
 
    </para>
551
 
    <para>
552
 
      Debug mode is conflated with running in the foreground.
553
 
    </para>
554
 
    <para>
555
 
      This server does not check the expire time of clients’ OpenPGP
556
 
      keys.
557
 
    </para>
558
426
  </refsect1>
559
 
  
560
 
  <refsect1 id="example">
561
 
    <title>EXAMPLE</title>
 
427
 
 
428
  <refsect1 id="examples">
 
429
    <title>EXAMPLES</title>
562
430
    <informalexample>
563
431
      <para>
564
432
        Normal invocation needs no options:
565
433
      </para>
566
434
      <para>
567
 
        <userinput>&COMMANDNAME;</userinput>
 
435
        <userinput>mandos</userinput>
568
436
      </para>
569
437
    </informalexample>
570
438
    <informalexample>
571
439
      <para>
572
 
        Run the server in debug mode, read configuration files from
573
 
        the <filename class="directory">~/mandos</filename> directory,
574
 
        and use the Zeroconf service name <quote>Test</quote> to not
575
 
        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:
576
442
      </para>
577
443
      <para>
578
444
 
579
445
<!-- do not wrap this line -->
580
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
446
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
581
447
 
582
448
      </para>
583
449
    </informalexample>
589
455
      <para>
590
456
 
591
457
<!-- do not wrap this line -->
592
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
593
459
 
594
460
      </para>
595
461
    </informalexample>
596
462
  </refsect1>
597
 
  
 
463
 
598
464
  <refsect1 id="security">
599
465
    <title>SECURITY</title>
600
 
    <refsect2 id="server">
 
466
    <refsect2>
601
467
      <title>SERVER</title>
602
468
      <para>
603
 
        Running this <command>&COMMANDNAME;</command> server program
604
 
        should not in itself present any security risk to the host
605
 
        computer running it.  The program switches to a non-root user
606
 
        soon after startup.
 
469
        Running the server should not in itself present any security
 
470
        risk to the host computer running it.
607
471
      </para>
608
472
    </refsect2>
609
 
    <refsect2 id="clients">
 
473
    <refsect2>
610
474
      <title>CLIENTS</title>
611
475
      <para>
612
476
        The server only gives out its stored data to clients which
617
481
        itself and looks up the fingerprint in its list of
618
482
        clients. The <filename>clients.conf</filename> file (see
619
483
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
620
 
        <manvolnum>5</manvolnum></citerefentry>)
621
 
        <emphasis>must</emphasis> be made non-readable by anyone
622
 
        except the user starting the server (usually root).
623
 
      </para>
624
 
      <para>
625
 
        As detailed in <xref linkend="checking"/>, the status of all
626
 
        client computers will continually be checked and be assumed
627
 
        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.
628
486
      </para>
629
487
      <para>
630
488
        For more details on client-side security, see
631
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
489
        <citerefentry><refentrytitle>password-request</refentrytitle>
632
490
        <manvolnum>8mandos</manvolnum></citerefentry>.
633
491
      </para>
634
492
    </refsect2>
635
493
  </refsect1>
636
 
  
 
494
 
637
495
  <refsect1 id="see_also">
638
496
    <title>SEE ALSO</title>
639
 
    <para>
640
 
      <citerefentry><refentrytitle>intro</refentrytitle>
641
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
642
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
643
 
      <manvolnum>5</manvolnum></citerefentry>,
644
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
645
 
      <manvolnum>5</manvolnum></citerefentry>,
646
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
647
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
648
 
      <citerefentry><refentrytitle>sh</refentrytitle>
649
 
      <manvolnum>1</manvolnum></citerefentry>
650
 
    </para>
651
 
    <variablelist>
652
 
      <varlistentry>
653
 
        <term>
654
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
655
 
        </term>
656
 
        <listitem>
657
 
          <para>
658
 
            Zeroconf is the network protocol standard used by clients
659
 
            for finding this Mandos server on the local network.
660
 
          </para>
661
 
        </listitem>
662
 
      </varlistentry>
663
 
      <varlistentry>
664
 
        <term>
665
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
666
 
        </term>
667
 
      <listitem>
668
 
        <para>
669
 
          Avahi is the library this server calls to implement
670
 
          Zeroconf service announcements.
671
 
        </para>
672
 
      </listitem>
673
 
      </varlistentry>
674
 
      <varlistentry>
675
 
        <term>
676
 
          <ulink url="http://www.gnu.org/software/gnutls/"
677
 
          >GnuTLS</ulink>
678
 
        </term>
679
 
      <listitem>
680
 
        <para>
681
 
          GnuTLS is the library this server uses to implement TLS for
682
 
          communicating securely with the client, and at the same time
683
 
          confidently get the client’s public OpenPGP key.
684
 
        </para>
685
 
      </listitem>
686
 
      </varlistentry>
687
 
      <varlistentry>
688
 
        <term>
689
 
          RFC 4291: <citetitle>IP Version 6 Addressing
690
 
          Architecture</citetitle>
691
 
        </term>
692
 
        <listitem>
693
 
          <variablelist>
694
 
            <varlistentry>
695
 
              <term>Section 2.2: <citetitle>Text Representation of
696
 
              Addresses</citetitle></term>
697
 
              <listitem><para/></listitem>
698
 
            </varlistentry>
699
 
            <varlistentry>
700
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
701
 
              Address</citetitle></term>
702
 
              <listitem><para/></listitem>
703
 
            </varlistentry>
704
 
            <varlistentry>
705
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
706
 
            Addresses</citetitle></term>
707
 
            <listitem>
708
 
              <para>
709
 
                The clients use IPv6 link-local addresses, which are
710
 
                immediately usable since a link-local addresses is
711
 
                automatically assigned to a network interfaces when it
712
 
                is brought up.
713
 
              </para>
714
 
            </listitem>
715
 
            </varlistentry>
716
 
          </variablelist>
717
 
        </listitem>
718
 
      </varlistentry>
719
 
      <varlistentry>
720
 
        <term>
721
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
722
 
          Protocol Version 1.1</citetitle>
723
 
        </term>
724
 
      <listitem>
725
 
        <para>
726
 
          TLS 1.1 is the protocol implemented by GnuTLS.
727
 
        </para>
728
 
      </listitem>
729
 
      </varlistentry>
730
 
      <varlistentry>
731
 
        <term>
732
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
733
 
        </term>
734
 
      <listitem>
735
 
        <para>
736
 
          The data sent to clients is binary encrypted OpenPGP data.
737
 
        </para>
738
 
      </listitem>
739
 
      </varlistentry>
740
 
      <varlistentry>
741
 
        <term>
742
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
743
 
          Security</citetitle>
744
 
        </term>
745
 
      <listitem>
746
 
        <para>
747
 
          This is implemented by GnuTLS and used by this server so
748
 
          that OpenPGP keys can be used.
749
 
        </para>
750
 
      </listitem>
751
 
      </varlistentry>
752
 
    </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>
753
537
  </refsect1>
754
538
</refentry>
755
 
<!-- Local Variables: -->
756
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
757
 
<!-- time-stamp-end: "[\"']>" -->
758
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
759
 
<!-- End: -->