/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

Show diffs side-by-side

added added

removed removed

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