/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: 2009-01-06 00:58:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106005817-lnxyism0yjkmmlj1
Tags: version-1.0.3-1
* Makefile (version): Changed to "1.0.3".
* NEWS (Version 1.0.3): New entry.
* debian/changelog (1.0.3-1): New entry.

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