/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-04 21:20:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090104212050-cl2px2i2oz7wlxw1
* debian/control (Build-Depends): Bug fix: Added "docbook-xml".

* mandos (main): Keep running even if no clients are defined.

* mandos.xml (OPTIONS): Bug fix: Close unclosed <para> tag.
  (D-BUS INTERFACE): Changed id to "dbus_interface".  All references
                     changed.

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