/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-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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