/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-07-22 06:23:59 UTC
  • mfrom: (24.1.1 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080722062359-qti3ecst69bq3ltk
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2012-01-01">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
 
]>
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>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@recompile.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@recompile.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <holder>Teddy Hogeborn</holder>
40
 
      <holder>Björn Påhlsson</holder>
41
 
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
43
 
  </refentryinfo>
44
 
  
45
 
  <refmeta>
46
 
    <refentrytitle>&COMMANDNAME;</refentrytitle>
47
 
    <manvolnum>8</manvolnum>
48
 
  </refmeta>
49
 
  
50
 
  <refnamediv>
51
 
    <refname><command>&COMMANDNAME;</command></refname>
52
 
    <refpurpose>
53
 
      Gives encrypted passwords to authenticated Mandos clients
54
 
    </refpurpose>
55
 
  </refnamediv>
56
 
  
57
 
  <refsynopsisdiv>
58
 
    <cmdsynopsis>
59
 
      <command>&COMMANDNAME;</command>
60
 
      <group>
61
 
        <arg choice="plain"><option>--interface
62
 
        <replaceable>NAME</replaceable></option></arg>
63
 
        <arg choice="plain"><option>-i
64
 
        <replaceable>NAME</replaceable></option></arg>
65
 
      </group>
66
 
      <sbr/>
67
 
      <group>
68
 
        <arg choice="plain"><option>--address
69
 
        <replaceable>ADDRESS</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-a
71
 
        <replaceable>ADDRESS</replaceable></option></arg>
72
 
      </group>
73
 
      <sbr/>
74
 
      <group>
75
 
        <arg choice="plain"><option>--port
76
 
        <replaceable>PORT</replaceable></option></arg>
77
 
        <arg choice="plain"><option>-p
78
 
        <replaceable>PORT</replaceable></option></arg>
79
 
      </group>
80
 
      <sbr/>
81
 
      <arg><option>--priority
82
 
      <replaceable>PRIORITY</replaceable></option></arg>
83
 
      <sbr/>
84
 
      <arg><option>--servicename
85
 
      <replaceable>NAME</replaceable></option></arg>
86
 
      <sbr/>
87
 
      <arg><option>--configdir
88
 
      <replaceable>DIRECTORY</replaceable></option></arg>
89
 
      <sbr/>
90
 
      <arg><option>--debug</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--debuglevel
93
 
      <replaceable>LEVEL</replaceable></option></arg>
94
 
      <sbr/>
95
 
      <arg><option>--no-dbus</option></arg>
96
 
      <sbr/>
97
 
      <arg><option>--no-ipv6</option></arg>
98
 
      <sbr/>
99
 
      <arg><option>--no-restore</option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--statedir
102
 
      <replaceable>DIRECTORY</replaceable></option></arg>
103
 
    </cmdsynopsis>
104
 
    <cmdsynopsis>
105
 
      <command>&COMMANDNAME;</command>
106
 
      <group choice="req">
107
 
        <arg choice="plain"><option>--help</option></arg>
108
 
        <arg choice="plain"><option>-h</option></arg>
109
 
      </group>
110
 
    </cmdsynopsis>
111
 
    <cmdsynopsis>
112
 
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--version</option></arg>
114
 
    </cmdsynopsis>
115
 
    <cmdsynopsis>
116
 
      <command>&COMMANDNAME;</command>
117
 
      <arg choice="plain"><option>--check</option></arg>
118
 
    </cmdsynopsis>
119
 
  </refsynopsisdiv>
120
 
  
121
 
  <refsect1 id="description">
122
 
    <title>DESCRIPTION</title>
123
 
    <para>
124
 
      <command>&COMMANDNAME;</command> is a server daemon which
125
 
      handles incoming request for passwords for a pre-defined list of
126
 
      client host computers. For an introduction, see
127
 
      <citerefentry><refentrytitle>intro</refentrytitle>
128
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
 
      uses Zeroconf to announce itself on the local network, and uses
130
 
      TLS to communicate securely with and to authenticate the
131
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
132
 
      use IPv6 link-local addresses, since the clients will probably
133
 
      not have any other addresses configured (see <xref
134
 
      linkend="overview"/>).  Any authenticated client is then given
135
 
      the stored pre-encrypted password for that specific client.
136
 
    </para>
137
 
  </refsect1>
138
 
  
139
 
  <refsect1 id="purpose">
140
 
    <title>PURPOSE</title>
141
 
    <para>
142
 
      The purpose of this is to enable <emphasis>remote and unattended
143
 
      rebooting</emphasis> of client host computer with an
144
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
145
 
      linkend="overview"/> for details.
146
 
    </para>
147
 
  </refsect1>
148
 
  
149
 
  <refsect1 id="options">
150
 
    <title>OPTIONS</title>
151
 
    <variablelist>
152
 
      <varlistentry>
153
 
        <term><option>--help</option></term>
154
 
        <term><option>-h</option></term>
155
 
        <listitem>
156
 
          <para>
157
 
            Show a help message and exit
158
 
          </para>
159
 
        </listitem>
160
 
      </varlistentry>
161
 
      
162
 
      <varlistentry>
163
 
        <term><option>--interface</option>
164
 
        <replaceable>NAME</replaceable></term>
165
 
        <term><option>-i</option>
166
 
        <replaceable>NAME</replaceable></term>
167
 
        <listitem>
168
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
169
 
        </listitem>
170
 
      </varlistentry>
171
 
      
172
 
      <varlistentry>
173
 
        <term><option>--address
174
 
        <replaceable>ADDRESS</replaceable></option></term>
175
 
        <term><option>-a
176
 
        <replaceable>ADDRESS</replaceable></option></term>
177
 
        <listitem>
178
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
179
 
        </listitem>
180
 
      </varlistentry>
181
 
      
182
 
      <varlistentry>
183
 
        <term><option>--port
184
 
        <replaceable>PORT</replaceable></option></term>
185
 
        <term><option>-p
186
 
        <replaceable>PORT</replaceable></option></term>
187
 
        <listitem>
188
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
189
 
        </listitem>
190
 
      </varlistentry>
191
 
      
192
 
      <varlistentry>
193
 
        <term><option>--check</option></term>
194
 
        <listitem>
195
 
          <para>
196
 
            Run the server’s self-tests.  This includes any unit
197
 
            tests, etc.
198
 
          </para>
199
 
        </listitem>
200
 
      </varlistentry>
201
 
      
202
 
      <varlistentry>
203
 
        <term><option>--debug</option></term>
204
 
        <listitem>
205
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
206
 
        </listitem>
207
 
      </varlistentry>
208
 
      
209
 
      <varlistentry>
210
 
        <term><option>--debuglevel
211
 
        <replaceable>LEVEL</replaceable></option></term>
212
 
        <listitem>
213
 
          <para>
214
 
            Set the debugging log level.
215
 
            <replaceable>LEVEL</replaceable> is a string, one of
216
 
            <quote><literal>CRITICAL</literal></quote>,
217
 
            <quote><literal>ERROR</literal></quote>,
218
 
            <quote><literal>WARNING</literal></quote>,
219
 
            <quote><literal>INFO</literal></quote>, or
220
 
            <quote><literal>DEBUG</literal></quote>, in order of
221
 
            increasing verbosity.  The default level is
222
 
            <quote><literal>WARNING</literal></quote>.
223
 
          </para>
224
 
        </listitem>
225
 
      </varlistentry>
226
 
      
227
 
      <varlistentry>
228
 
        <term><option>--priority <replaceable>
229
 
        PRIORITY</replaceable></option></term>
230
 
        <listitem>
231
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
 
        <term><option>--servicename
237
 
        <replaceable>NAME</replaceable></option></term>
238
 
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="servicename"/>
241
 
        </listitem>
242
 
      </varlistentry>
243
 
      
244
 
      <varlistentry>
245
 
        <term><option>--configdir
246
 
        <replaceable>DIRECTORY</replaceable></option></term>
247
 
        <listitem>
248
 
          <para>
249
 
            Directory to search for configuration files.  Default is
250
 
            <quote><literal>/etc/mandos</literal></quote>.  See
251
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
252
 
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
253
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
254
 
            <manvolnum>5</manvolnum></citerefentry>.
255
 
          </para>
256
 
        </listitem>
257
 
      </varlistentry>
258
 
      
259
 
      <varlistentry>
260
 
        <term><option>--version</option></term>
261
 
        <listitem>
262
 
          <para>
263
 
            Prints the program version and exit.
264
 
          </para>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
      
268
 
      <varlistentry>
269
 
        <term><option>--no-dbus</option></term>
270
 
        <listitem>
271
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
272
 
          <para>
273
 
            See also <xref linkend="dbus_interface"/>.
274
 
          </para>
275
 
        </listitem>
276
 
      </varlistentry>
277
 
      
278
 
      <varlistentry>
279
 
        <term><option>--no-ipv6</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-restore</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
289
 
          <para>
290
 
            See also <xref linkend="persistent_state"/>.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--statedir
297
 
        <replaceable>DIRECTORY</replaceable></option></term>
298
 
        <listitem>
299
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
 
        </listitem>
301
 
      </varlistentry>
302
 
    </variablelist>
303
 
  </refsect1>
304
 
  
305
 
  <refsect1 id="overview">
306
 
    <title>OVERVIEW</title>
307
 
    <xi:include href="overview.xml"/>
308
 
    <para>
309
 
      This program is the server part.  It is a normal server program
310
 
      and will run in a normal system environment, not in an initial
311
 
      <acronym>RAM</acronym> disk environment.
312
 
    </para>
313
 
  </refsect1>
314
 
  
315
 
  <refsect1 id="protocol">
316
 
    <title>NETWORK PROTOCOL</title>
317
 
    <para>
318
 
      The Mandos server announces itself as a Zeroconf service of type
319
 
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
320
 
      client connects to the announced address and port, and sends a
321
 
      line of text where the first whitespace-separated field is the
322
 
      protocol version, which currently is
323
 
      <quote><literal>1</literal></quote>.  The client and server then
324
 
      start a TLS protocol handshake with a slight quirk: the Mandos
325
 
      server program acts as a TLS <quote>client</quote> while the
326
 
      connecting Mandos client acts as a TLS <quote>server</quote>.
327
 
      The Mandos client must supply an OpenPGP certificate, and the
328
 
      fingerprint of this certificate is used by the Mandos server to
329
 
      look up (in a list read from <filename>clients.conf</filename>
330
 
      at start time) which binary blob to give the client.  No other
331
 
      authentication or authorization is done by the server.
332
 
    </para>
333
 
    <table>
334
 
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
335
 
      <row>
336
 
        <entry>Mandos Client</entry>
337
 
        <entry>Direction</entry>
338
 
        <entry>Mandos Server</entry>
339
 
      </row>
340
 
      </thead><tbody>
341
 
      <row>
342
 
        <entry>Connect</entry>
343
 
        <entry>-><!-- &rarr; --></entry>
344
 
      </row>
345
 
      <row>
346
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
347
 
        <entry>-><!-- &rarr; --></entry>
348
 
      </row>
349
 
      <row>
350
 
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
351
 
        </emphasis></entry>
352
 
        <entry>&lt;-><!-- &xharr; --></entry>
353
 
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
354
 
        </emphasis></entry>
355
 
      </row>
356
 
      <row>
357
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
358
 
        <entry>-><!-- &rarr; --></entry>
359
 
      </row>
360
 
      <row>
361
 
        <entry/>
362
 
        <entry>&lt;-<!-- &larr; --></entry>
363
 
        <entry>Binary blob (client will assume OpenPGP data)</entry>
364
 
      </row>
365
 
      <row>
366
 
        <entry/>
367
 
        <entry>&lt;-<!-- &larr; --></entry>
368
 
        <entry>Close</entry>
369
 
      </row>
370
 
    </tbody></tgroup></table>
371
 
  </refsect1>
372
 
  
373
 
  <refsect1 id="checking">
374
 
    <title>CHECKING</title>
375
 
    <para>
376
 
      The server will, by default, continually check that the clients
377
 
      are still up.  If a client has not been confirmed as being up
378
 
      for some time, the client is assumed to be compromised and is no
379
 
      longer eligible to receive the encrypted password.  (Manual
380
 
      intervention is required to re-enable a client.)  The timeout,
381
 
      extended timeout, checker program, and interval between checks
382
 
      can be configured both globally and per client; see
383
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
385
 
      receiving its password will also be treated as a successful
386
 
      checker run.
387
 
    </para>
388
 
  </refsect1>
389
 
  
390
 
  <refsect1 id="approval">
391
 
    <title>APPROVAL</title>
392
 
    <para>
393
 
      The server can be configured to require manual approval for a
394
 
      client before it is sent its secret.  The delay to wait for such
395
 
      approval and the default action (approve or deny) can be
396
 
      configured both globally and per client; see <citerefentry>
397
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
398
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
399
 
      will be approved immediately without delay.
400
 
    </para>
401
 
    <para>
402
 
      This can be used to deny a client its secret if not manually
403
 
      approved within a specified time.  It can also be used to make
404
 
      the server delay before giving a client its secret, allowing
405
 
      optional manual denying of this specific client.
406
 
    </para>
407
 
    
408
 
  </refsect1>
409
 
  
410
 
  <refsect1 id="logging">
411
 
    <title>LOGGING</title>
412
 
    <para>
413
 
      The server will send log message with various severity levels to
414
 
      <filename class="devicefile">/dev/log</filename>.  With the
415
 
      <option>--debug</option> option, it will log even more messages,
416
 
      and also show them on the console.
417
 
    </para>
418
 
  </refsect1>
419
 
  
420
 
  <refsect1 id="persistent_state">
421
 
    <title>PERSISTENT STATE</title>
422
 
    <para>
423
 
      Client settings, initially read from
424
 
      <filename>clients.conf</filename>, are persistent across
425
 
      restarts, and run-time changes will override settings in
426
 
      <filename>clients.conf</filename>.  However, if a setting is
427
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
428
 
      <filename>clients.conf</filename>, this will take precedence.
429
 
    </para>
430
 
  </refsect1>
431
 
  
432
 
  <refsect1 id="dbus_interface">
433
 
    <title>D-BUS INTERFACE</title>
434
 
    <para>
435
 
      The server will by default provide a D-Bus system bus interface.
436
 
      This interface will only be accessible by the root user or a
437
 
      Mandos-specific user, if such a user exists.  For documentation
438
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
439
 
    </para>
440
 
  </refsect1>
441
 
  
442
 
  <refsect1 id="exit_status">
443
 
    <title>EXIT STATUS</title>
444
 
    <para>
445
 
      The server will exit with a non-zero exit status only when a
446
 
      critical error is encountered.
447
 
    </para>
448
 
  </refsect1>
449
 
  
450
 
  <refsect1 id="environment">
451
 
    <title>ENVIRONMENT</title>
452
 
    <variablelist>
453
 
      <varlistentry>
454
 
        <term><envar>PATH</envar></term>
455
 
        <listitem>
456
 
          <para>
457
 
            To start the configured checker (see <xref
458
 
            linkend="checking"/>), the server uses
459
 
            <filename>/bin/sh</filename>, which in turn uses
460
 
            <varname>PATH</varname> to search for matching commands if
461
 
            an absolute path is not given.  See <citerefentry>
462
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
463
 
            </citerefentry>.
464
 
          </para>
465
 
        </listitem>
466
 
      </varlistentry>
467
 
    </variablelist>
468
 
  </refsect1>
469
 
  
470
 
  <refsect1 id="files">
471
 
    <title>FILES</title>
472
 
    <para>
473
 
      Use the <option>--configdir</option> option to change where
474
 
      <command>&COMMANDNAME;</command> looks for its configurations
475
 
      files.  The default file names are listed here.
476
 
    </para>
477
 
    <variablelist>
478
 
      <varlistentry>
479
 
        <term><filename>/etc/mandos/mandos.conf</filename></term>
480
 
        <listitem>
481
 
          <para>
482
 
            Server-global settings.  See
483
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
484
 
            <manvolnum>5</manvolnum></citerefentry> for details.
485
 
          </para>
486
 
        </listitem>
487
 
      </varlistentry>
488
 
      <varlistentry>
489
 
        <term><filename>/etc/mandos/clients.conf</filename></term>
490
 
        <listitem>
491
 
          <para>
492
 
            List of clients and client-specific settings.  See
493
 
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
494
 
            <manvolnum>5</manvolnum></citerefentry> for details.
495
 
          </para>
496
 
        </listitem>
497
 
      </varlistentry>
498
 
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
500
 
        <listitem>
501
 
          <para>
502
 
            The file containing the process id of the
503
 
            <command>&COMMANDNAME;</command> process started last.
504
 
          </para>
505
 
        </listitem>
506
 
      </varlistentry>
507
 
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
 
        <term><filename
512
 
        class="directory">/var/lib/mandos</filename></term>
513
 
        <listitem>
514
 
          <para>
515
 
            Directory where persistent state will be saved.  Change
516
 
            this with the <option>--statedir</option> option.  See
517
 
            also the <option>--no-restore</option> option.
518
 
          </para>
519
 
        </listitem>
520
 
      </varlistentry>
521
 
      <varlistentry>
522
 
        <term><filename>/dev/log</filename></term>
523
 
        <listitem>
524
 
          <para>
525
 
            The Unix domain socket to where local syslog messages are
526
 
            sent.
527
 
          </para>
528
 
        </listitem>
529
 
      </varlistentry>
530
 
      <varlistentry>
531
 
        <term><filename>/bin/sh</filename></term>
532
 
        <listitem>
533
 
          <para>
534
 
            This is used to start the configured checker command for
535
 
            each client.  See <citerefentry>
536
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
537
 
            <manvolnum>5</manvolnum></citerefentry> for details.
538
 
          </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
    </variablelist>
542
 
  </refsect1>
543
 
  
544
 
  <refsect1 id="bugs">
545
 
    <title>BUGS</title>
546
 
    <para>
547
 
      This server might, on especially fatal errors, emit a Python
548
 
      backtrace.  This could be considered a feature.
549
 
    </para>
550
 
    <para>
551
 
      There is no fine-grained control over logging and debug output.
552
 
    </para>
553
 
    <para>
554
 
      Debug mode is conflated with running in the foreground.
555
 
    </para>
556
 
    <para>
557
 
      This server does not check the expire time of clients’ OpenPGP
558
 
      keys.
559
 
    </para>
560
 
  </refsect1>
561
 
  
562
 
  <refsect1 id="example">
563
 
    <title>EXAMPLE</title>
564
 
    <informalexample>
565
 
      <para>
566
 
        Normal invocation needs no options:
567
 
      </para>
568
 
      <para>
569
 
        <userinput>&COMMANDNAME;</userinput>
570
 
      </para>
571
 
    </informalexample>
572
 
    <informalexample>
573
 
      <para>
574
 
        Run the server in debug mode, read configuration files from
575
 
        the <filename class="directory">~/mandos</filename> directory,
576
 
        and use the Zeroconf service name <quote>Test</quote> to not
577
 
        collide with any other official Mandos server on this host:
578
 
      </para>
579
 
      <para>
580
 
 
581
 
<!-- do not wrap this line -->
582
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
583
 
 
584
 
      </para>
585
 
    </informalexample>
586
 
    <informalexample>
587
 
      <para>
588
 
        Run the server normally, but only listen to one interface and
589
 
        only on the link-local address on that interface:
590
 
      </para>
591
 
      <para>
592
 
 
593
 
<!-- do not wrap this line -->
594
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
595
 
 
596
 
      </para>
597
 
    </informalexample>
598
 
  </refsect1>
599
 
  
600
 
  <refsect1 id="security">
601
 
    <title>SECURITY</title>
602
 
    <refsect2 id="server">
603
 
      <title>SERVER</title>
604
 
      <para>
605
 
        Running this <command>&COMMANDNAME;</command> server program
606
 
        should not in itself present any security risk to the host
607
 
        computer running it.  The program switches to a non-root user
608
 
        soon after startup.
609
 
      </para>
610
 
    </refsect2>
611
 
    <refsect2 id="clients">
612
 
      <title>CLIENTS</title>
613
 
      <para>
614
 
        The server only gives out its stored data to clients which
615
 
        does have the OpenPGP key of the stored fingerprint.  This is
616
 
        guaranteed by the fact that the client sends its OpenPGP
617
 
        public key in the TLS handshake; this ensures it to be
618
 
        genuine.  The server computes the fingerprint of the key
619
 
        itself and looks up the fingerprint in its list of
620
 
        clients. The <filename>clients.conf</filename> file (see
621
 
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
622
 
        <manvolnum>5</manvolnum></citerefentry>)
623
 
        <emphasis>must</emphasis> be made non-readable by anyone
624
 
        except the user starting the server (usually root).
625
 
      </para>
626
 
      <para>
627
 
        As detailed in <xref linkend="checking"/>, the status of all
628
 
        client computers will continually be checked and be assumed
629
 
        compromised if they are gone for too long.
630
 
      </para>
631
 
      <para>
632
 
        For more details on client-side security, see
633
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
634
 
        <manvolnum>8mandos</manvolnum></citerefentry>.
635
 
      </para>
636
 
    </refsect2>
637
 
  </refsect1>
638
 
  
639
 
  <refsect1 id="see_also">
640
 
    <title>SEE ALSO</title>
641
 
    <para>
642
 
      <citerefentry><refentrytitle>intro</refentrytitle>
643
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
644
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
 
      <manvolnum>5</manvolnum></citerefentry>,
646
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
647
 
      <manvolnum>5</manvolnum></citerefentry>,
648
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
649
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
650
 
      <citerefentry><refentrytitle>sh</refentrytitle>
651
 
      <manvolnum>1</manvolnum></citerefentry>
652
 
    </para>
653
 
    <variablelist>
654
 
      <varlistentry>
655
 
        <term>
656
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
657
 
        </term>
658
 
        <listitem>
659
 
          <para>
660
 
            Zeroconf is the network protocol standard used by clients
661
 
            for finding this Mandos server on the local network.
662
 
          </para>
663
 
        </listitem>
664
 
      </varlistentry>
665
 
      <varlistentry>
666
 
        <term>
667
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
668
 
        </term>
669
 
      <listitem>
670
 
        <para>
671
 
          Avahi is the library this server calls to implement
672
 
          Zeroconf service announcements.
673
 
        </para>
674
 
      </listitem>
675
 
      </varlistentry>
676
 
      <varlistentry>
677
 
        <term>
678
 
          <ulink url="http://www.gnu.org/software/gnutls/"
679
 
          >GnuTLS</ulink>
680
 
        </term>
681
 
      <listitem>
682
 
        <para>
683
 
          GnuTLS is the library this server uses to implement TLS for
684
 
          communicating securely with the client, and at the same time
685
 
          confidently get the client’s public OpenPGP key.
686
 
        </para>
687
 
      </listitem>
688
 
      </varlistentry>
689
 
      <varlistentry>
690
 
        <term>
691
 
          RFC 4291: <citetitle>IP Version 6 Addressing
692
 
          Architecture</citetitle>
693
 
        </term>
694
 
        <listitem>
695
 
          <variablelist>
696
 
            <varlistentry>
697
 
              <term>Section 2.2: <citetitle>Text Representation of
698
 
              Addresses</citetitle></term>
699
 
              <listitem><para/></listitem>
700
 
            </varlistentry>
701
 
            <varlistentry>
702
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
703
 
              Address</citetitle></term>
704
 
              <listitem><para/></listitem>
705
 
            </varlistentry>
706
 
            <varlistentry>
707
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
708
 
            Addresses</citetitle></term>
709
 
            <listitem>
710
 
              <para>
711
 
                The clients use IPv6 link-local addresses, which are
712
 
                immediately usable since a link-local addresses is
713
 
                automatically assigned to a network interfaces when it
714
 
                is brought up.
715
 
              </para>
716
 
            </listitem>
717
 
            </varlistentry>
718
 
          </variablelist>
719
 
        </listitem>
720
 
      </varlistentry>
721
 
      <varlistentry>
722
 
        <term>
723
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
724
 
          Protocol Version 1.1</citetitle>
725
 
        </term>
726
 
      <listitem>
727
 
        <para>
728
 
          TLS 1.1 is the protocol implemented by GnuTLS.
729
 
        </para>
730
 
      </listitem>
731
 
      </varlistentry>
732
 
      <varlistentry>
733
 
        <term>
734
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
735
 
        </term>
736
 
      <listitem>
737
 
        <para>
738
 
          The data sent to clients is binary encrypted OpenPGP data.
739
 
        </para>
740
 
      </listitem>
741
 
      </varlistentry>
742
 
      <varlistentry>
743
 
        <term>
744
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
745
 
          Security</citetitle>
746
 
        </term>
747
 
      <listitem>
748
 
        <para>
749
 
          This is implemented by GnuTLS and used by this server so
750
 
          that OpenPGP keys can be used.
751
 
        </para>
752
 
      </listitem>
753
 
      </varlistentry>
754
 
    </variablelist>
755
 
  </refsect1>
756
 
</refentry>
757
 
<!-- Local Variables: -->
758
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
759
 
<!-- time-stamp-end: "[\"']>" -->
760
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
761
 
<!-- End: -->