/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: 2008-08-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

Show diffs side-by-side

added added

removed removed

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