/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: 2010-09-26 17:36:30 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926173630-zk7pe17fp2bv6zr7
* DBUS-API: Document new "LastApprovalRequest" client property.

* mandos (Client.last_approval_request): New attribute.
  (Client.need_approval): New method.
  (ClientDBus.need_approval): - '' -
  (ClientDBus.NeedApproval): Call self.need_approval().
  (ClientDBus.LastApprovalRequest_dbus_property): New D-Bus property.

* mandos-monitor: Show timeout counter during approval delay.
  (MandosClientWidget._update_timer_callback_lock): New.
  (MandosClientWidget.property_changed): Override to also call
                                         using_timer if
                                         ApprovalPending property is
                                         changed.
  (MandosClientWidget.using_timer): New method.
  (MandosClientWidget.checker_completed): Use "using_timer".
  (MandosClientWidget.need_approval): - '' -
  (MandosClientWidget.update): Show approval delay timer.

Show diffs side-by-side

added added

removed removed

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