/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-09-17">
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-ipv6</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-ipv6</option></term>
237
 
        <listitem>
238
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
 
        </listitem>
240
 
      </varlistentry>
241
276
    </variablelist>
242
277
  </refsect1>
243
 
  
244
 
  <refsect1 id="overview">
245
 
    <title>OVERVIEW</title>
246
 
    <xi:include href="overview.xml"/>
247
 
    <para>
248
 
      This program is the server part.  It is a normal server program
249
 
      and will run in a normal system environment, not in an initial
250
 
      <acronym>RAM</acronym> disk environment.
251
 
    </para>
252
 
  </refsect1>
253
 
  
 
278
 
254
279
  <refsect1 id="protocol">
255
280
    <title>NETWORK PROTOCOL</title>
256
281
    <para>
282
307
        <entry>-><!-- &rarr; --></entry>
283
308
      </row>
284
309
      <row>
285
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
310
        <entry><quote><literal>1\r\en</literal></quote></entry>
286
311
        <entry>-><!-- &rarr; --></entry>
287
312
      </row>
288
313
      <row>
308
333
      </row>
309
334
    </tbody></tgroup></table>
310
335
  </refsect1>
311
 
  
 
336
 
312
337
  <refsect1 id="checking">
313
338
    <title>CHECKING</title>
314
339
    <para>
315
340
      The server will, by default, continually check that the clients
316
341
      are still up.  If a client has not been confirmed as being up
317
342
      for some time, the client is assumed to be compromised and is no
318
 
      longer eligible to receive the encrypted password.  (Manual
319
 
      intervention is required to re-enable a client.)  The timeout,
320
 
      checker program, and interval between checks can be configured
 
343
      longer eligible to receive the encrypted password.  The timeout,
 
344
      checker program and interval between checks can be configured
321
345
      both globally and per client; see <citerefentry>
 
346
      <refentrytitle>mandos.conf</refentrytitle>
 
347
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
322
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
324
 
      receiving its password will also be treated as a successful
325
 
      checker run.
 
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
 
  
 
362
 
339
363
  <refsect1 id="exit_status">
340
364
    <title>EXIT STATUS</title>
341
365
    <para>
343
367
      critical error is encountered.
344
368
    </para>
345
369
  </refsect1>
346
 
  
347
 
  <refsect1 id="environment">
348
 
    <title>ENVIRONMENT</title>
349
 
    <variablelist>
350
 
      <varlistentry>
351
 
        <term><envar>PATH</envar></term>
352
 
        <listitem>
353
 
          <para>
354
 
            To start the configured checker (see <xref
355
 
            linkend="checking"/>), the server uses
356
 
            <filename>/bin/sh</filename>, which in turn uses
357
 
            <varname>PATH</varname> to search for matching commands if
358
 
            an absolute path is not given.  See <citerefentry>
359
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
360
 
            </citerefentry>.
361
 
          </para>
362
 
        </listitem>
363
 
      </varlistentry>
364
 
    </variablelist>
365
 
  </refsect1>
366
 
  
367
 
  <refsect1 id="files">
 
370
 
 
371
  <refsect1 id="file">
368
372
    <title>FILES</title>
369
373
    <para>
370
374
      Use the <option>--configdir</option> option to change where
393
397
        </listitem>
394
398
      </varlistentry>
395
399
      <varlistentry>
396
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
400
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
397
401
        <listitem>
398
402
          <para>
399
403
            The file containing the process id of
410
414
          </para>
411
415
        </listitem>
412
416
      </varlistentry>
413
 
      <varlistentry>
414
 
        <term><filename>/bin/sh</filename></term>
415
 
        <listitem>
416
 
          <para>
417
 
            This is used to start the configured checker command for
418
 
            each client.  See <citerefentry>
419
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
420
 
            <manvolnum>5</manvolnum></citerefentry> for details.
421
 
          </para>
422
 
        </listitem>
423
 
      </varlistentry>
424
417
    </variablelist>
425
418
  </refsect1>
426
 
  
 
419
 
427
420
  <refsect1 id="bugs">
428
421
    <title>BUGS</title>
429
422
    <para>
430
423
      This server might, on especially fatal errors, emit a Python
431
424
      backtrace.  This could be considered a feature.
432
425
    </para>
433
 
    <para>
434
 
      Currently, if a client is declared <quote>invalid</quote> due to
435
 
      having timed out, the server does not record this fact onto
436
 
      permanent storage.  This has some security implications, see
437
 
      <xref linkend="clients"/>.
438
 
    </para>
439
 
    <para>
440
 
      There is currently no way of querying the server of the current
441
 
      status of clients, other than analyzing its <systemitem
442
 
      class="service">syslog</systemitem> output.
443
 
    </para>
444
 
    <para>
445
 
      There is no fine-grained control over logging and debug output.
446
 
    </para>
447
 
    <para>
448
 
      Debug mode is conflated with running in the foreground.
449
 
    </para>
450
 
    <para>
451
 
      The console log messages do not show a time stamp.
452
 
    </para>
453
 
    <para>
454
 
      This server does not check the expire time of clients’ OpenPGP
455
 
      keys.
456
 
    </para>
457
426
  </refsect1>
458
 
  
459
 
  <refsect1 id="example">
460
 
    <title>EXAMPLE</title>
 
427
 
 
428
  <refsect1 id="examples">
 
429
    <title>EXAMPLES</title>
461
430
    <informalexample>
462
431
      <para>
463
432
        Normal invocation needs no options:
464
433
      </para>
465
434
      <para>
466
 
        <userinput>&COMMANDNAME;</userinput>
 
435
        <userinput>mandos</userinput>
467
436
      </para>
468
437
    </informalexample>
469
438
    <informalexample>
470
439
      <para>
471
 
        Run the server in debug mode, read configuration files from
472
 
        the <filename>~/mandos</filename> directory, and use the
473
 
        Zeroconf service name <quote>Test</quote> to not collide with
474
 
        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:
475
442
      </para>
476
443
      <para>
477
444
 
478
445
<!-- do not wrap this line -->
479
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
446
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
480
447
 
481
448
      </para>
482
449
    </informalexample>
488
455
      <para>
489
456
 
490
457
<!-- do not wrap this line -->
491
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
492
459
 
493
460
      </para>
494
461
    </informalexample>
495
462
  </refsect1>
496
 
  
 
463
 
497
464
  <refsect1 id="security">
498
465
    <title>SECURITY</title>
499
 
    <refsect2 id="server">
 
466
    <refsect2>
500
467
      <title>SERVER</title>
501
468
      <para>
502
 
        Running this <command>&COMMANDNAME;</command> server program
503
 
        should not in itself present any security risk to the host
504
 
        computer running it.  The program switches to a non-root user
505
 
        soon after startup.
 
469
        Running the server should not in itself present any security
 
470
        risk to the host computer running it.
506
471
      </para>
507
472
    </refsect2>
508
 
    <refsect2 id="clients">
 
473
    <refsect2>
509
474
      <title>CLIENTS</title>
510
475
      <para>
511
476
        The server only gives out its stored data to clients which
516
481
        itself and looks up the fingerprint in its list of
517
482
        clients. The <filename>clients.conf</filename> file (see
518
483
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
519
 
        <manvolnum>5</manvolnum></citerefentry>)
520
 
        <emphasis>must</emphasis> be made non-readable by anyone
521
 
        except the user starting the server (usually root).
522
 
      </para>
523
 
      <para>
524
 
        As detailed in <xref linkend="checking"/>, the status of all
525
 
        client computers will continually be checked and be assumed
526
 
        compromised if they are gone for too long.
527
 
      </para>
528
 
      <para>
529
 
        If a client is compromised, its downtime should be duly noted
530
 
        by the server which would therefore declare the client
531
 
        invalid.  But if the server was ever restarted, it would
532
 
        re-read its client list from its configuration file and again
533
 
        regard all clients therein as valid, and hence eligible to
534
 
        receive their passwords.  Therefore, be careful when
535
 
        restarting servers if it is suspected that a client has, in
536
 
        fact, been compromised by parties who may now be running a
537
 
        fake Mandos client with the keys from the non-encrypted
538
 
        initial <acronym>RAM</acronym> image of the client host.  What
539
 
        should be done in that case (if restarting the server program
540
 
        really is necessary) is to stop the server program, edit the
541
 
        configuration file to omit any suspect clients, and restart
542
 
        the server program.
 
484
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
 
485
        by anyone except the user running the server.
543
486
      </para>
544
487
      <para>
545
488
        For more details on client-side security, see
546
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
489
        <citerefentry><refentrytitle>password-request</refentrytitle>
547
490
        <manvolnum>8mandos</manvolnum></citerefentry>.
548
491
      </para>
549
492
    </refsect2>
550
493
  </refsect1>
551
 
  
 
494
 
552
495
  <refsect1 id="see_also">
553
496
    <title>SEE ALSO</title>
554
 
    <para>
555
 
      <citerefentry>
556
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
557
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
558
 
        <refentrytitle>mandos.conf</refentrytitle>
559
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
560
 
        <refentrytitle>mandos-client</refentrytitle>
561
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
562
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
563
 
      </citerefentry>
564
 
    </para>
565
 
    <variablelist>
566
 
      <varlistentry>
567
 
        <term>
568
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
569
 
        </term>
570
 
        <listitem>
571
 
          <para>
572
 
            Zeroconf is the network protocol standard used by clients
573
 
            for finding this Mandos server on the local network.
574
 
          </para>
575
 
        </listitem>
576
 
      </varlistentry>
577
 
      <varlistentry>
578
 
        <term>
579
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
580
 
        </term>
581
 
      <listitem>
582
 
        <para>
583
 
          Avahi is the library this server calls to implement
584
 
          Zeroconf service announcements.
585
 
        </para>
586
 
      </listitem>
587
 
      </varlistentry>
588
 
      <varlistentry>
589
 
        <term>
590
 
          <ulink url="http://www.gnu.org/software/gnutls/"
591
 
          >GnuTLS</ulink>
592
 
        </term>
593
 
      <listitem>
594
 
        <para>
595
 
          GnuTLS is the library this server uses to implement TLS for
596
 
          communicating securely with the client, and at the same time
597
 
          confidently get the client’s public OpenPGP key.
598
 
        </para>
599
 
      </listitem>
600
 
      </varlistentry>
601
 
      <varlistentry>
602
 
        <term>
603
 
          RFC 4291: <citetitle>IP Version 6 Addressing
604
 
          Architecture</citetitle>
605
 
        </term>
606
 
        <listitem>
607
 
          <variablelist>
608
 
            <varlistentry>
609
 
              <term>Section 2.2: <citetitle>Text Representation of
610
 
              Addresses</citetitle></term>
611
 
              <listitem><para/></listitem>
612
 
            </varlistentry>
613
 
            <varlistentry>
614
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
615
 
              Address</citetitle></term>
616
 
              <listitem><para/></listitem>
617
 
            </varlistentry>
618
 
            <varlistentry>
619
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
620
 
            Addresses</citetitle></term>
621
 
            <listitem>
622
 
              <para>
623
 
                The clients use IPv6 link-local addresses, which are
624
 
                immediately usable since a link-local addresses is
625
 
                automatically assigned to a network interfaces when it
626
 
                is brought up.
627
 
              </para>
628
 
            </listitem>
629
 
            </varlistentry>
630
 
          </variablelist>
631
 
        </listitem>
632
 
      </varlistentry>
633
 
      <varlistentry>
634
 
        <term>
635
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
636
 
          Protocol Version 1.1</citetitle>
637
 
        </term>
638
 
      <listitem>
639
 
        <para>
640
 
          TLS 1.1 is the protocol implemented by GnuTLS.
641
 
        </para>
642
 
      </listitem>
643
 
      </varlistentry>
644
 
      <varlistentry>
645
 
        <term>
646
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
647
 
        </term>
648
 
      <listitem>
649
 
        <para>
650
 
          The data sent to clients is binary encrypted OpenPGP data.
651
 
        </para>
652
 
      </listitem>
653
 
      </varlistentry>
654
 
      <varlistentry>
655
 
        <term>
656
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
657
 
          Security</citetitle>
658
 
        </term>
659
 
      <listitem>
660
 
        <para>
661
 
          This is implemented by GnuTLS and used by this server so
662
 
          that OpenPGP keys can be used.
663
 
        </para>
664
 
      </listitem>
665
 
      </varlistentry>
666
 
    </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>
667
537
  </refsect1>
668
538
</refentry>
669
 
<!-- Local Variables: -->
670
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
671
 
<!-- time-stamp-end: "[\"']>" -->
672
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
673
 
<!-- End: -->