/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

  • Committer: Björn Påhlsson
  • Date: 2008-08-08 01:31:58 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: belorn@braxen-20080808013158-weqgqkxni7du1ke5
Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

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