/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: teddy at bsnet
  • Date: 2011-12-25 00:43:51 UTC
  • Revision ID: teddy@fukt.bsnet.se-20111225004351-3hw3msbs8ooesltd
Removed implemented TODO entry

Show diffs side-by-side

added added

removed removed

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