/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: Björn Påhlsson
  • Date: 2011-11-24 19:27:53 UTC
  • mto: (518.2.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: belorn@fukt.bsnet.se-20111124192753-y5jxlc1h3tcxpubc
First run of python-lint. Fixed some *obviously* bad code and turned
them into good code.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
 
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>
93
99
    </cmdsynopsis>
94
100
    <cmdsynopsis>
95
101
      <command>&COMMANDNAME;</command>
96
102
      <group choice="req">
97
 
        <arg choice="plain">-h</arg>
98
 
        <arg choice="plain">--help</arg>
 
103
        <arg choice="plain"><option>--help</option></arg>
 
104
        <arg choice="plain"><option>-h</option></arg>
99
105
      </group>
100
106
    </cmdsynopsis>
101
107
    <cmdsynopsis>
102
108
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain">--version</arg>
 
109
      <arg choice="plain"><option>--version</option></arg>
104
110
    </cmdsynopsis>
105
111
    <cmdsynopsis>
106
112
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain">--check</arg>
 
113
      <arg choice="plain"><option>--check</option></arg>
108
114
    </cmdsynopsis>
109
115
  </refsynopsisdiv>
110
 
 
 
116
  
111
117
  <refsect1 id="description">
112
118
    <title>DESCRIPTION</title>
113
119
    <para>
114
120
      <command>&COMMANDNAME;</command> is a server daemon which
115
121
      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.
 
122
      client host computers. For an introduction, see
 
123
      <citerefentry><refentrytitle>intro</refentrytitle>
 
124
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
125
      uses Zeroconf to announce itself on the local network, and uses
 
126
      TLS to communicate securely with and to authenticate the
 
127
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
128
      use IPv6 link-local addresses, since the clients will probably
 
129
      not have any other addresses configured (see <xref
 
130
      linkend="overview"/>).  Any authenticated client is then given
 
131
      the stored pre-encrypted password for that specific client.
124
132
    </para>
125
 
 
126
133
  </refsect1>
127
134
  
128
135
  <refsect1 id="purpose">
129
136
    <title>PURPOSE</title>
130
 
 
131
137
    <para>
132
138
      The purpose of this is to enable <emphasis>remote and unattended
133
139
      rebooting</emphasis> of client host computer with an
134
140
      <emphasis>encrypted root file system</emphasis>.  See <xref
135
141
      linkend="overview"/> for details.
136
142
    </para>
137
 
 
138
143
  </refsect1>
139
144
  
140
145
  <refsect1 id="options">
141
146
    <title>OPTIONS</title>
142
 
 
143
147
    <variablelist>
144
148
      <varlistentry>
145
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
149
        <term><option>--help</option></term>
 
150
        <term><option>-h</option></term>
146
151
        <listitem>
147
152
          <para>
148
153
            Show a help message and exit
149
154
          </para>
150
155
        </listitem>
151
156
      </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>
 
157
      
 
158
      <varlistentry>
 
159
        <term><option>--interface</option>
 
160
        <replaceable>NAME</replaceable></term>
 
161
        <term><option>-i</option>
 
162
        <replaceable>NAME</replaceable></term>
 
163
        <listitem>
 
164
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
165
        </listitem>
 
166
      </varlistentry>
 
167
      
 
168
      <varlistentry>
 
169
        <term><option>--address
 
170
        <replaceable>ADDRESS</replaceable></option></term>
 
171
        <term><option>-a
 
172
        <replaceable>ADDRESS</replaceable></option></term>
 
173
        <listitem>
 
174
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
175
        </listitem>
 
176
      </varlistentry>
 
177
      
 
178
      <varlistentry>
 
179
        <term><option>--port
 
180
        <replaceable>PORT</replaceable></option></term>
 
181
        <term><option>-p
 
182
        <replaceable>PORT</replaceable></option></term>
 
183
        <listitem>
 
184
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
185
        </listitem>
 
186
      </varlistentry>
 
187
      
 
188
      <varlistentry>
 
189
        <term><option>--check</option></term>
198
190
        <listitem>
199
191
          <para>
200
192
            Run the server’s self-tests.  This includes any unit
202
194
          </para>
203
195
        </listitem>
204
196
      </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>
 
197
      
 
198
      <varlistentry>
 
199
        <term><option>--debug</option></term>
 
200
        <listitem>
 
201
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--debuglevel
 
207
        <replaceable>LEVEL</replaceable></option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Set the debugging log level.
 
211
            <replaceable>LEVEL</replaceable> is a string, one of
 
212
            <quote><literal>CRITICAL</literal></quote>,
 
213
            <quote><literal>ERROR</literal></quote>,
 
214
            <quote><literal>WARNING</literal></quote>,
 
215
            <quote><literal>INFO</literal></quote>, or
 
216
            <quote><literal>DEBUG</literal></quote>, in order of
 
217
            increasing verbosity.  The default level is
 
218
            <quote><literal>WARNING</literal></quote>.
 
219
          </para>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
 
223
      <varlistentry>
 
224
        <term><option>--priority <replaceable>
 
225
        PRIORITY</replaceable></option></term>
 
226
        <listitem>
 
227
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
228
        </listitem>
 
229
      </varlistentry>
 
230
      
 
231
      <varlistentry>
 
232
        <term><option>--servicename
 
233
        <replaceable>NAME</replaceable></option></term>
 
234
        <listitem>
 
235
          <xi:include href="mandos-options.xml"
 
236
                      xpointer="servicename"/>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><option>--configdir
 
242
        <replaceable>DIRECTORY</replaceable></option></term>
256
243
        <listitem>
257
244
          <para>
258
245
            Directory to search for configuration files.  Default is
264
251
          </para>
265
252
        </listitem>
266
253
      </varlistentry>
267
 
 
 
254
      
268
255
      <varlistentry>
269
 
        <term><literal>--version</literal></term>
 
256
        <term><option>--version</option></term>
270
257
        <listitem>
271
258
          <para>
272
259
            Prints the program version and exit.
273
260
          </para>
274
261
        </listitem>
275
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>--no-dbus</option></term>
 
266
        <listitem>
 
267
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
268
          <para>
 
269
            See also <xref linkend="dbus_interface"/>.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-ipv6</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-restore</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
285
        </listitem>
 
286
      </varlistentry>
276
287
    </variablelist>
277
288
  </refsect1>
278
 
 
 
289
  
279
290
  <refsect1 id="overview">
280
291
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
292
    <xi:include href="overview.xml"/>
282
293
    <para>
283
294
      This program is the server part.  It is a normal server program
284
295
      and will run in a normal system environment, not in an initial
285
 
      RAM disk environment.
 
296
      <acronym>RAM</acronym> disk environment.
286
297
    </para>
287
298
  </refsect1>
288
 
 
 
299
  
289
300
  <refsect1 id="protocol">
290
301
    <title>NETWORK PROTOCOL</title>
291
302
    <para>
317
328
        <entry>-><!-- &rarr; --></entry>
318
329
      </row>
319
330
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
331
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
332
        <entry>-><!-- &rarr; --></entry>
322
333
      </row>
323
334
      <row>
343
354
      </row>
344
355
    </tbody></tgroup></table>
345
356
  </refsect1>
346
 
 
 
357
  
347
358
  <refsect1 id="checking">
348
359
    <title>CHECKING</title>
349
360
    <para>
350
361
      The server will, by default, continually check that the clients
351
362
      are still up.  If a client has not been confirmed as being up
352
363
      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>
 
364
      longer eligible to receive the encrypted password.  (Manual
 
365
      intervention is required to re-enable a client.)  The timeout,
 
366
      extended timeout, checker program, and interval between checks
 
367
      can be configured both globally and per client; see
 
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
 
372
    </para>
 
373
  </refsect1>
 
374
  
 
375
  <refsect1 id="approval">
 
376
    <title>APPROVAL</title>
 
377
    <para>
 
378
      The server can be configured to require manual approval for a
 
379
      client before it is sent its secret.  The delay to wait for such
 
380
      approval and the default action (approve or deny) can be
 
381
      configured both globally and per client; see <citerefentry>
358
382
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
 
      <manvolnum>5</manvolnum></citerefentry>.
360
 
    </para>
 
383
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
384
      will be approved immediately without delay.
 
385
    </para>
 
386
    <para>
 
387
      This can be used to deny a client its secret if not manually
 
388
      approved within a specified time.  It can also be used to make
 
389
      the server delay before giving a client its secret, allowing
 
390
      optional manual denying of this specific client.
 
391
    </para>
 
392
    
361
393
  </refsect1>
362
 
 
 
394
  
363
395
  <refsect1 id="logging">
364
396
    <title>LOGGING</title>
365
397
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
398
      The server will send log message with various severity levels to
 
399
      <filename>/dev/log</filename>.  With the
368
400
      <option>--debug</option> option, it will log even more messages,
369
401
      and also show them on the console.
370
402
    </para>
371
403
  </refsect1>
372
 
 
 
404
  
 
405
  <refsect1 id="dbus_interface">
 
406
    <title>D-BUS INTERFACE</title>
 
407
    <para>
 
408
      The server will by default provide a D-Bus system bus interface.
 
409
      This interface will only be accessible by the root user or a
 
410
      Mandos-specific user, if such a user exists.  For documentation
 
411
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
412
    </para>
 
413
  </refsect1>
 
414
  
373
415
  <refsect1 id="exit_status">
374
416
    <title>EXIT STATUS</title>
375
417
    <para>
377
419
      critical error is encountered.
378
420
    </para>
379
421
  </refsect1>
380
 
 
 
422
  
381
423
  <refsect1 id="environment">
382
424
    <title>ENVIRONMENT</title>
383
425
    <variablelist>
384
426
      <varlistentry>
385
 
        <term><varname>PATH</varname></term>
 
427
        <term><envar>PATH</envar></term>
386
428
        <listitem>
387
429
          <para>
388
430
            To start the configured checker (see <xref
391
433
            <varname>PATH</varname> to search for matching commands if
392
434
            an absolute path is not given.  See <citerefentry>
393
435
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
436
            </citerefentry>.
395
437
          </para>
396
438
        </listitem>
397
439
      </varlistentry>
398
440
    </variablelist>
399
441
  </refsect1>
400
 
 
401
 
  <refsect1 id="file">
 
442
  
 
443
  <refsect1 id="files">
402
444
    <title>FILES</title>
403
445
    <para>
404
446
      Use the <option>--configdir</option> option to change where
427
469
        </listitem>
428
470
      </varlistentry>
429
471
      <varlistentry>
430
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
431
473
        <listitem>
432
474
          <para>
433
 
            The file containing the process id of
434
 
            <command>&COMMANDNAME;</command>.
 
475
            The file containing the process id of the
 
476
            <command>&COMMANDNAME;</command> process started last.
435
477
          </para>
436
478
        </listitem>
437
479
      </varlistentry>
465
507
      backtrace.  This could be considered a feature.
466
508
    </para>
467
509
    <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.
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
477
513
    </para>
478
514
    <para>
479
515
      There is no fine-grained control over logging and debug output.
482
518
      Debug mode is conflated with running in the foreground.
483
519
    </para>
484
520
    <para>
485
 
      The console log messages does not show a timestamp.
 
521
      This server does not check the expire time of clients’ OpenPGP
 
522
      keys.
486
523
    </para>
487
524
  </refsect1>
488
525
  
493
530
        Normal invocation needs no options:
494
531
      </para>
495
532
      <para>
496
 
        <userinput>mandos</userinput>
 
533
        <userinput>&COMMANDNAME;</userinput>
497
534
      </para>
498
535
    </informalexample>
499
536
    <informalexample>
506
543
      <para>
507
544
 
508
545
<!-- do not wrap this line -->
509
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
546
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
510
547
 
511
548
      </para>
512
549
    </informalexample>
518
555
      <para>
519
556
 
520
557
<!-- do not wrap this line -->
521
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
558
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
522
559
 
523
560
      </para>
524
561
    </informalexample>
525
562
  </refsect1>
526
 
 
 
563
  
527
564
  <refsect1 id="security">
528
565
    <title>SECURITY</title>
529
 
    <refsect2 id="SERVER">
 
566
    <refsect2 id="server">
530
567
      <title>SERVER</title>
531
568
      <para>
532
569
        Running this <command>&COMMANDNAME;</command> server program
533
570
        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.
 
571
        computer running it.  The program switches to a non-root user
 
572
        soon after startup.
536
573
      </para>
537
574
    </refsect2>
538
 
    <refsect2 id="CLIENTS">
 
575
    <refsect2 id="clients">
539
576
      <title>CLIENTS</title>
540
577
      <para>
541
578
        The server only gives out its stored data to clients which
548
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
549
586
        <manvolnum>5</manvolnum></citerefentry>)
550
587
        <emphasis>must</emphasis> be made non-readable by anyone
551
 
        except the user running the server.
 
588
        except the user starting the server (usually root).
552
589
      </para>
553
590
      <para>
554
591
        As detailed in <xref linkend="checking"/>, the status of all
557
594
      </para>
558
595
      <para>
559
596
        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.
 
597
        by the server which would therefore disable the client.  But
 
598
        if the server was ever restarted, it would re-read its client
 
599
        list from its configuration file and again regard all clients
 
600
        therein as enabled, and hence eligible to receive their
 
601
        passwords.  Therefore, be careful when restarting servers if
 
602
        it is suspected that a client has, in fact, been compromised
 
603
        by parties who may now be running a fake Mandos client with
 
604
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
605
        image of the client host.  What should be done in that case
 
606
        (if restarting the server program really is necessary) is to
 
607
        stop the server program, edit the configuration file to omit
 
608
        any suspect clients, and restart the server program.
573
609
      </para>
574
610
      <para>
575
611
        For more details on client-side security, see
576
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
577
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
578
614
      </para>
579
615
    </refsect2>
580
616
  </refsect1>
581
 
 
 
617
  
582
618
  <refsect1 id="see_also">
583
619
    <title>SEE ALSO</title>
 
620
    <para>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
624
      <manvolnum>5</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>sh</refentrytitle>
 
630
      <manvolnum>1</manvolnum></citerefentry>
 
631
    </para>
584
632
    <variablelist>
585
633
      <varlistentry>
586
634
        <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
635
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
636
        </term>
605
637
        <listitem>
622
654
      </varlistentry>
623
655
      <varlistentry>
624
656
        <term>
625
 
          <ulink
626
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
657
          <ulink url="http://www.gnu.org/software/gnutls/"
 
658
          >GnuTLS</ulink>
627
659
        </term>
628
660
      <listitem>
629
661
        <para>
635
667
      </varlistentry>
636
668
      <varlistentry>
637
669
        <term>
638
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
 
          Unicast Addresses</citation>
 
670
          RFC 4291: <citetitle>IP Version 6 Addressing
 
671
          Architecture</citetitle>
641
672
        </term>
642
673
        <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>
 
674
          <variablelist>
 
675
            <varlistentry>
 
676
              <term>Section 2.2: <citetitle>Text Representation of
 
677
              Addresses</citetitle></term>
 
678
              <listitem><para/></listitem>
 
679
            </varlistentry>
 
680
            <varlistentry>
 
681
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
682
              Address</citetitle></term>
 
683
              <listitem><para/></listitem>
 
684
            </varlistentry>
 
685
            <varlistentry>
 
686
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
687
            Addresses</citetitle></term>
 
688
            <listitem>
 
689
              <para>
 
690
                The clients use IPv6 link-local addresses, which are
 
691
                immediately usable since a link-local addresses is
 
692
                automatically assigned to a network interfaces when it
 
693
                is brought up.
 
694
              </para>
 
695
            </listitem>
 
696
            </varlistentry>
 
697
          </variablelist>
649
698
        </listitem>
650
699
      </varlistentry>
651
700
      <varlistentry>
652
701
        <term>
653
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
654
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
702
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
703
          Protocol Version 1.1</citetitle>
655
704
        </term>
656
705
      <listitem>
657
706
        <para>
661
710
      </varlistentry>
662
711
      <varlistentry>
663
712
        <term>
664
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
665
 
          Format</citetitle></citation>
 
713
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
666
714
        </term>
667
715
      <listitem>
668
716
        <para>
672
720
      </varlistentry>
673
721
      <varlistentry>
674
722
        <term>
675
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
676
 
          Transport Layer Security</citetitle></citation>
 
723
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
724
          Security</citetitle>
677
725
        </term>
678
726
      <listitem>
679
727
        <para>
685
733
    </variablelist>
686
734
  </refsect1>
687
735
</refentry>
 
736
<!-- Local Variables: -->
 
737
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
738
<!-- time-stamp-end: "[\"']>" -->
 
739
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
740
<!-- End: -->