/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: Teddy Hogeborn
  • Date: 2008-09-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

Show diffs side-by-side

added added

removed removed

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