/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-10-04 20:19:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081004201958-a7iql0rss7yf6leu
* Makefile (FORTIFY): Added "-fPIE -pie".
  (LINK_FORTIFY): New; set to "-z relro -pie".
  (LDFLAGS): Use $(LINK_FORTIFY).

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