/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

updated some partial manual pages

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
7
8
]>
8
9
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
10
11
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
14
15
    <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</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
35
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
38
59
  </refentryinfo>
39
 
  
 
60
 
40
61
  <refmeta>
41
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
63
    <manvolnum>8</manvolnum>
45
66
  <refnamediv>
46
67
    <refname><command>&COMMANDNAME;</command></refname>
47
68
    <refpurpose>
48
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated mandos clients
49
70
    </refpurpose>
50
71
  </refnamediv>
51
 
  
 
72
 
52
73
  <refsynopsisdiv>
53
74
    <cmdsynopsis>
54
75
      <command>&COMMANDNAME;</command>
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>
 
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>    
102
96
  </refsynopsisdiv>
103
 
  
 
97
 
104
98
  <refsect1 id="description">
105
99
    <title>DESCRIPTION</title>
106
100
    <para>
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>
 
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
  </refsect1>  
129
108
  
130
109
  <refsect1 id="options">
131
110
    <title>OPTIONS</title>
 
111
 
132
112
    <variablelist>
133
113
      <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>
 
114
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
115
        <listitem>
 
116
          <para>
 
117
            show a help message and exit
 
118
          </para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
 
 
122
      <varlistentry>
 
123
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
124
        IF</replaceable></literal></term>
 
125
        <listitem>
 
126
          <para>
 
127
            Bind to interface IF
 
128
          </para>
 
129
        </listitem>
 
130
      </varlistentry>      
 
131
 
 
132
      <varlistentry>
 
133
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
134
        ADDRESS</replaceable></literal></term>
 
135
        <listitem>
 
136
          <para>
 
137
            Address to listen for requests on
 
138
          </para>
 
139
        </listitem>
 
140
      </varlistentry>          
 
141
 
 
142
      <varlistentry>
 
143
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
144
        PORT</replaceable></literal></term>
 
145
        <listitem>
 
146
          <para>
 
147
            Port number to receive requests on
 
148
          </para>
 
149
        </listitem>
 
150
      </varlistentry>          
 
151
 
 
152
      <varlistentry>
 
153
        <term><literal>--check</literal></term>
 
154
        <listitem>
 
155
          <para>
 
156
            Run self-test on the server
 
157
          </para>
 
158
        </listitem>
 
159
      </varlistentry>      
 
160
 
 
161
      <varlistentry>
 
162
        <term><literal>--debug</literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Debug mode
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>
 
169
 
 
170
      <varlistentry>
 
171
        <term><literal>--priority <replaceable>
 
172
        PRIORITY</replaceable></literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GnuTLS priority string. See <citerefentry>
 
176
            <refentrytitle>gnutls_priority_init</refentrytitle>
 
177
            <manvolnum>3</manvolnum></citerefentry>
 
178
          </para>
 
179
        </listitem>
 
180
      </varlistentry>      
 
181
 
 
182
      <varlistentry>
 
183
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
184
        </literal></term>
 
185
        <listitem>
 
186
          <para>
 
187
            Zeroconf service name
 
188
          </para>
 
189
        </listitem>
 
190
      </varlistentry>     
 
191
 
 
192
      <varlistentry>
 
193
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
194
        </literal></term>
 
195
        <listitem>
 
196
          <para>
 
197
            Directory to search for configuration files
 
198
          </para>
 
199
        </listitem>
 
200
      </varlistentry>
 
201
 
 
202
      <varlistentry>
 
203
        <term><literal>--version</literal></term>
 
204
        <listitem>
 
205
          <para>
 
206
            Prints the program version
 
207
          </para>
 
208
        </listitem>
 
209
      </varlistentry>      
230
210
    </variablelist>
231
211
  </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
 
  
 
212
 
325
213
  <refsect1 id="exit_status">
326
214
    <title>EXIT STATUS</title>
327
215
    <para>
328
 
      The server will exit with a non-zero exit status only when a
329
 
      critical error is encountered.
330
216
    </para>
331
217
  </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
 
  
 
218
 
353
219
  <refsect1 id="file">
354
220
    <title>FILES</title>
355
221
    <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.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>
 
222
    </para>
 
223
  </refsect1>  
 
224
 
 
225
  <refsect1 id="notes">
 
226
    <title>NOTES</title>
 
227
    <para>
 
228
    </para>
411
229
  </refsect1>
412
230
  
413
231
  <refsect1 id="bugs">
414
232
    <title>BUGS</title>
415
233
    <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 time stamp.
438
 
    </para>
439
 
    <para>
440
 
      This server does not check the expire time of clients’ OpenPGP
441
 
      keys.
442
 
    </para>
443
 
  </refsect1>
444
 
  
445
 
  <refsect1 id="example">
446
 
    <title>EXAMPLE</title>
447
 
    <informalexample>
448
 
      <para>
449
 
        Normal invocation needs no options:
450
 
      </para>
451
 
      <para>
452
 
        <userinput>&COMMANDNAME;</userinput>
453
 
      </para>
454
 
    </informalexample>
455
 
    <informalexample>
456
 
      <para>
457
 
        Run the server in debug mode, read configuration files from
458
 
        the <filename>~/mandos</filename> directory, and use the
459
 
        Zeroconf service name <quote>Test</quote> to not collide with
460
 
        any other official Mandos server on this host:
461
 
      </para>
462
 
      <para>
463
 
 
464
 
<!-- do not wrap this line -->
465
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
466
 
 
467
 
      </para>
468
 
    </informalexample>
469
 
    <informalexample>
470
 
      <para>
471
 
        Run the server normally, but only listen to one interface and
472
 
        only on the link-local address on that interface:
473
 
      </para>
474
 
      <para>
475
 
 
476
 
<!-- do not wrap this line -->
477
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
 
 
479
 
      </para>
480
 
    </informalexample>
481
 
  </refsect1>
482
 
  
 
234
    </para>
 
235
  </refsect1>  
 
236
 
 
237
  <refsect1 id="examples">
 
238
    <title>EXAMPLES</title>
 
239
    <para>
 
240
    </para>
 
241
  </refsect1>
 
242
 
483
243
  <refsect1 id="security">
484
244
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
486
 
      <title>SERVER</title>
487
 
      <para>
488
 
        Running this <command>&COMMANDNAME;</command> server program
489
 
        should not in itself present any security risk to the host
490
 
        computer running it.  The program switches to a non-root user
491
 
        soon after startup.
492
 
      </para>
493
 
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
495
 
      <title>CLIENTS</title>
496
 
      <para>
497
 
        The server only gives out its stored data to clients which
498
 
        does have the OpenPGP key of the stored fingerprint.  This is
499
 
        guaranteed by the fact that the client sends its OpenPGP
500
 
        public key in the TLS handshake; this ensures it to be
501
 
        genuine.  The server computes the fingerprint of the key
502
 
        itself and looks up the fingerprint in its list of
503
 
        clients. The <filename>clients.conf</filename> file (see
504
 
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
 
        <manvolnum>5</manvolnum></citerefentry>)
506
 
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
508
 
      </para>
509
 
      <para>
510
 
        As detailed in <xref linkend="checking"/>, the status of all
511
 
        client computers will continually be checked and be assumed
512
 
        compromised if they are gone for too long.
513
 
      </para>
514
 
      <para>
515
 
        If a client is compromised, its downtime should be duly noted
516
 
        by the server which would therefore declare the client
517
 
        invalid.  But if the server was ever restarted, it would
518
 
        re-read its client list from its configuration file and again
519
 
        regard all clients therein as valid, and hence eligible to
520
 
        receive their passwords.  Therefore, be careful when
521
 
        restarting servers if it is suspected that a client has, in
522
 
        fact, been compromised by parties who may now be running a
523
 
        fake Mandos client with the keys from the non-encrypted
524
 
        initial <acronym>RAM</acronym> image of the client host.  What
525
 
        should be done in that case (if restarting the server program
526
 
        really is necessary) is to stop the server program, edit the
527
 
        configuration file to omit any suspect clients, and restart
528
 
        the server program.
529
 
      </para>
530
 
      <para>
531
 
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
 
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
 
      </para>
535
 
    </refsect2>
 
245
    <para>
 
246
    </para>
536
247
  </refsect1>
537
 
  
 
248
 
538
249
  <refsect1 id="see_also">
539
250
    <title>SEE ALSO</title>
540
251
    <para>
541
 
      <citerefentry>
542
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
543
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>mandos.conf</refentrytitle>
545
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>mandos-client</refentrytitle>
547
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
 
      </citerefentry>
 
252
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
253
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
254
      <refentrytitle>password-request</refentrytitle>
 
255
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
 
256
      <refentrytitle>password-prompt</refentrytitle>
 
257
      <manvolnum>8mandos</manvolnum></citerefentry>
550
258
    </para>
551
 
    <variablelist>
552
 
      <varlistentry>
553
 
        <term>
554
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
555
 
        </term>
556
 
        <listitem>
557
 
          <para>
558
 
            Zeroconf is the network protocol standard used by clients
559
 
            for finding this Mandos server on the local network.
560
 
          </para>
561
 
        </listitem>
562
 
      </varlistentry>
563
 
      <varlistentry>
564
 
        <term>
565
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
566
 
        </term>
567
 
      <listitem>
568
 
        <para>
569
 
          Avahi is the library this server calls to implement
570
 
          Zeroconf service announcements.
571
 
        </para>
572
 
      </listitem>
573
 
      </varlistentry>
574
 
      <varlistentry>
575
 
        <term>
576
 
          <ulink url="http://www.gnu.org/software/gnutls/"
577
 
          >GnuTLS</ulink>
578
 
        </term>
579
 
      <listitem>
580
 
        <para>
581
 
          GnuTLS is the library this server uses to implement TLS for
582
 
          communicating securely with the client, and at the same time
583
 
          confidently get the client’s public OpenPGP key.
584
 
        </para>
585
 
      </listitem>
586
 
      </varlistentry>
587
 
      <varlistentry>
588
 
        <term>
589
 
          RFC 4291: <citetitle>IP Version 6 Addressing
590
 
          Architecture</citetitle>
591
 
        </term>
592
 
        <listitem>
593
 
          <variablelist>
594
 
            <varlistentry>
595
 
              <term>Section 2.2: <citetitle>Text Representation of
596
 
              Addresses</citetitle></term>
597
 
              <listitem><para/></listitem>
598
 
            </varlistentry>
599
 
            <varlistentry>
600
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
601
 
              Address</citetitle></term>
602
 
              <listitem><para/></listitem>
603
 
            </varlistentry>
604
 
            <varlistentry>
605
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
606
 
            Addresses</citetitle></term>
607
 
            <listitem>
608
 
              <para>
609
 
                The clients use IPv6 link-local addresses, which are
610
 
                immediately usable since a link-local addresses is
611
 
                automatically assigned to a network interfaces when it
612
 
                is brought up.
613
 
              </para>
614
 
            </listitem>
615
 
            </varlistentry>
616
 
          </variablelist>
617
 
        </listitem>
618
 
      </varlistentry>
619
 
      <varlistentry>
620
 
        <term>
621
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
 
          Protocol Version 1.1</citetitle>
623
 
        </term>
624
 
      <listitem>
625
 
        <para>
626
 
          TLS 1.1 is the protocol implemented by GnuTLS.
627
 
        </para>
628
 
      </listitem>
629
 
      </varlistentry>
630
 
      <varlistentry>
631
 
        <term>
632
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
633
 
        </term>
634
 
      <listitem>
635
 
        <para>
636
 
          The data sent to clients is binary encrypted OpenPGP data.
637
 
        </para>
638
 
      </listitem>
639
 
      </varlistentry>
640
 
      <varlistentry>
641
 
        <term>
642
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
 
          Security</citetitle>
644
 
        </term>
645
 
      <listitem>
646
 
        <para>
647
 
          This is implemented by GnuTLS and used by this server so
648
 
          that OpenPGP keys can be used.
649
 
        </para>
650
 
      </listitem>
651
 
      </varlistentry>
652
 
    </variablelist>
653
259
  </refsect1>
 
260
  
654
261
</refentry>
655
 
<!-- Local Variables: -->
656
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
657
 
<!-- time-stamp-end: "[\"']>" -->
658
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
659
 
<!-- End: -->