/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-31 19:48:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080731194805-mseis21dxwrdfqhk
* plugins.d/mandosclient.c (start_mandos_communication): Changed
                                                        "if_index" to
                                                        be of type
                                                        "AvahiIfIndex".
                                                        All callers
                                                        changed.
 (main): Add default values to "interface" and "if_index".  Only
         change if_index from default if "interface" was given.

* server.py (IPv6_TCPServer.server_bind): Bug fix: test if interface
                                          is empty, not if equal to
                                          avahi.IF_UNSPEC.
  (if_nametoindex): Bug fix; typo: assign to _func[0], not func[0].
  (main): Bug fix: Do not set service.interface unless the interface
          setting has been given.

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