/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-02-27">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
10
<refentry>
 
11
  <refentryinfo>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
49
67
  <refnamediv>
50
68
    <refname><command>&COMMANDNAME;</command></refname>
51
69
    <refpurpose>
52
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <command>&COMMANDNAME;</command>
59
 
      <group>
60
 
        <arg choice="plain"><option>--interface
61
 
        <replaceable>NAME</replaceable></option></arg>
62
 
        <arg choice="plain"><option>-i
63
 
        <replaceable>NAME</replaceable></option></arg>
64
 
      </group>
65
 
      <sbr/>
66
 
      <group>
67
 
        <arg choice="plain"><option>--address
68
 
        <replaceable>ADDRESS</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-a
70
 
        <replaceable>ADDRESS</replaceable></option></arg>
71
 
      </group>
72
 
      <sbr/>
73
 
      <group>
74
 
        <arg choice="plain"><option>--port
75
 
        <replaceable>PORT</replaceable></option></arg>
76
 
        <arg choice="plain"><option>-p
77
 
        <replaceable>PORT</replaceable></option></arg>
78
 
      </group>
79
 
      <sbr/>
80
 
      <arg><option>--priority
81
 
      <replaceable>PRIORITY</replaceable></option></arg>
82
 
      <sbr/>
83
 
      <arg><option>--servicename
84
 
      <replaceable>NAME</replaceable></option></arg>
85
 
      <sbr/>
86
 
      <arg><option>--configdir
87
 
      <replaceable>DIRECTORY</replaceable></option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
 
    </cmdsynopsis>
98
 
    <cmdsynopsis>
99
 
      <command>&COMMANDNAME;</command>
100
 
      <group choice="req">
101
 
        <arg choice="plain"><option>--help</option></arg>
102
 
        <arg choice="plain"><option>-h</option></arg>
103
 
      </group>
104
 
    </cmdsynopsis>
105
 
    <cmdsynopsis>
106
 
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain"><option>--version</option></arg>
108
 
    </cmdsynopsis>
109
 
    <cmdsynopsis>
110
 
      <command>&COMMANDNAME;</command>
111
 
      <arg choice="plain"><option>--check</option></arg>
 
77
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
 
78
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
 
79
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
 
80
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
81
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
 
82
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
 
83
      <arg choice='opt'>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
 
88
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
 
89
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
 
90
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
91
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
 
92
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
 
93
      <arg choice='opt'>--debug</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--help</arg>
 
98
    </cmdsynopsis>
 
99
    <cmdsynopsis>
 
100
      <command>&COMMANDNAME;</command>
 
101
      <arg choice='plain'>--version</arg>
 
102
    </cmdsynopsis>
 
103
    <cmdsynopsis>
 
104
      <command>&COMMANDNAME;</command>
 
105
      <arg choice='plain'>--check</arg>
112
106
    </cmdsynopsis>
113
107
  </refsynopsisdiv>
114
 
  
 
108
 
115
109
  <refsect1 id="description">
116
110
    <title>DESCRIPTION</title>
117
111
    <para>
118
112
      <command>&COMMANDNAME;</command> is a server daemon which
119
113
      handles incoming request for passwords for a pre-defined list of
120
114
      client host computers.  The Mandos server uses Zeroconf to
121
 
      announce itself on the local network, and uses TLS to
122
 
      communicate securely with and to authenticate the clients.  The
123
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
124
 
      link-local addresses, since the clients will probably not have
125
 
      any other addresses configured (see <xref linkend="overview"/>).
126
 
      Any authenticated client is then given the stored pre-encrypted
127
 
      password for that specific client.
 
115
      announce itself on the local network, and uses GnuTLS to
 
116
      communicate securely with and to authenticate the clients.
 
117
      Mandos uses IPv6 link-local addresses, since the clients are
 
118
      assumed to not have any other addresses configured.  Any
 
119
      authenticated client is then given the pre-encrypted password
 
120
      for that specific client.
128
121
    </para>
 
122
 
129
123
  </refsect1>
130
124
  
131
125
  <refsect1 id="purpose">
132
126
    <title>PURPOSE</title>
 
127
 
133
128
    <para>
134
129
      The purpose of this is to enable <emphasis>remote and unattended
135
 
      rebooting</emphasis> of client host computer with an
136
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
137
 
      linkend="overview"/> for details.
 
130
      rebooting</emphasis> of any client host computer with an
 
131
      <emphasis>encrypted root file system</emphasis>.  The client
 
132
      host computer should start a Mandos client in the initial RAM
 
133
      disk environment, the Mandos client program communicates with
 
134
      this server program to get an encrypted password, which is then
 
135
      decrypted and used to unlock the encrypted root file system.
 
136
      The client host computer can then continue its boot sequence
 
137
      normally.
138
138
    </para>
 
139
 
139
140
  </refsect1>
140
141
  
141
142
  <refsect1 id="options">
142
143
    <title>OPTIONS</title>
 
144
 
143
145
    <variablelist>
144
146
      <varlistentry>
145
 
        <term><option>--help</option></term>
146
 
        <term><option>-h</option></term>
 
147
        <term><literal>-h</literal>, <literal>--help</literal></term>
147
148
        <listitem>
148
149
          <para>
149
150
            Show a help message and exit
150
151
          </para>
151
152
        </listitem>
152
153
      </varlistentry>
153
 
      
154
 
      <varlistentry>
155
 
        <term><option>--interface</option>
156
 
        <replaceable>NAME</replaceable></term>
157
 
        <term><option>-i</option>
158
 
        <replaceable>NAME</replaceable></term>
159
 
        <listitem>
160
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
161
 
        </listitem>
162
 
      </varlistentry>
163
 
      
164
 
      <varlistentry>
165
 
        <term><option>--address
166
 
        <replaceable>ADDRESS</replaceable></option></term>
167
 
        <term><option>-a
168
 
        <replaceable>ADDRESS</replaceable></option></term>
169
 
        <listitem>
170
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      
174
 
      <varlistentry>
175
 
        <term><option>--port
176
 
        <replaceable>PORT</replaceable></option></term>
177
 
        <term><option>-p
178
 
        <replaceable>PORT</replaceable></option></term>
179
 
        <listitem>
180
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
181
 
        </listitem>
182
 
      </varlistentry>
183
 
      
184
 
      <varlistentry>
185
 
        <term><option>--check</option></term>
186
 
        <listitem>
187
 
          <para>
188
 
            Run the server’s self-tests.  This includes any unit
 
154
 
 
155
      <varlistentry>
 
156
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
157
        IF</replaceable></literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Only announce the server and listen to requests on network
 
161
            interface <replaceable>IF</replaceable>.  Default is to
 
162
            use all available interfaces.
 
163
          </para>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
 
 
167
      <varlistentry>
 
168
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
169
        ADDRESS</replaceable></literal></term>
 
170
        <listitem>
 
171
          <para>
 
172
            If this option is used, the server will only listen to a
 
173
            specific address.  This must currently be an IPv6 address;
 
174
            an IPv4 address can be specified using the
 
175
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
 
176
            Also, if a link-local address is specified, an interface
 
177
            should be set, since a link-local address is only valid on
 
178
            a single interface.  By default, the server will listen to
 
179
            all available addresses.
 
180
          </para>
 
181
        </listitem>
 
182
      </varlistentry>
 
183
 
 
184
      <varlistentry>
 
185
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
186
        PORT</replaceable></literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            If this option is used, the server to bind to that
 
190
            port. By default, the server will listen to an arbitrary
 
191
            port given by the operating system.
 
192
          </para>
 
193
        </listitem>
 
194
      </varlistentry>
 
195
 
 
196
      <varlistentry>
 
197
        <term><literal>--check</literal></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Run the server's self-tests.  This includes any unit
189
201
            tests, etc.
190
202
          </para>
191
203
        </listitem>
192
204
      </varlistentry>
193
 
      
194
 
      <varlistentry>
195
 
        <term><option>--debug</option></term>
196
 
        <listitem>
197
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
198
 
        </listitem>
199
 
      </varlistentry>
200
 
      
201
 
      <varlistentry>
202
 
        <term><option>--debuglevel
203
 
        <replaceable>LEVEL</replaceable></option></term>
204
 
        <listitem>
205
 
          <para>
206
 
            Set the debugging log level.
207
 
            <replaceable>LEVEL</replaceable> is a string, one of
208
 
            <quote><literal>CRITICAL</literal></quote>,
209
 
            <quote><literal>ERROR</literal></quote>,
210
 
            <quote><literal>WARNING</literal></quote>,
211
 
            <quote><literal>INFO</literal></quote>, or
212
 
            <quote><literal>DEBUG</literal></quote>, in order of
213
 
            increasing verbosity.  The default level is
214
 
            <quote><literal>WARNING</literal></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
 
        <term><option>--priority <replaceable>
221
 
        PRIORITY</replaceable></option></term>
222
 
        <listitem>
223
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
224
 
        </listitem>
225
 
      </varlistentry>
226
 
      
227
 
      <varlistentry>
228
 
        <term><option>--servicename
229
 
        <replaceable>NAME</replaceable></option></term>
230
 
        <listitem>
231
 
          <xi:include href="mandos-options.xml"
232
 
                      xpointer="servicename"/>
233
 
        </listitem>
234
 
      </varlistentry>
235
 
      
236
 
      <varlistentry>
237
 
        <term><option>--configdir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>--debug</literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            If the server is run in debug mode, it will run in the
 
211
            foreground and print a lot of debugging information.  The
 
212
            default is <emphasis>not</emphasis> to run in debug mode.
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>--priority <replaceable>
 
219
        PRIORITY</replaceable></literal></term>
 
220
        <listitem>
 
221
          <para>
 
222
            GnuTLS priority string for the TLS handshake with the
 
223
            clients.  See
 
224
            <citerefentry><refentrytitle>gnutls_priority_init
 
225
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
226
            for the syntax.  The default is
 
227
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
228
            <emphasis>Warning</emphasis>: changing this may make the
 
229
            TLS handshake fail, making communication with clients
 
230
            impossible.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
237
        </literal></term>
 
238
        <listitem>
 
239
          <para>
 
240
            Zeroconf service name.  The default is
 
241
            <quote><literal>Mandos</literal></quote>.  You only need
 
242
            to change this if you for some reason want to run more
 
243
            than one server on the same <emphasis>host</emphasis>,
 
244
            which would not normally be useful.  If there are name
 
245
            collisions on the same <emphasis>network</emphasis>, the
 
246
            newer server will automatically rename itself to
 
247
            <quote><literal>Mandos #2</literal></quote>, and so on,
 
248
            therefore this option is not needed in that case.
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
 
 
253
      <varlistentry>
 
254
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
255
        </literal></term>
239
256
        <listitem>
240
257
          <para>
241
258
            Directory to search for configuration files.  Default is
247
264
          </para>
248
265
        </listitem>
249
266
      </varlistentry>
250
 
      
 
267
 
251
268
      <varlistentry>
252
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
253
270
        <listitem>
254
271
          <para>
255
272
            Prints the program version and exit.
256
273
          </para>
257
274
        </listitem>
258
275
      </varlistentry>
259
 
      
260
 
      <varlistentry>
261
 
        <term><option>--no-dbus</option></term>
262
 
        <listitem>
263
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
264
 
          <para>
265
 
            See also <xref linkend="dbus_interface"/>.
266
 
          </para>
267
 
        </listitem>
268
 
      </varlistentry>
269
 
      
270
 
      <varlistentry>
271
 
        <term><option>--no-ipv6</option></term>
272
 
        <listitem>
273
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
 
        </listitem>
275
 
      </varlistentry>
276
276
    </variablelist>
277
277
  </refsect1>
278
 
  
279
 
  <refsect1 id="overview">
280
 
    <title>OVERVIEW</title>
281
 
    <xi:include href="overview.xml"/>
282
 
    <para>
283
 
      This program is the server part.  It is a normal server program
284
 
      and will run in a normal system environment, not in an initial
285
 
      <acronym>RAM</acronym> disk environment.
286
 
    </para>
287
 
  </refsect1>
288
 
  
 
278
 
289
279
  <refsect1 id="protocol">
290
280
    <title>NETWORK PROTOCOL</title>
291
281
    <para>
317
307
        <entry>-><!-- &rarr; --></entry>
318
308
      </row>
319
309
      <row>
320
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
310
        <entry><quote><literal>1\r\en</literal></quote></entry>
321
311
        <entry>-><!-- &rarr; --></entry>
322
312
      </row>
323
313
      <row>
343
333
      </row>
344
334
    </tbody></tgroup></table>
345
335
  </refsect1>
346
 
  
 
336
 
347
337
  <refsect1 id="checking">
348
338
    <title>CHECKING</title>
349
339
    <para>
350
340
      The server will, by default, continually check that the clients
351
341
      are still up.  If a client has not been confirmed as being up
352
342
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  (Manual
354
 
      intervention is required to re-enable a client.)  The timeout,
355
 
      checker program, and interval between checks can be configured
 
343
      longer eligible to receive the encrypted password.  The timeout,
 
344
      checker program and interval between checks can be configured
356
345
      both globally and per client; see <citerefentry>
357
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="approval">
365
 
    <title>APPROVAL</title>
366
 
    <para>
367
 
      The server can be configured to require manual approval for a
368
 
      client before it is sent its secret.  The delay to wait for such
369
 
      approval and the default action (approve or deny) can be
370
 
      configured both globally and per client; see <citerefentry>
371
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
372
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
373
 
      will be approved immediately without delay.
374
 
    </para>
375
 
    <para>
376
 
      This can be used to deny a client its secret if not manually
377
 
      approved within a specified time.  It can also be used to make
378
 
      the server delay before giving a client its secret, allowing
379
 
      optional manual denying of this specific client.
380
 
    </para>
381
 
    
382
 
  </refsect1>
383
 
  
 
346
      <refentrytitle>mandos.conf</refentrytitle>
 
347
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
 
348
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
349
      <manvolnum>5</manvolnum></citerefentry>.
 
350
    </para>
 
351
  </refsect1>
 
352
 
384
353
  <refsect1 id="logging">
385
354
    <title>LOGGING</title>
386
355
    <para>
387
 
      The server will send log message with various severity levels to
388
 
      <filename>/dev/log</filename>.  With the
 
356
      The server will send log messaged with various severity levels
 
357
      to <filename>/dev/log</filename>.  With the
389
358
      <option>--debug</option> option, it will log even more messages,
390
359
      and also show them on the console.
391
360
    </para>
392
361
  </refsect1>
393
 
  
394
 
  <refsect1 id="dbus_interface">
395
 
    <title>D-BUS INTERFACE</title>
396
 
    <para>
397
 
      The server will by default provide a D-Bus system bus interface.
398
 
      This interface will only be accessible by the root user or a
399
 
      Mandos-specific user, if such a user exists.  For documentation
400
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
401
 
    </para>
402
 
  </refsect1>
403
 
  
 
362
 
404
363
  <refsect1 id="exit_status">
405
364
    <title>EXIT STATUS</title>
406
365
    <para>
408
367
      critical error is encountered.
409
368
    </para>
410
369
  </refsect1>
411
 
  
412
 
  <refsect1 id="environment">
413
 
    <title>ENVIRONMENT</title>
414
 
    <variablelist>
415
 
      <varlistentry>
416
 
        <term><envar>PATH</envar></term>
417
 
        <listitem>
418
 
          <para>
419
 
            To start the configured checker (see <xref
420
 
            linkend="checking"/>), the server uses
421
 
            <filename>/bin/sh</filename>, which in turn uses
422
 
            <varname>PATH</varname> to search for matching commands if
423
 
            an absolute path is not given.  See <citerefentry>
424
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
425
 
            </citerefentry>.
426
 
          </para>
427
 
        </listitem>
428
 
      </varlistentry>
429
 
    </variablelist>
430
 
  </refsect1>
431
 
  
432
 
  <refsect1 id="files">
 
370
 
 
371
  <refsect1 id="file">
433
372
    <title>FILES</title>
434
373
    <para>
435
374
      Use the <option>--configdir</option> option to change where
458
397
        </listitem>
459
398
      </varlistentry>
460
399
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
400
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
462
401
        <listitem>
463
402
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
403
            The file containing the process id of
 
404
            <command>&COMMANDNAME;</command>.
466
405
          </para>
467
406
        </listitem>
468
407
      </varlistentry>
475
414
          </para>
476
415
        </listitem>
477
416
      </varlistentry>
478
 
      <varlistentry>
479
 
        <term><filename>/bin/sh</filename></term>
480
 
        <listitem>
481
 
          <para>
482
 
            This is used to start the configured checker command for
483
 
            each client.  See <citerefentry>
484
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
485
 
            <manvolnum>5</manvolnum></citerefentry> for details.
486
 
          </para>
487
 
        </listitem>
488
 
      </varlistentry>
489
417
    </variablelist>
490
418
  </refsect1>
491
 
  
 
419
 
492
420
  <refsect1 id="bugs">
493
421
    <title>BUGS</title>
494
422
    <para>
495
423
      This server might, on especially fatal errors, emit a Python
496
424
      backtrace.  This could be considered a feature.
497
425
    </para>
498
 
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
502
 
    </para>
503
 
    <para>
504
 
      There is no fine-grained control over logging and debug output.
505
 
    </para>
506
 
    <para>
507
 
      Debug mode is conflated with running in the foreground.
508
 
    </para>
509
 
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
 
      This server does not check the expire time of clients’ OpenPGP
514
 
      keys.
515
 
    </para>
516
426
  </refsect1>
517
 
  
518
 
  <refsect1 id="example">
519
 
    <title>EXAMPLE</title>
 
427
 
 
428
  <refsect1 id="examples">
 
429
    <title>EXAMPLES</title>
520
430
    <informalexample>
521
431
      <para>
522
432
        Normal invocation needs no options:
523
433
      </para>
524
434
      <para>
525
 
        <userinput>&COMMANDNAME;</userinput>
 
435
        <userinput>mandos</userinput>
526
436
      </para>
527
437
    </informalexample>
528
438
    <informalexample>
529
439
      <para>
530
 
        Run the server in debug mode, read configuration files from
531
 
        the <filename>~/mandos</filename> directory, and use the
532
 
        Zeroconf service name <quote>Test</quote> to not collide with
533
 
        any other official Mandos server on this host:
 
440
        Run the server in debug mode and read configuration files from
 
441
        the <filename>~/mandos</filename> directory:
534
442
      </para>
535
443
      <para>
536
444
 
537
445
<!-- do not wrap this line -->
538
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
446
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
539
447
 
540
448
      </para>
541
449
    </informalexample>
547
455
      <para>
548
456
 
549
457
<!-- do not wrap this line -->
550
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
551
459
 
552
460
      </para>
553
461
    </informalexample>
554
462
  </refsect1>
555
 
  
 
463
 
556
464
  <refsect1 id="security">
557
465
    <title>SECURITY</title>
558
 
    <refsect2 id="server">
 
466
    <refsect2>
559
467
      <title>SERVER</title>
560
468
      <para>
561
 
        Running this <command>&COMMANDNAME;</command> server program
562
 
        should not in itself present any security risk to the host
563
 
        computer running it.  The program switches to a non-root user
564
 
        soon after startup.
 
469
        Running the server should not in itself present any security
 
470
        risk to the host computer running it.
565
471
      </para>
566
472
    </refsect2>
567
 
    <refsect2 id="clients">
 
473
    <refsect2>
568
474
      <title>CLIENTS</title>
569
475
      <para>
570
476
        The server only gives out its stored data to clients which
575
481
        itself and looks up the fingerprint in its list of
576
482
        clients. The <filename>clients.conf</filename> file (see
577
483
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
578
 
        <manvolnum>5</manvolnum></citerefentry>)
579
 
        <emphasis>must</emphasis> be made non-readable by anyone
580
 
        except the user starting the server (usually root).
581
 
      </para>
582
 
      <para>
583
 
        As detailed in <xref linkend="checking"/>, the status of all
584
 
        client computers will continually be checked and be assumed
585
 
        compromised if they are gone for too long.
586
 
      </para>
587
 
      <para>
588
 
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
 
484
        <manvolnum>5</manvolnum></citerefentry>) must be non-readable
 
485
        by anyone except the user running the server.
601
486
      </para>
602
487
      <para>
603
488
        For more details on client-side security, see
604
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
489
        <citerefentry><refentrytitle>password-request</refentrytitle>
605
490
        <manvolnum>8mandos</manvolnum></citerefentry>.
606
491
      </para>
607
492
    </refsect2>
608
493
  </refsect1>
609
 
  
 
494
 
610
495
  <refsect1 id="see_also">
611
496
    <title>SEE ALSO</title>
612
 
    <para>
613
 
      <citerefentry>
614
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
615
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
 
        <refentrytitle>mandos.conf</refentrytitle>
617
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
619
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
 
      </citerefentry>
622
 
    </para>
623
 
    <variablelist>
624
 
      <varlistentry>
625
 
        <term>
626
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
627
 
        </term>
628
 
        <listitem>
629
 
          <para>
630
 
            Zeroconf is the network protocol standard used by clients
631
 
            for finding this Mandos server on the local network.
632
 
          </para>
633
 
        </listitem>
634
 
      </varlistentry>
635
 
      <varlistentry>
636
 
        <term>
637
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
638
 
        </term>
639
 
      <listitem>
640
 
        <para>
641
 
          Avahi is the library this server calls to implement
642
 
          Zeroconf service announcements.
643
 
        </para>
644
 
      </listitem>
645
 
      </varlistentry>
646
 
      <varlistentry>
647
 
        <term>
648
 
          <ulink url="http://www.gnu.org/software/gnutls/"
649
 
          >GnuTLS</ulink>
650
 
        </term>
651
 
      <listitem>
652
 
        <para>
653
 
          GnuTLS is the library this server uses to implement TLS for
654
 
          communicating securely with the client, and at the same time
655
 
          confidently get the client’s public OpenPGP key.
656
 
        </para>
657
 
      </listitem>
658
 
      </varlistentry>
659
 
      <varlistentry>
660
 
        <term>
661
 
          RFC 4291: <citetitle>IP Version 6 Addressing
662
 
          Architecture</citetitle>
663
 
        </term>
664
 
        <listitem>
665
 
          <variablelist>
666
 
            <varlistentry>
667
 
              <term>Section 2.2: <citetitle>Text Representation of
668
 
              Addresses</citetitle></term>
669
 
              <listitem><para/></listitem>
670
 
            </varlistentry>
671
 
            <varlistentry>
672
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
673
 
              Address</citetitle></term>
674
 
              <listitem><para/></listitem>
675
 
            </varlistentry>
676
 
            <varlistentry>
677
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
678
 
            Addresses</citetitle></term>
679
 
            <listitem>
680
 
              <para>
681
 
                The clients use IPv6 link-local addresses, which are
682
 
                immediately usable since a link-local addresses is
683
 
                automatically assigned to a network interfaces when it
684
 
                is brought up.
685
 
              </para>
686
 
            </listitem>
687
 
            </varlistentry>
688
 
          </variablelist>
689
 
        </listitem>
690
 
      </varlistentry>
691
 
      <varlistentry>
692
 
        <term>
693
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
694
 
          Protocol Version 1.1</citetitle>
695
 
        </term>
696
 
      <listitem>
697
 
        <para>
698
 
          TLS 1.1 is the protocol implemented by GnuTLS.
699
 
        </para>
700
 
      </listitem>
701
 
      </varlistentry>
702
 
      <varlistentry>
703
 
        <term>
704
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
705
 
        </term>
706
 
      <listitem>
707
 
        <para>
708
 
          The data sent to clients is binary encrypted OpenPGP data.
709
 
        </para>
710
 
      </listitem>
711
 
      </varlistentry>
712
 
      <varlistentry>
713
 
        <term>
714
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
715
 
          Security</citetitle>
716
 
        </term>
717
 
      <listitem>
718
 
        <para>
719
 
          This is implemented by GnuTLS and used by this server so
720
 
          that OpenPGP keys can be used.
721
 
        </para>
722
 
      </listitem>
723
 
      </varlistentry>
724
 
    </variablelist>
 
497
    <itemizedlist spacing="compact">
 
498
      <listitem><para>
 
499
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
500
        <manvolnum>8mandos</manvolnum></citerefentry>
 
501
      </para></listitem>
 
502
      
 
503
      <listitem><para>
 
504
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
505
        <manvolnum>8mandos</manvolnum></citerefentry>
 
506
      </para></listitem>
 
507
      
 
508
      <listitem><para>
 
509
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
510
      </para></listitem>
 
511
      
 
512
      <listitem><para>
 
513
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
514
      </para></listitem>
 
515
      
 
516
      <listitem><para>
 
517
        <ulink
 
518
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
519
      </para></listitem>
 
520
      
 
521
      <listitem><para>
 
522
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
523
        Format</citetitle></citation>
 
524
      </para></listitem>
 
525
      
 
526
      <listitem><para>
 
527
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
528
        Transport Layer Security</citetitle></citation>
 
529
      </para></listitem>
 
530
      
 
531
      <listitem><para>
 
532
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
533
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
534
        Unicast Addresses</citation>
 
535
      </para></listitem>
 
536
    </itemizedlist>
725
537
  </refsect1>
726
538
</refentry>
727
 
<!-- Local Variables: -->
728
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
729
 
<!-- time-stamp-end: "[\"']>" -->
730
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
731
 
<!-- End: -->