/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

Updated year in copyright notices.

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