/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

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