/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

Tags: version-1.2-1
* Makefile (version): Changed to "1.2".
* NEWS (Version 1.2): New entry.
* debian/changelog (1.2): - '' -

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