/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-11-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
<refentry>
 
10
  <refentryinfo>
 
11
    <title>&COMMANDNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
20
18
        <surname>Påhlsson</surname>
21
19
        <address>
22
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
23
21
        </address>
24
22
      </author>
25
23
      <author>
26
24
        <firstname>Teddy</firstname>
27
25
        <surname>Hogeborn</surname>
28
26
        <address>
29
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
30
28
        </address>
31
29
      </author>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
33
      <holder>Teddy Hogeborn</holder>
39
34
      <holder>Björn Påhlsson</holder>
40
35
    </copyright>
41
 
    <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>
42
59
  </refentryinfo>
43
 
  
 
60
 
44
61
  <refmeta>
45
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
63
    <manvolnum>8</manvolnum>
49
66
  <refnamediv>
50
67
    <refname><command>&COMMANDNAME;</command></refname>
51
68
    <refpurpose>
52
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
53
70
    </refpurpose>
54
71
  </refnamediv>
55
 
  
 
72
 
56
73
  <refsynopsisdiv>
57
74
    <cmdsynopsis>
58
75
      <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
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
 
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>
102
93
    </cmdsynopsis>
103
94
    <cmdsynopsis>
104
95
      <command>&COMMANDNAME;</command>
105
96
      <group choice="req">
106
 
        <arg choice="plain"><option>--help</option></arg>
107
 
        <arg choice="plain"><option>-h</option></arg>
 
97
        <arg choice="plain">-h</arg>
 
98
        <arg choice="plain">--help</arg>
108
99
      </group>
109
100
    </cmdsynopsis>
110
101
    <cmdsynopsis>
111
102
      <command>&COMMANDNAME;</command>
112
 
      <arg choice="plain"><option>--version</option></arg>
 
103
      <arg choice="plain">--version</arg>
113
104
    </cmdsynopsis>
114
105
    <cmdsynopsis>
115
106
      <command>&COMMANDNAME;</command>
116
 
      <arg choice="plain"><option>--check</option></arg>
 
107
      <arg choice="plain">--check</arg>
117
108
    </cmdsynopsis>
118
109
  </refsynopsisdiv>
119
 
  
 
110
 
120
111
  <refsect1 id="description">
121
112
    <title>DESCRIPTION</title>
122
113
    <para>
123
114
      <command>&COMMANDNAME;</command> is a server daemon which
124
115
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
135
124
    </para>
 
125
 
136
126
  </refsect1>
137
127
  
138
128
  <refsect1 id="purpose">
139
129
    <title>PURPOSE</title>
 
130
 
140
131
    <para>
141
132
      The purpose of this is to enable <emphasis>remote and unattended
142
133
      rebooting</emphasis> of client host computer with an
143
134
      <emphasis>encrypted root file system</emphasis>.  See <xref
144
135
      linkend="overview"/> for details.
145
136
    </para>
 
137
 
146
138
  </refsect1>
147
139
  
148
140
  <refsect1 id="options">
149
141
    <title>OPTIONS</title>
 
142
 
150
143
    <variablelist>
151
144
      <varlistentry>
152
 
        <term><option>--help</option></term>
153
 
        <term><option>-h</option></term>
 
145
        <term><literal>-h</literal>, <literal>--help</literal></term>
154
146
        <listitem>
155
147
          <para>
156
148
            Show a help message and exit
157
149
          </para>
158
150
        </listitem>
159
151
      </varlistentry>
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>
 
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>
193
198
        <listitem>
194
199
          <para>
195
200
            Run the server’s self-tests.  This includes any unit
197
202
          </para>
198
203
        </listitem>
199
204
      </varlistentry>
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>
 
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>
246
256
        <listitem>
247
257
          <para>
248
258
            Directory to search for configuration files.  Default is
254
264
          </para>
255
265
        </listitem>
256
266
      </varlistentry>
257
 
      
 
267
 
258
268
      <varlistentry>
259
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
260
270
        <listitem>
261
271
          <para>
262
272
            Prints the program version and exit.
263
273
          </para>
264
274
        </listitem>
265
275
      </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>
298
276
    </variablelist>
299
277
  </refsect1>
300
 
  
 
278
 
301
279
  <refsect1 id="overview">
302
280
    <title>OVERVIEW</title>
303
 
    <xi:include href="overview.xml"/>
 
281
    &OVERVIEW;
304
282
    <para>
305
283
      This program is the server part.  It is a normal server program
306
284
      and will run in a normal system environment, not in an initial
307
 
      <acronym>RAM</acronym> disk environment.
 
285
      RAM disk environment.
308
286
    </para>
309
287
  </refsect1>
310
 
  
 
288
 
311
289
  <refsect1 id="protocol">
312
290
    <title>NETWORK PROTOCOL</title>
313
291
    <para>
339
317
        <entry>-><!-- &rarr; --></entry>
340
318
      </row>
341
319
      <row>
342
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
320
        <entry><quote><literal>1\r\en</literal></quote></entry>
343
321
        <entry>-><!-- &rarr; --></entry>
344
322
      </row>
345
323
      <row>
365
343
      </row>
366
344
    </tbody></tgroup></table>
367
345
  </refsect1>
368
 
  
 
346
 
369
347
  <refsect1 id="checking">
370
348
    <title>CHECKING</title>
371
349
    <para>
372
350
      The server will, by default, continually check that the clients
373
351
      are still up.  If a client has not been confirmed as being up
374
352
      for some time, the client is assumed to be compromised and is no
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>
 
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>
393
358
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
 
359
      <manvolnum>5</manvolnum></citerefentry>.
 
360
    </para>
404
361
  </refsect1>
405
 
  
 
362
 
406
363
  <refsect1 id="logging">
407
364
    <title>LOGGING</title>
408
365
    <para>
409
 
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
366
      The server will send log messaged with various severity levels
 
367
      to <filename>/dev/log</filename>.  With the
411
368
      <option>--debug</option> option, it will log even more messages,
412
369
      and also show them on the console.
413
370
    </para>
414
371
  </refsect1>
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
 
  
 
372
 
426
373
  <refsect1 id="exit_status">
427
374
    <title>EXIT STATUS</title>
428
375
    <para>
430
377
      critical error is encountered.
431
378
    </para>
432
379
  </refsect1>
433
 
  
 
380
 
434
381
  <refsect1 id="environment">
435
382
    <title>ENVIRONMENT</title>
436
383
    <variablelist>
437
384
      <varlistentry>
438
 
        <term><envar>PATH</envar></term>
 
385
        <term><varname>PATH</varname></term>
439
386
        <listitem>
440
387
          <para>
441
388
            To start the configured checker (see <xref
444
391
            <varname>PATH</varname> to search for matching commands if
445
392
            an absolute path is not given.  See <citerefentry>
446
393
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
447
 
            </citerefentry>.
 
394
          </citerefentry>
448
395
          </para>
449
396
        </listitem>
450
397
      </varlistentry>
451
398
    </variablelist>
452
399
  </refsect1>
453
 
  
454
 
  <refsect1 id="files">
 
400
 
 
401
  <refsect1 id="file">
455
402
    <title>FILES</title>
456
403
    <para>
457
404
      Use the <option>--configdir</option> option to change where
480
427
        </listitem>
481
428
      </varlistentry>
482
429
      <varlistentry>
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
493
 
        class="directory">/var/lib/mandos</filename></term>
494
 
        <listitem>
495
 
          <para>
496
 
            Directory where persistent state will be saved.  Change
497
 
            this with the <option>--statedir</option> option.  See
498
 
            also the <option>--no-restore</option> option.
 
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>.
499
435
          </para>
500
436
        </listitem>
501
437
      </varlistentry>
529
465
      backtrace.  This could be considered a feature.
530
466
    </para>
531
467
    <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>
532
479
      There is no fine-grained control over logging and debug output.
533
480
    </para>
534
481
    <para>
535
482
      Debug mode is conflated with running in the foreground.
536
483
    </para>
537
484
    <para>
538
 
      This server does not check the expire time of clients’ OpenPGP
539
 
      keys.
 
485
      The console log messages does not show a timestamp.
540
486
    </para>
541
487
  </refsect1>
542
488
  
547
493
        Normal invocation needs no options:
548
494
      </para>
549
495
      <para>
550
 
        <userinput>&COMMANDNAME;</userinput>
 
496
        <userinput>mandos</userinput>
551
497
      </para>
552
498
    </informalexample>
553
499
    <informalexample>
554
500
      <para>
555
501
        Run the server in debug mode, read configuration files from
556
 
        the <filename class="directory">~/mandos</filename> directory,
557
 
        and use the Zeroconf service name <quote>Test</quote> to not
558
 
        collide with any other official Mandos server on this host:
 
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
505
      </para>
560
506
      <para>
561
507
 
562
508
<!-- do not wrap this line -->
563
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
509
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
564
510
 
565
511
      </para>
566
512
    </informalexample>
572
518
      <para>
573
519
 
574
520
<!-- do not wrap this line -->
575
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
521
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
576
522
 
577
523
      </para>
578
524
    </informalexample>
579
525
  </refsect1>
580
 
  
 
526
 
581
527
  <refsect1 id="security">
582
528
    <title>SECURITY</title>
583
 
    <refsect2 id="server">
 
529
    <refsect2 id="SERVER">
584
530
      <title>SERVER</title>
585
531
      <para>
586
532
        Running this <command>&COMMANDNAME;</command> server program
587
533
        should not in itself present any security risk to the host
588
 
        computer running it.  The program switches to a non-root user
589
 
        soon after startup.
 
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.
590
536
      </para>
591
537
    </refsect2>
592
 
    <refsect2 id="clients">
 
538
    <refsect2 id="CLIENTS">
593
539
      <title>CLIENTS</title>
594
540
      <para>
595
541
        The server only gives out its stored data to clients which
602
548
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
603
549
        <manvolnum>5</manvolnum></citerefentry>)
604
550
        <emphasis>must</emphasis> be made non-readable by anyone
605
 
        except the user starting the server (usually root).
 
551
        except the user running the server.
606
552
      </para>
607
553
      <para>
608
554
        As detailed in <xref linkend="checking"/>, the status of all
610
556
        compromised if they are gone for too long.
611
557
      </para>
612
558
      <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>
613
575
        For more details on client-side security, see
614
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
576
        <citerefentry><refentrytitle>password-request</refentrytitle>
615
577
        <manvolnum>8mandos</manvolnum></citerefentry>.
616
578
      </para>
617
579
    </refsect2>
618
580
  </refsect1>
619
 
  
 
581
 
620
582
  <refsect1 id="see_also">
621
583
    <title>SEE ALSO</title>
622
 
    <para>
623
 
      <citerefentry><refentrytitle>intro</refentrytitle>
624
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
628
 
      <manvolnum>5</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
630
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
631
 
      <citerefentry><refentrytitle>sh</refentrytitle>
632
 
      <manvolnum>1</manvolnum></citerefentry>
633
 
    </para>
634
584
    <variablelist>
635
585
      <varlistentry>
636
586
        <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>
637
603
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
638
604
        </term>
639
605
        <listitem>
656
622
      </varlistentry>
657
623
      <varlistentry>
658
624
        <term>
659
 
          <ulink url="http://www.gnu.org/software/gnutls/"
660
 
          >GnuTLS</ulink>
 
625
          <ulink
 
626
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
661
627
        </term>
662
628
      <listitem>
663
629
        <para>
669
635
      </varlistentry>
670
636
      <varlistentry>
671
637
        <term>
672
 
          RFC 4291: <citetitle>IP Version 6 Addressing
673
 
          Architecture</citetitle>
 
638
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
639
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
640
          Unicast Addresses</citation>
674
641
        </term>
675
642
        <listitem>
676
 
          <variablelist>
677
 
            <varlistentry>
678
 
              <term>Section 2.2: <citetitle>Text Representation of
679
 
              Addresses</citetitle></term>
680
 
              <listitem><para/></listitem>
681
 
            </varlistentry>
682
 
            <varlistentry>
683
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
684
 
              Address</citetitle></term>
685
 
              <listitem><para/></listitem>
686
 
            </varlistentry>
687
 
            <varlistentry>
688
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
689
 
            Addresses</citetitle></term>
690
 
            <listitem>
691
 
              <para>
692
 
                The clients use IPv6 link-local addresses, which are
693
 
                immediately usable since a link-local addresses is
694
 
                automatically assigned to a network interfaces when it
695
 
                is brought up.
696
 
              </para>
697
 
            </listitem>
698
 
            </varlistentry>
699
 
          </variablelist>
 
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>
700
649
        </listitem>
701
650
      </varlistentry>
702
651
      <varlistentry>
703
652
        <term>
704
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
 
          Protocol Version 1.1</citetitle>
 
653
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
654
          (TLS) Protocol Version 1.1</citetitle></citation>
706
655
        </term>
707
656
      <listitem>
708
657
        <para>
712
661
      </varlistentry>
713
662
      <varlistentry>
714
663
        <term>
715
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
664
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
665
          Format</citetitle></citation>
716
666
        </term>
717
667
      <listitem>
718
668
        <para>
722
672
      </varlistentry>
723
673
      <varlistentry>
724
674
        <term>
725
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
726
 
          Security</citetitle>
 
675
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
676
          Transport Layer Security</citetitle></citation>
727
677
        </term>
728
678
      <listitem>
729
679
        <para>
735
685
    </variablelist>
736
686
  </refsect1>
737
687
</refentry>
738
 
<!-- Local Variables: -->
739
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
740
 
<!-- time-stamp-end: "[\"']>" -->
741
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
742
 
<!-- End: -->