/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

merge

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