/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

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