/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos.xml

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
9
<refentry>
 
10
  <refentryinfo>
 
11
    <title>&COMMANDNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
33
      <holder>Teddy Hogeborn</holder>
38
34
      <holder>Björn Påhlsson</holder>
39
35
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
41
59
  </refentryinfo>
42
 
  
 
60
 
43
61
  <refmeta>
44
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
63
    <manvolnum>8</manvolnum>
48
66
  <refnamediv>
49
67
    <refname><command>&COMMANDNAME;</command></refname>
50
68
    <refpurpose>
51
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
74
    <cmdsynopsis>
57
75
      <command>&COMMANDNAME;</command>
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>
 
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>
96
93
    </cmdsynopsis>
97
94
    <cmdsynopsis>
98
95
      <command>&COMMANDNAME;</command>
99
96
      <group choice="req">
100
 
        <arg choice="plain"><option>--help</option></arg>
101
 
        <arg choice="plain"><option>-h</option></arg>
 
97
        <arg choice="plain">-h</arg>
 
98
        <arg choice="plain">--help</arg>
102
99
      </group>
103
100
    </cmdsynopsis>
104
101
    <cmdsynopsis>
105
102
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--version</option></arg>
 
103
      <arg choice="plain">--version</arg>
107
104
    </cmdsynopsis>
108
105
    <cmdsynopsis>
109
106
      <command>&COMMANDNAME;</command>
110
 
      <arg choice="plain"><option>--check</option></arg>
 
107
      <arg choice="plain">--check</arg>
111
108
    </cmdsynopsis>
112
109
  </refsynopsisdiv>
113
 
  
 
110
 
114
111
  <refsect1 id="description">
115
112
    <title>DESCRIPTION</title>
116
113
    <para>
125
122
      Any authenticated client is then given the stored pre-encrypted
126
123
      password for that specific client.
127
124
    </para>
 
125
 
128
126
  </refsect1>
129
127
  
130
128
  <refsect1 id="purpose">
131
129
    <title>PURPOSE</title>
 
130
 
132
131
    <para>
133
132
      The purpose of this is to enable <emphasis>remote and unattended
134
133
      rebooting</emphasis> of client host computer with an
135
134
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
135
      linkend="overview"/> for details.
137
136
    </para>
 
137
 
138
138
  </refsect1>
139
139
  
140
140
  <refsect1 id="options">
141
141
    <title>OPTIONS</title>
 
142
 
142
143
    <variablelist>
143
144
      <varlistentry>
144
 
        <term><option>--help</option></term>
145
 
        <term><option>-h</option></term>
 
145
        <term><literal>-h</literal>, <literal>--help</literal></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><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>
 
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>
185
198
        <listitem>
186
199
          <para>
187
200
            Run the server’s self-tests.  This includes any unit
189
202
          </para>
190
203
        </listitem>
191
204
      </varlistentry>
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>
 
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>
238
256
        <listitem>
239
257
          <para>
240
258
            Directory to search for configuration files.  Default is
246
264
          </para>
247
265
        </listitem>
248
266
      </varlistentry>
249
 
      
 
267
 
250
268
      <varlistentry>
251
 
        <term><option>--version</option></term>
 
269
        <term><literal>--version</literal></term>
252
270
        <listitem>
253
271
          <para>
254
272
            Prints the program version and exit.
255
273
          </para>
256
274
        </listitem>
257
275
      </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>
275
276
    </variablelist>
276
277
  </refsect1>
277
 
  
 
278
 
278
279
  <refsect1 id="overview">
279
280
    <title>OVERVIEW</title>
280
 
    <xi:include href="overview.xml"/>
 
281
    &OVERVIEW;
281
282
    <para>
282
283
      This program is the server part.  It is a normal server program
283
284
      and will run in a normal system environment, not in an initial
284
 
      <acronym>RAM</acronym> disk environment.
 
285
      RAM disk environment.
285
286
    </para>
286
287
  </refsect1>
287
 
  
 
288
 
288
289
  <refsect1 id="protocol">
289
290
    <title>NETWORK PROTOCOL</title>
290
291
    <para>
316
317
        <entry>-><!-- &rarr; --></entry>
317
318
      </row>
318
319
      <row>
319
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
320
        <entry><quote><literal>1\r\en</literal></quote></entry>
320
321
        <entry>-><!-- &rarr; --></entry>
321
322
      </row>
322
323
      <row>
342
343
      </row>
343
344
    </tbody></tgroup></table>
344
345
  </refsect1>
345
 
  
 
346
 
346
347
  <refsect1 id="checking">
347
348
    <title>CHECKING</title>
348
349
    <para>
349
350
      The server will, by default, continually check that the clients
350
351
      are still up.  If a client has not been confirmed as being up
351
352
      for some time, the client is assumed to be compromised and is no
352
 
      longer eligible to receive the encrypted password.  (Manual
353
 
      intervention is required to re-enable a client.)  The timeout,
 
353
      longer eligible to receive the encrypted password.  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-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
 
  
 
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
 
383
363
  <refsect1 id="logging">
384
364
    <title>LOGGING</title>
385
365
    <para>
386
 
      The server will send log message with various severity levels to
387
 
      <filename>/dev/log</filename>.  With the
 
366
      The server will send log messaged with various severity levels
 
367
      to <filename>/dev/log</filename>.  With the
388
368
      <option>--debug</option> option, it will log even more messages,
389
369
      and also show them on the console.
390
370
    </para>
391
371
  </refsect1>
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
 
  
 
372
 
403
373
  <refsect1 id="exit_status">
404
374
    <title>EXIT STATUS</title>
405
375
    <para>
407
377
      critical error is encountered.
408
378
    </para>
409
379
  </refsect1>
410
 
  
 
380
 
411
381
  <refsect1 id="environment">
412
382
    <title>ENVIRONMENT</title>
413
383
    <variablelist>
414
384
      <varlistentry>
415
 
        <term><envar>PATH</envar></term>
 
385
        <term><varname>PATH</varname></term>
416
386
        <listitem>
417
387
          <para>
418
388
            To start the configured checker (see <xref
421
391
            <varname>PATH</varname> to search for matching commands if
422
392
            an absolute path is not given.  See <citerefentry>
423
393
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
424
 
            </citerefentry>.
 
394
          </citerefentry>
425
395
          </para>
426
396
        </listitem>
427
397
      </varlistentry>
428
398
    </variablelist>
429
399
  </refsect1>
430
 
  
431
 
  <refsect1 id="files">
 
400
 
 
401
  <refsect1 id="file">
432
402
    <title>FILES</title>
433
403
    <para>
434
404
      Use the <option>--configdir</option> option to change where
457
427
        </listitem>
458
428
      </varlistentry>
459
429
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
430
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
461
431
        <listitem>
462
432
          <para>
463
 
            The file containing the process id of the
464
 
            <command>&COMMANDNAME;</command> process started last.
 
433
            The file containing the process id of
 
434
            <command>&COMMANDNAME;</command>.
465
435
          </para>
466
436
        </listitem>
467
437
      </varlistentry>
495
465
      backtrace.  This could be considered a feature.
496
466
    </para>
497
467
    <para>
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"/>.
 
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.
501
477
    </para>
502
478
    <para>
503
479
      There is no fine-grained control over logging and debug output.
506
482
      Debug mode is conflated with running in the foreground.
507
483
    </para>
508
484
    <para>
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.
 
485
      The console log messages does not show a timestamp.
514
486
    </para>
515
487
  </refsect1>
516
488
  
521
493
        Normal invocation needs no options:
522
494
      </para>
523
495
      <para>
524
 
        <userinput>&COMMANDNAME;</userinput>
 
496
        <userinput>mandos</userinput>
525
497
      </para>
526
498
    </informalexample>
527
499
    <informalexample>
534
506
      <para>
535
507
 
536
508
<!-- do not wrap this line -->
537
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
509
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
538
510
 
539
511
      </para>
540
512
    </informalexample>
546
518
      <para>
547
519
 
548
520
<!-- do not wrap this line -->
549
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
521
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
550
522
 
551
523
      </para>
552
524
    </informalexample>
553
525
  </refsect1>
554
 
  
 
526
 
555
527
  <refsect1 id="security">
556
528
    <title>SECURITY</title>
557
 
    <refsect2 id="server">
 
529
    <refsect2 id="SERVER">
558
530
      <title>SERVER</title>
559
531
      <para>
560
532
        Running this <command>&COMMANDNAME;</command> server program
561
533
        should not in itself present any security risk to the host
562
 
        computer running it.  The program switches to a non-root user
563
 
        soon after startup.
 
534
        computer running it.  The program does not need any special
 
535
        privileges to run, and is designed to run as a non-root user.
564
536
      </para>
565
537
    </refsect2>
566
 
    <refsect2 id="clients">
 
538
    <refsect2 id="CLIENTS">
567
539
      <title>CLIENTS</title>
568
540
      <para>
569
541
        The server only gives out its stored data to clients which
576
548
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
549
        <manvolnum>5</manvolnum></citerefentry>)
578
550
        <emphasis>must</emphasis> be made non-readable by anyone
579
 
        except the user starting the server (usually root).
 
551
        except the user running the server.
580
552
      </para>
581
553
      <para>
582
554
        As detailed in <xref linkend="checking"/>, the status of all
585
557
      </para>
586
558
      <para>
587
559
        If a client is compromised, its downtime should be duly noted
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.
 
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.
600
573
      </para>
601
574
      <para>
602
575
        For more details on client-side security, see
603
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
576
        <citerefentry><refentrytitle>password-request</refentrytitle>
604
577
        <manvolnum>8mandos</manvolnum></citerefentry>.
605
578
      </para>
606
579
    </refsect2>
607
580
  </refsect1>
608
 
  
 
581
 
609
582
  <refsect1 id="see_also">
610
583
    <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>
622
584
    <variablelist>
623
585
      <varlistentry>
624
586
        <term>
 
587
          <citerefentry>
 
588
            <refentrytitle>password-request</refentrytitle>
 
589
            <manvolnum>8mandos</manvolnum>
 
590
          </citerefentry>
 
591
        </term>
 
592
        <listitem>
 
593
          <para>
 
594
            This is the actual program which talks to this server.
 
595
            Note that it is normally not invoked directly, and is only
 
596
            run in the initial RAM disk environment, and not on a
 
597
            fully started system.
 
598
          </para>
 
599
        </listitem>
 
600
      </varlistentry>
 
601
      <varlistentry>
 
602
        <term>
625
603
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
626
604
        </term>
627
605
        <listitem>
644
622
      </varlistentry>
645
623
      <varlistentry>
646
624
        <term>
647
 
          <ulink url="http://www.gnu.org/software/gnutls/"
648
 
          >GnuTLS</ulink>
 
625
          <ulink
 
626
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
649
627
        </term>
650
628
      <listitem>
651
629
        <para>
657
635
      </varlistentry>
658
636
      <varlistentry>
659
637
        <term>
660
 
          RFC 4291: <citetitle>IP Version 6 Addressing
661
 
          Architecture</citetitle>
 
638
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
639
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
640
          Unicast Addresses</citation>
662
641
        </term>
663
642
        <listitem>
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>
 
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>
688
649
        </listitem>
689
650
      </varlistentry>
690
651
      <varlistentry>
691
652
        <term>
692
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
 
          Protocol Version 1.1</citetitle>
 
653
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
654
          (TLS) Protocol Version 1.1</citetitle></citation>
694
655
        </term>
695
656
      <listitem>
696
657
        <para>
700
661
      </varlistentry>
701
662
      <varlistentry>
702
663
        <term>
703
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
664
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
665
          Format</citetitle></citation>
704
666
        </term>
705
667
      <listitem>
706
668
        <para>
710
672
      </varlistentry>
711
673
      <varlistentry>
712
674
        <term>
713
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
714
 
          Security</citetitle>
 
675
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
676
          Transport Layer Security</citetitle></citation>
715
677
        </term>
716
678
      <listitem>
717
679
        <para>
723
685
    </variablelist>
724
686
  </refsect1>
725
687
</refentry>
726
 
<!-- Local Variables: -->
727
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
728
 
<!-- time-stamp-end: "[\"']>" -->
729
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
730
 
<!-- End: -->