/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: 2009-05-17 01:04:29 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090517010429-53p2qav3ch63nvnr
Tags: version-1.0.9-1
* Makefile (version): Changed to "1.0.9".
* NEWS (Version 1.0.9): New entry.
* debian/changelog (1.0.9-1): - '' -

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