/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 at bsnet
  • Date: 2011-11-10 11:08:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20111110110850-ztybq08hduf85vx6
* debian/control (mandos/Depends): Added "python-crypto".
* mandos: Break long lines.
  (ClientDBus.add_to_dbus): New.
  (ClientDBus.__init__): Call add_to_dbus().
  (main): - '' -

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 "2011-10-22">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
8
8
]>
9
9
 
10
 
<refentry>
11
 
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
67
49
  <refnamediv>
68
50
    <refname><command>&COMMANDNAME;</command></refname>
69
51
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <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>
 
59
      <group>
 
60
        <arg choice="plain"><option>--interface
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
        <arg choice="plain"><option>-i
 
63
        <replaceable>NAME</replaceable></option></arg>
 
64
      </group>
 
65
      <sbr/>
 
66
      <group>
 
67
        <arg choice="plain"><option>--address
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-a
 
70
        <replaceable>ADDRESS</replaceable></option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--port
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
        <arg choice="plain"><option>-p
 
77
        <replaceable>PORT</replaceable></option></arg>
 
78
      </group>
 
79
      <sbr/>
 
80
      <arg><option>--priority
 
81
      <replaceable>PRIORITY</replaceable></option></arg>
 
82
      <sbr/>
 
83
      <arg><option>--servicename
 
84
      <replaceable>NAME</replaceable></option></arg>
 
85
      <sbr/>
 
86
      <arg><option>--configdir
 
87
      <replaceable>DIRECTORY</replaceable></option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--debug</option></arg>
 
90
      <sbr/>
 
91
      <arg><option>--debuglevel
 
92
      <replaceable>LEVEL</replaceable></option></arg>
 
93
      <sbr/>
 
94
      <arg><option>--no-dbus</option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
 
99
    </cmdsynopsis>
 
100
    <cmdsynopsis>
 
101
      <command>&COMMANDNAME;</command>
 
102
      <group choice="req">
 
103
        <arg choice="plain"><option>--help</option></arg>
 
104
        <arg choice="plain"><option>-h</option></arg>
 
105
      </group>
 
106
    </cmdsynopsis>
 
107
    <cmdsynopsis>
 
108
      <command>&COMMANDNAME;</command>
 
109
      <arg choice="plain"><option>--version</option></arg>
 
110
    </cmdsynopsis>
 
111
    <cmdsynopsis>
 
112
      <command>&COMMANDNAME;</command>
 
113
      <arg choice="plain"><option>--check</option></arg>
106
114
    </cmdsynopsis>
107
115
  </refsynopsisdiv>
108
 
 
 
116
  
109
117
  <refsect1 id="description">
110
118
    <title>DESCRIPTION</title>
111
119
    <para>
112
120
      <command>&COMMANDNAME;</command> is a server daemon which
113
121
      handles incoming request for passwords for a pre-defined list of
114
 
      client host computers.  The Mandos server uses Zeroconf to
115
 
      announce itself on the local network, and uses GnuTLS to
116
 
      communicate securely with and to authenticate the clients.
117
 
      Mandos uses IPv6 link-local addresses, since the clients are
118
 
      assumed to not have any other addresses configured.  Any
119
 
      authenticated client is then given the pre-encrypted password
120
 
      for that specific client.
 
122
      client host computers. For an introduction, see
 
123
      <citerefentry><refentrytitle>intro</refentrytitle>
 
124
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
125
      uses Zeroconf to announce itself on the local network, and uses
 
126
      TLS to communicate securely with and to authenticate the
 
127
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
128
      use IPv6 link-local addresses, since the clients will probably
 
129
      not have any other addresses configured (see <xref
 
130
      linkend="overview"/>).  Any authenticated client is then given
 
131
      the stored pre-encrypted password for that specific client.
121
132
    </para>
122
 
 
123
133
  </refsect1>
124
134
  
125
135
  <refsect1 id="purpose">
126
136
    <title>PURPOSE</title>
127
 
 
128
137
    <para>
129
138
      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.
 
139
      rebooting</emphasis> of client host computer with an
 
140
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
141
      linkend="overview"/> for details.
138
142
    </para>
139
 
 
140
143
  </refsect1>
141
144
  
142
145
  <refsect1 id="options">
143
146
    <title>OPTIONS</title>
144
 
 
145
147
    <variablelist>
146
148
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
149
        <term><option>--help</option></term>
 
150
        <term><option>-h</option></term>
148
151
        <listitem>
149
152
          <para>
150
153
            Show a help message and exit
151
154
          </para>
152
155
        </listitem>
153
156
      </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
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
 
184
 
      <varlistentry>
185
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
 
        PORT</replaceable></literal></term>
187
 
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
193
 
        </listitem>
194
 
      </varlistentry>
195
 
 
196
 
      <varlistentry>
197
 
        <term><literal>--check</literal></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Run the server's self-tests.  This includes any unit
 
157
      
 
158
      <varlistentry>
 
159
        <term><option>--interface</option>
 
160
        <replaceable>NAME</replaceable></term>
 
161
        <term><option>-i</option>
 
162
        <replaceable>NAME</replaceable></term>
 
163
        <listitem>
 
164
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
165
        </listitem>
 
166
      </varlistentry>
 
167
      
 
168
      <varlistentry>
 
169
        <term><option>--address
 
170
        <replaceable>ADDRESS</replaceable></option></term>
 
171
        <term><option>-a
 
172
        <replaceable>ADDRESS</replaceable></option></term>
 
173
        <listitem>
 
174
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
175
        </listitem>
 
176
      </varlistentry>
 
177
      
 
178
      <varlistentry>
 
179
        <term><option>--port
 
180
        <replaceable>PORT</replaceable></option></term>
 
181
        <term><option>-p
 
182
        <replaceable>PORT</replaceable></option></term>
 
183
        <listitem>
 
184
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
185
        </listitem>
 
186
      </varlistentry>
 
187
      
 
188
      <varlistentry>
 
189
        <term><option>--check</option></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Run the server’s self-tests.  This includes any unit
201
193
            tests, etc.
202
194
          </para>
203
195
        </listitem>
204
196
      </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
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
 
            <emphasis>Warning</emphasis>: changing this may make the
229
 
            TLS handshake fail, making communication with clients
230
 
            impossible.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
237
 
        </literal></term>
238
 
        <listitem>
239
 
          <para>
240
 
            Zeroconf service name.  The default is
241
 
            <quote><literal>Mandos</literal></quote>.  You only need
242
 
            to change this if you for some reason want to run more
243
 
            than one server on the same <emphasis>host</emphasis>,
244
 
            which would not normally be useful.  If there are name
245
 
            collisions on the same <emphasis>network</emphasis>, the
246
 
            newer server will automatically rename itself to
247
 
            <quote><literal>Mandos #2</literal></quote>, and so on,
248
 
            therefore this option is not needed in that case.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
 
253
 
      <varlistentry>
254
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
255
 
        </literal></term>
 
197
      
 
198
      <varlistentry>
 
199
        <term><option>--debug</option></term>
 
200
        <listitem>
 
201
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--debuglevel
 
207
        <replaceable>LEVEL</replaceable></option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Set the debugging log level.
 
211
            <replaceable>LEVEL</replaceable> is a string, one of
 
212
            <quote><literal>CRITICAL</literal></quote>,
 
213
            <quote><literal>ERROR</literal></quote>,
 
214
            <quote><literal>WARNING</literal></quote>,
 
215
            <quote><literal>INFO</literal></quote>, or
 
216
            <quote><literal>DEBUG</literal></quote>, in order of
 
217
            increasing verbosity.  The default level is
 
218
            <quote><literal>WARNING</literal></quote>.
 
219
          </para>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
 
223
      <varlistentry>
 
224
        <term><option>--priority <replaceable>
 
225
        PRIORITY</replaceable></option></term>
 
226
        <listitem>
 
227
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
228
        </listitem>
 
229
      </varlistentry>
 
230
      
 
231
      <varlistentry>
 
232
        <term><option>--servicename
 
233
        <replaceable>NAME</replaceable></option></term>
 
234
        <listitem>
 
235
          <xi:include href="mandos-options.xml"
 
236
                      xpointer="servicename"/>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><option>--configdir
 
242
        <replaceable>DIRECTORY</replaceable></option></term>
256
243
        <listitem>
257
244
          <para>
258
245
            Directory to search for configuration files.  Default is
264
251
          </para>
265
252
        </listitem>
266
253
      </varlistentry>
267
 
 
 
254
      
268
255
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
256
        <term><option>--version</option></term>
270
257
        <listitem>
271
258
          <para>
272
259
            Prints the program version and exit.
273
260
          </para>
274
261
        </listitem>
275
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>--no-dbus</option></term>
 
266
        <listitem>
 
267
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
268
          <para>
 
269
            See also <xref linkend="dbus_interface"/>.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-ipv6</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-restore</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
285
        </listitem>
 
286
      </varlistentry>
276
287
    </variablelist>
277
288
  </refsect1>
278
 
 
 
289
  
 
290
  <refsect1 id="overview">
 
291
    <title>OVERVIEW</title>
 
292
    <xi:include href="overview.xml"/>
 
293
    <para>
 
294
      This program is the server part.  It is a normal server program
 
295
      and will run in a normal system environment, not in an initial
 
296
      <acronym>RAM</acronym> disk environment.
 
297
    </para>
 
298
  </refsect1>
 
299
  
279
300
  <refsect1 id="protocol">
280
301
    <title>NETWORK PROTOCOL</title>
281
302
    <para>
307
328
        <entry>-><!-- &rarr; --></entry>
308
329
      </row>
309
330
      <row>
310
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
331
        <entry><quote><literal>1\r\n</literal></quote></entry>
311
332
        <entry>-><!-- &rarr; --></entry>
312
333
      </row>
313
334
      <row>
333
354
      </row>
334
355
    </tbody></tgroup></table>
335
356
  </refsect1>
336
 
 
 
357
  
337
358
  <refsect1 id="checking">
338
359
    <title>CHECKING</title>
339
360
    <para>
340
361
      The server will, by default, continually check that the clients
341
362
      are still up.  If a client has not been confirmed as being up
342
363
      for some time, the client is assumed to be compromised and is no
343
 
      longer eligible to receive the encrypted password.  The timeout,
344
 
      checker program and interval between checks can be configured
345
 
      both globally and per client; see <citerefentry>
346
 
      <refentrytitle>mandos.conf</refentrytitle>
347
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
364
      longer eligible to receive the encrypted password.  (Manual
 
365
      intervention is required to re-enable a client.)  The timeout,
 
366
      extended timeout, checker program, and interval between checks
 
367
      can be configured both globally and per client; see
 
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
 
372
    </para>
 
373
  </refsect1>
 
374
  
 
375
  <refsect1 id="approval">
 
376
    <title>APPROVAL</title>
 
377
    <para>
 
378
      The server can be configured to require manual approval for a
 
379
      client before it is sent its secret.  The delay to wait for such
 
380
      approval and the default action (approve or deny) can be
 
381
      configured both globally and per client; see <citerefentry>
348
382
      <refentrytitle>mandos-clients.conf</refentrytitle>
349
 
      <manvolnum>5</manvolnum></citerefentry>.
350
 
    </para>
 
383
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
384
      will be approved immediately without delay.
 
385
    </para>
 
386
    <para>
 
387
      This can be used to deny a client its secret if not manually
 
388
      approved within a specified time.  It can also be used to make
 
389
      the server delay before giving a client its secret, allowing
 
390
      optional manual denying of this specific client.
 
391
    </para>
 
392
    
351
393
  </refsect1>
352
 
 
 
394
  
353
395
  <refsect1 id="logging">
354
396
    <title>LOGGING</title>
355
397
    <para>
356
 
      The server will send log messaged with various severity levels
357
 
      to <filename>/dev/log</filename>.  With the
 
398
      The server will send log message with various severity levels to
 
399
      <filename>/dev/log</filename>.  With the
358
400
      <option>--debug</option> option, it will log even more messages,
359
401
      and also show them on the console.
360
402
    </para>
361
403
  </refsect1>
362
 
 
 
404
  
 
405
  <refsect1 id="dbus_interface">
 
406
    <title>D-BUS INTERFACE</title>
 
407
    <para>
 
408
      The server will by default provide a D-Bus system bus interface.
 
409
      This interface will only be accessible by the root user or a
 
410
      Mandos-specific user, if such a user exists.  For documentation
 
411
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
412
    </para>
 
413
  </refsect1>
 
414
  
363
415
  <refsect1 id="exit_status">
364
416
    <title>EXIT STATUS</title>
365
417
    <para>
367
419
      critical error is encountered.
368
420
    </para>
369
421
  </refsect1>
370
 
 
371
 
  <refsect1 id="file">
 
422
  
 
423
  <refsect1 id="environment">
 
424
    <title>ENVIRONMENT</title>
 
425
    <variablelist>
 
426
      <varlistentry>
 
427
        <term><envar>PATH</envar></term>
 
428
        <listitem>
 
429
          <para>
 
430
            To start the configured checker (see <xref
 
431
            linkend="checking"/>), the server uses
 
432
            <filename>/bin/sh</filename>, which in turn uses
 
433
            <varname>PATH</varname> to search for matching commands if
 
434
            an absolute path is not given.  See <citerefentry>
 
435
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
436
            </citerefentry>.
 
437
          </para>
 
438
        </listitem>
 
439
      </varlistentry>
 
440
    </variablelist>
 
441
  </refsect1>
 
442
  
 
443
  <refsect1 id="files">
372
444
    <title>FILES</title>
373
445
    <para>
374
446
      Use the <option>--configdir</option> option to change where
397
469
        </listitem>
398
470
      </varlistentry>
399
471
      <varlistentry>
400
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
401
473
        <listitem>
402
474
          <para>
403
 
            The file containing the process id of
404
 
            <command>&COMMANDNAME;</command>.
 
475
            The file containing the process id of the
 
476
            <command>&COMMANDNAME;</command> process started last.
405
477
          </para>
406
478
        </listitem>
407
479
      </varlistentry>
414
486
          </para>
415
487
        </listitem>
416
488
      </varlistentry>
 
489
      <varlistentry>
 
490
        <term><filename>/bin/sh</filename></term>
 
491
        <listitem>
 
492
          <para>
 
493
            This is used to start the configured checker command for
 
494
            each client.  See <citerefentry>
 
495
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
496
            <manvolnum>5</manvolnum></citerefentry> for details.
 
497
          </para>
 
498
        </listitem>
 
499
      </varlistentry>
417
500
    </variablelist>
418
501
  </refsect1>
419
 
 
 
502
  
420
503
  <refsect1 id="bugs">
421
504
    <title>BUGS</title>
422
505
    <para>
423
506
      This server might, on especially fatal errors, emit a Python
424
507
      backtrace.  This could be considered a feature.
425
508
    </para>
 
509
    <para>
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
 
513
    </para>
 
514
    <para>
 
515
      There is no fine-grained control over logging and debug output.
 
516
    </para>
 
517
    <para>
 
518
      Debug mode is conflated with running in the foreground.
 
519
    </para>
 
520
    <para>
 
521
      This server does not check the expire time of clients’ OpenPGP
 
522
      keys.
 
523
    </para>
426
524
  </refsect1>
427
 
 
428
 
  <refsect1 id="examples">
429
 
    <title>EXAMPLES</title>
 
525
  
 
526
  <refsect1 id="example">
 
527
    <title>EXAMPLE</title>
430
528
    <informalexample>
431
529
      <para>
432
530
        Normal invocation needs no options:
433
531
      </para>
434
532
      <para>
435
 
        <userinput>mandos</userinput>
 
533
        <userinput>&COMMANDNAME;</userinput>
436
534
      </para>
437
535
    </informalexample>
438
536
    <informalexample>
439
537
      <para>
440
 
        Run the server in debug mode and read configuration files from
441
 
        the <filename>~/mandos</filename> directory:
 
538
        Run the server in debug mode, read configuration files from
 
539
        the <filename>~/mandos</filename> directory, and use the
 
540
        Zeroconf service name <quote>Test</quote> to not collide with
 
541
        any other official Mandos server on this host:
442
542
      </para>
443
543
      <para>
444
544
 
445
545
<!-- do not wrap this line -->
446
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
546
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
447
547
 
448
548
      </para>
449
549
    </informalexample>
455
555
      <para>
456
556
 
457
557
<!-- do not wrap this line -->
458
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
558
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
459
559
 
460
560
      </para>
461
561
    </informalexample>
462
562
  </refsect1>
463
 
 
 
563
  
464
564
  <refsect1 id="security">
465
565
    <title>SECURITY</title>
466
 
    <refsect2>
 
566
    <refsect2 id="server">
467
567
      <title>SERVER</title>
468
568
      <para>
469
 
        Running the server should not in itself present any security
470
 
        risk to the host computer running it.
 
569
        Running this <command>&COMMANDNAME;</command> server program
 
570
        should not in itself present any security risk to the host
 
571
        computer running it.  The program switches to a non-root user
 
572
        soon after startup.
471
573
      </para>
472
574
    </refsect2>
473
 
    <refsect2>
 
575
    <refsect2 id="clients">
474
576
      <title>CLIENTS</title>
475
577
      <para>
476
578
        The server only gives out its stored data to clients which
481
583
        itself and looks up the fingerprint in its list of
482
584
        clients. The <filename>clients.conf</filename> file (see
483
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
 
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
 
        by anyone except the user running the server.
 
586
        <manvolnum>5</manvolnum></citerefentry>)
 
587
        <emphasis>must</emphasis> be made non-readable by anyone
 
588
        except the user starting the server (usually root).
 
589
      </para>
 
590
      <para>
 
591
        As detailed in <xref linkend="checking"/>, the status of all
 
592
        client computers will continually be checked and be assumed
 
593
        compromised if they are gone for too long.
 
594
      </para>
 
595
      <para>
 
596
        If a client is compromised, its downtime should be duly noted
 
597
        by the server which would therefore disable the client.  But
 
598
        if the server was ever restarted, it would re-read its client
 
599
        list from its configuration file and again regard all clients
 
600
        therein as enabled, and hence eligible to receive their
 
601
        passwords.  Therefore, be careful when restarting servers if
 
602
        it is suspected that a client has, in fact, been compromised
 
603
        by parties who may now be running a fake Mandos client with
 
604
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
605
        image of the client host.  What should be done in that case
 
606
        (if restarting the server program really is necessary) is to
 
607
        stop the server program, edit the configuration file to omit
 
608
        any suspect clients, and restart the server program.
486
609
      </para>
487
610
      <para>
488
611
        For more details on client-side security, see
489
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
490
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
491
614
      </para>
492
615
    </refsect2>
493
616
  </refsect1>
494
 
 
 
617
  
495
618
  <refsect1 id="see_also">
496
619
    <title>SEE ALSO</title>
497
 
    <itemizedlist spacing="compact">
498
 
      <listitem><para>
499
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
500
 
        <manvolnum>8mandos</manvolnum></citerefentry>
501
 
      </para></listitem>
502
 
      
503
 
      <listitem><para>
504
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
 
        <manvolnum>8mandos</manvolnum></citerefentry>
506
 
      </para></listitem>
507
 
      
508
 
      <listitem><para>
509
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
510
 
      </para></listitem>
511
 
      
512
 
      <listitem><para>
513
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
514
 
      </para></listitem>
515
 
      
516
 
      <listitem><para>
517
 
        <ulink
518
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
519
 
      </para></listitem>
520
 
      
521
 
      <listitem><para>
522
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
523
 
        Format</citetitle></citation>
524
 
      </para></listitem>
525
 
      
526
 
      <listitem><para>
527
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
 
        Transport Layer Security</citetitle></citation>
529
 
      </para></listitem>
530
 
      
531
 
      <listitem><para>
532
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
 
        Unicast Addresses</citation>
535
 
      </para></listitem>
536
 
    </itemizedlist>
 
620
    <para>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
624
      <manvolnum>5</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>sh</refentrytitle>
 
630
      <manvolnum>1</manvolnum></citerefentry>
 
631
    </para>
 
632
    <variablelist>
 
633
      <varlistentry>
 
634
        <term>
 
635
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
636
        </term>
 
637
        <listitem>
 
638
          <para>
 
639
            Zeroconf is the network protocol standard used by clients
 
640
            for finding this Mandos server on the local network.
 
641
          </para>
 
642
        </listitem>
 
643
      </varlistentry>
 
644
      <varlistentry>
 
645
        <term>
 
646
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
647
        </term>
 
648
      <listitem>
 
649
        <para>
 
650
          Avahi is the library this server calls to implement
 
651
          Zeroconf service announcements.
 
652
        </para>
 
653
      </listitem>
 
654
      </varlistentry>
 
655
      <varlistentry>
 
656
        <term>
 
657
          <ulink url="http://www.gnu.org/software/gnutls/"
 
658
          >GnuTLS</ulink>
 
659
        </term>
 
660
      <listitem>
 
661
        <para>
 
662
          GnuTLS is the library this server uses to implement TLS for
 
663
          communicating securely with the client, and at the same time
 
664
          confidently get the client’s public OpenPGP key.
 
665
        </para>
 
666
      </listitem>
 
667
      </varlistentry>
 
668
      <varlistentry>
 
669
        <term>
 
670
          RFC 4291: <citetitle>IP Version 6 Addressing
 
671
          Architecture</citetitle>
 
672
        </term>
 
673
        <listitem>
 
674
          <variablelist>
 
675
            <varlistentry>
 
676
              <term>Section 2.2: <citetitle>Text Representation of
 
677
              Addresses</citetitle></term>
 
678
              <listitem><para/></listitem>
 
679
            </varlistentry>
 
680
            <varlistentry>
 
681
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
682
              Address</citetitle></term>
 
683
              <listitem><para/></listitem>
 
684
            </varlistentry>
 
685
            <varlistentry>
 
686
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
687
            Addresses</citetitle></term>
 
688
            <listitem>
 
689
              <para>
 
690
                The clients use IPv6 link-local addresses, which are
 
691
                immediately usable since a link-local addresses is
 
692
                automatically assigned to a network interfaces when it
 
693
                is brought up.
 
694
              </para>
 
695
            </listitem>
 
696
            </varlistentry>
 
697
          </variablelist>
 
698
        </listitem>
 
699
      </varlistentry>
 
700
      <varlistentry>
 
701
        <term>
 
702
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
703
          Protocol Version 1.1</citetitle>
 
704
        </term>
 
705
      <listitem>
 
706
        <para>
 
707
          TLS 1.1 is the protocol implemented by GnuTLS.
 
708
        </para>
 
709
      </listitem>
 
710
      </varlistentry>
 
711
      <varlistentry>
 
712
        <term>
 
713
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
714
        </term>
 
715
      <listitem>
 
716
        <para>
 
717
          The data sent to clients is binary encrypted OpenPGP data.
 
718
        </para>
 
719
      </listitem>
 
720
      </varlistentry>
 
721
      <varlistentry>
 
722
        <term>
 
723
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
724
          Security</citetitle>
 
725
        </term>
 
726
      <listitem>
 
727
        <para>
 
728
          This is implemented by GnuTLS and used by this server so
 
729
          that OpenPGP keys can be used.
 
730
        </para>
 
731
      </listitem>
 
732
      </varlistentry>
 
733
    </variablelist>
537
734
  </refsect1>
538
735
</refentry>
 
736
<!-- Local Variables: -->
 
737
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
738
<!-- time-stamp-end: "[\"']>" -->
 
739
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
740
<!-- End: -->