/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-12 19:22:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080812192234-8bm17713ltih9ud1
* initramfs-tools-hook: New.
* initramfs-tools-hook-conf: New.

Show diffs side-by-side

added added

removed removed

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