/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-17 06:01:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817060158-o5xakkih6t3br9yq
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
            GPGME_CFLAGS, GPGME_LIBS): New; use libgnutls-config,
                                       pkg-config, and gpgme-config to
                                       get the correct compiler and
                                       linker flags.
  (MANPOST): New post-processing stage to man pages to fix a bug with
             having "\n" in the DocBook pages.
  (objects): Use $(addsuffix) instead of a for loop in a subshell.
  (plugin-runner, plugins.d/password-prompt): Removed; targets no
                                              longer necessary.
  (.PHONY): Added "doc".

* mandos.xml: Much improved.

* plugins.d/password-request.xml: Improved SEE ALSO section.

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