/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: 2009-01-27 00:07:26 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090127000726-4cafcfy35g8kh2b8
* INSTALL (Prerequisites/Mandos Server): Added "PyGObject".

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