/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 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

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