/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: 2012-06-01 21:48:12 UTC
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

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">
 
5
<!ENTITY TIMESTAMP "2012-05-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
6
8
]>
7
9
 
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
 
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
   <refentryinfo>
 
12
    <title>Mandos Manual</title>
11
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
13
 
    <productnumber>&VERSION;</productnumber>
 
14
    <productname>Mandos</productname>
 
15
    <productnumber>&version;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
14
17
    <authorgroup>
15
18
      <author>
16
19
        <firstname>Björn</firstname>
17
20
        <surname>Påhlsson</surname>
18
21
        <address>
19
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
20
23
        </address>
21
24
      </author>
22
25
      <author>
23
26
        <firstname>Teddy</firstname>
24
27
        <surname>Hogeborn</surname>
25
28
        <address>
26
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
27
30
        </address>
28
31
      </author>
29
32
    </authorgroup>
30
33
    <copyright>
31
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
32
39
      <holder>Teddy Hogeborn</holder>
33
40
      <holder>Björn Påhlsson</holder>
34
41
    </copyright>
35
 
    <legalnotice>
36
 
      <para>
37
 
        This manual page is free software: you can redistribute it
38
 
        and/or modify it under the terms of the GNU General Public
39
 
        License as published by the Free Software Foundation,
40
 
        either version 3 of the License, or (at your option) any
41
 
        later version.
42
 
      </para>
43
 
 
44
 
      <para>
45
 
        This manual page is distributed in the hope that it will
46
 
        be useful, but WITHOUT ANY WARRANTY; without even the
47
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
48
 
        PARTICULAR PURPOSE.  See the GNU General Public License
49
 
        for more details.
50
 
      </para>
51
 
 
52
 
      <para>
53
 
        You should have received a copy of the GNU General Public
54
 
        License along with this program; If not, see
55
 
        <ulink url="http://www.gnu.org/licenses/"/>.
56
 
      </para>
57
 
    </legalnotice>
 
42
    <xi:include href="legalnotice.xml"/>
58
43
  </refentryinfo>
59
 
 
 
44
  
60
45
  <refmeta>
61
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
62
47
    <manvolnum>8</manvolnum>
65
50
  <refnamediv>
66
51
    <refname><command>&COMMANDNAME;</command></refname>
67
52
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
53
      Gives encrypted passwords to authenticated Mandos clients
69
54
    </refpurpose>
70
55
  </refnamediv>
71
 
 
 
56
  
72
57
  <refsynopsisdiv>
73
58
    <cmdsynopsis>
74
59
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
60
      <group>
 
61
        <arg choice="plain"><option>--interface
 
62
        <replaceable>NAME</replaceable></option></arg>
 
63
        <arg choice="plain"><option>-i
 
64
        <replaceable>NAME</replaceable></option></arg>
 
65
      </group>
 
66
      <sbr/>
 
67
      <group>
 
68
        <arg choice="plain"><option>--address
 
69
        <replaceable>ADDRESS</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-a
 
71
        <replaceable>ADDRESS</replaceable></option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--port
 
76
        <replaceable>PORT</replaceable></option></arg>
 
77
        <arg choice="plain"><option>-p
 
78
        <replaceable>PORT</replaceable></option></arg>
 
79
      </group>
 
80
      <sbr/>
 
81
      <arg><option>--priority
 
82
      <replaceable>PRIORITY</replaceable></option></arg>
 
83
      <sbr/>
 
84
      <arg><option>--servicename
 
85
      <replaceable>NAME</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--configdir
 
88
      <replaceable>DIRECTORY</replaceable></option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--debug</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-dbus</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--socket
 
105
      <replaceable>FD</replaceable></option></arg>
92
106
    </cmdsynopsis>
93
107
    <cmdsynopsis>
94
108
      <command>&COMMANDNAME;</command>
95
109
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
110
        <arg choice="plain"><option>--help</option></arg>
 
111
        <arg choice="plain"><option>-h</option></arg>
98
112
      </group>
99
113
    </cmdsynopsis>
100
114
    <cmdsynopsis>
101
115
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
116
      <arg choice="plain"><option>--version</option></arg>
103
117
    </cmdsynopsis>
104
118
    <cmdsynopsis>
105
119
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
120
      <arg choice="plain"><option>--check</option></arg>
107
121
    </cmdsynopsis>
108
122
  </refsynopsisdiv>
109
 
 
 
123
  
110
124
  <refsect1 id="description">
111
125
    <title>DESCRIPTION</title>
112
126
    <para>
113
127
      <command>&COMMANDNAME;</command> is a server daemon which
114
128
      handles incoming request for passwords for a pre-defined list of
115
 
      client host computers.  The Mandos server uses Zeroconf to
116
 
      announce itself on the local network, and uses TLS to
117
 
      communicate securely with and to authenticate the clients.  The
118
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
 
      link-local addresses, since the clients will probably not have
120
 
      any other addresses configured (see <xref linkend="overview"/>).
121
 
      Any authenticated client is then given the stored pre-encrypted
122
 
      password for that specific client.
 
129
      client host computers. For an introduction, see
 
130
      <citerefentry><refentrytitle>intro</refentrytitle>
 
131
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
132
      uses Zeroconf to announce itself on the local network, and uses
 
133
      TLS to communicate securely with and to authenticate the
 
134
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
135
      use IPv6 link-local addresses, since the clients will probably
 
136
      not have any other addresses configured (see <xref
 
137
      linkend="overview"/>).  Any authenticated client is then given
 
138
      the stored pre-encrypted password for that specific client.
123
139
    </para>
124
 
 
125
140
  </refsect1>
126
141
  
127
142
  <refsect1 id="purpose">
128
143
    <title>PURPOSE</title>
129
 
 
130
144
    <para>
131
145
      The purpose of this is to enable <emphasis>remote and unattended
132
146
      rebooting</emphasis> of client host computer with an
133
147
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
148
      linkend="overview"/> for details.
135
149
    </para>
136
 
 
137
150
  </refsect1>
138
151
  
139
152
  <refsect1 id="options">
140
153
    <title>OPTIONS</title>
141
 
 
142
154
    <variablelist>
143
155
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
156
        <term><option>--help</option></term>
 
157
        <term><option>-h</option></term>
145
158
        <listitem>
146
159
          <para>
147
160
            Show a help message and exit
148
161
          </para>
149
162
        </listitem>
150
163
      </varlistentry>
151
 
 
 
164
      
152
165
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
166
        <term><option>--interface</option>
 
167
        <replaceable>NAME</replaceable></term>
 
168
        <term><option>-i</option>
 
169
        <replaceable>NAME</replaceable></term>
155
170
        <listitem>
156
171
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
172
        </listitem>
158
173
      </varlistentry>
159
 
 
 
174
      
160
175
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
176
        <term><option>--address
 
177
        <replaceable>ADDRESS</replaceable></option></term>
 
178
        <term><option>-a
 
179
        <replaceable>ADDRESS</replaceable></option></term>
163
180
        <listitem>
164
181
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
182
        </listitem>
166
183
      </varlistentry>
167
 
 
 
184
      
168
185
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
186
        <term><option>--port
 
187
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><option>-p
 
189
        <replaceable>PORT</replaceable></option></term>
171
190
        <listitem>
172
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
192
        </listitem>
174
193
      </varlistentry>
175
 
 
 
194
      
176
195
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
196
        <term><option>--check</option></term>
178
197
        <listitem>
179
198
          <para>
180
199
            Run the server’s self-tests.  This includes any unit
182
201
          </para>
183
202
        </listitem>
184
203
      </varlistentry>
185
 
 
 
204
      
186
205
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
206
        <term><option>--debug</option></term>
188
207
        <listitem>
189
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
209
        </listitem>
191
210
      </varlistentry>
192
 
 
193
 
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
211
      
 
212
      <varlistentry>
 
213
        <term><option>--debuglevel
 
214
        <replaceable>LEVEL</replaceable></option></term>
 
215
        <listitem>
 
216
          <para>
 
217
            Set the debugging log level.
 
218
            <replaceable>LEVEL</replaceable> is a string, one of
 
219
            <quote><literal>CRITICAL</literal></quote>,
 
220
            <quote><literal>ERROR</literal></quote>,
 
221
            <quote><literal>WARNING</literal></quote>,
 
222
            <quote><literal>INFO</literal></quote>, or
 
223
            <quote><literal>DEBUG</literal></quote>, in order of
 
224
            increasing verbosity.  The default level is
 
225
            <quote><literal>WARNING</literal></quote>.
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
      
 
230
      <varlistentry>
 
231
        <term><option>--priority <replaceable>
 
232
        PRIORITY</replaceable></option></term>
196
233
        <listitem>
197
234
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
235
        </listitem>
199
236
      </varlistentry>
200
 
 
 
237
      
201
238
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
239
        <term><option>--servicename
 
240
        <replaceable>NAME</replaceable></option></term>
204
241
        <listitem>
205
242
          <xi:include href="mandos-options.xml"
206
243
                      xpointer="servicename"/>
207
244
        </listitem>
208
245
      </varlistentry>
209
 
 
 
246
      
210
247
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
248
        <term><option>--configdir
 
249
        <replaceable>DIRECTORY</replaceable></option></term>
213
250
        <listitem>
214
251
          <para>
215
252
            Directory to search for configuration files.  Default is
221
258
          </para>
222
259
        </listitem>
223
260
      </varlistentry>
224
 
 
 
261
      
225
262
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
263
        <term><option>--version</option></term>
227
264
        <listitem>
228
265
          <para>
229
266
            Prints the program version and exit.
230
267
          </para>
231
268
        </listitem>
232
269
      </varlistentry>
 
270
      
 
271
      <varlistentry>
 
272
        <term><option>--no-dbus</option></term>
 
273
        <listitem>
 
274
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
275
          <para>
 
276
            See also <xref linkend="dbus_interface"/>.
 
277
          </para>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-ipv6</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-restore</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
292
          <para>
 
293
            See also <xref linkend="persistent_state"/>.
 
294
          </para>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>--statedir
 
300
        <replaceable>DIRECTORY</replaceable></option></term>
 
301
        <listitem>
 
302
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
      
 
306
      <varlistentry>
 
307
        <term><option>--socket
 
308
        <replaceable>FD</replaceable></option></term>
 
309
        <listitem>
 
310
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
233
314
    </variablelist>
234
315
  </refsect1>
235
 
 
 
316
  
236
317
  <refsect1 id="overview">
237
318
    <title>OVERVIEW</title>
238
319
    <xi:include href="overview.xml"/>
239
320
    <para>
240
321
      This program is the server part.  It is a normal server program
241
322
      and will run in a normal system environment, not in an initial
242
 
      RAM disk environment.
 
323
      <acronym>RAM</acronym> disk environment.
243
324
    </para>
244
325
  </refsect1>
245
 
 
 
326
  
246
327
  <refsect1 id="protocol">
247
328
    <title>NETWORK PROTOCOL</title>
248
329
    <para>
300
381
      </row>
301
382
    </tbody></tgroup></table>
302
383
  </refsect1>
303
 
 
 
384
  
304
385
  <refsect1 id="checking">
305
386
    <title>CHECKING</title>
306
387
    <para>
307
388
      The server will, by default, continually check that the clients
308
389
      are still up.  If a client has not been confirmed as being up
309
390
      for some time, the client is assumed to be compromised and is no
310
 
      longer eligible to receive the encrypted password.  The timeout,
311
 
      checker program, and interval between checks can be configured
312
 
      both globally and per client; see <citerefentry>
 
391
      longer eligible to receive the encrypted password.  (Manual
 
392
      intervention is required to re-enable a client.)  The timeout,
 
393
      extended timeout, checker program, and interval between checks
 
394
      can be configured both globally and per client; see
 
395
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
396
      <manvolnum>5</manvolnum></citerefentry>.
 
397
    </para>
 
398
  </refsect1>
 
399
  
 
400
  <refsect1 id="approval">
 
401
    <title>APPROVAL</title>
 
402
    <para>
 
403
      The server can be configured to require manual approval for a
 
404
      client before it is sent its secret.  The delay to wait for such
 
405
      approval and the default action (approve or deny) can be
 
406
      configured both globally and per client; see <citerefentry>
313
407
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry>.
315
 
    </para>
 
408
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
409
      will be approved immediately without delay.
 
410
    </para>
 
411
    <para>
 
412
      This can be used to deny a client its secret if not manually
 
413
      approved within a specified time.  It can also be used to make
 
414
      the server delay before giving a client its secret, allowing
 
415
      optional manual denying of this specific client.
 
416
    </para>
 
417
    
316
418
  </refsect1>
317
 
 
 
419
  
318
420
  <refsect1 id="logging">
319
421
    <title>LOGGING</title>
320
422
    <para>
321
423
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
424
      <filename class="devicefile">/dev/log</filename>.  With the
323
425
      <option>--debug</option> option, it will log even more messages,
324
426
      and also show them on the console.
325
427
    </para>
326
428
  </refsect1>
327
 
 
 
429
  
 
430
  <refsect1 id="persistent_state">
 
431
    <title>PERSISTENT STATE</title>
 
432
    <para>
 
433
      Client settings, initially read from
 
434
      <filename>clients.conf</filename>, are persistent across
 
435
      restarts, and run-time changes will override settings in
 
436
      <filename>clients.conf</filename>.  However, if a setting is
 
437
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
438
      <filename>clients.conf</filename>, this will take precedence.
 
439
    </para>
 
440
  </refsect1>
 
441
  
 
442
  <refsect1 id="dbus_interface">
 
443
    <title>D-BUS INTERFACE</title>
 
444
    <para>
 
445
      The server will by default provide a D-Bus system bus interface.
 
446
      This interface will only be accessible by the root user or a
 
447
      Mandos-specific user, if such a user exists.  For documentation
 
448
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
449
    </para>
 
450
  </refsect1>
 
451
  
328
452
  <refsect1 id="exit_status">
329
453
    <title>EXIT STATUS</title>
330
454
    <para>
332
456
      critical error is encountered.
333
457
    </para>
334
458
  </refsect1>
335
 
 
 
459
  
336
460
  <refsect1 id="environment">
337
461
    <title>ENVIRONMENT</title>
338
462
    <variablelist>
339
463
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
464
        <term><envar>PATH</envar></term>
341
465
        <listitem>
342
466
          <para>
343
467
            To start the configured checker (see <xref
352
476
      </varlistentry>
353
477
    </variablelist>
354
478
  </refsect1>
355
 
 
356
 
  <refsect1 id="file">
 
479
  
 
480
  <refsect1 id="files">
357
481
    <title>FILES</title>
358
482
    <para>
359
483
      Use the <option>--configdir</option> option to change where
382
506
        </listitem>
383
507
      </varlistentry>
384
508
      <varlistentry>
385
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
386
 
        <listitem>
387
 
          <para>
388
 
            The file containing the process id of
389
 
            <command>&COMMANDNAME;</command>.
 
509
        <term><filename>/var/run/mandos.pid</filename></term>
 
510
        <listitem>
 
511
          <para>
 
512
            The file containing the process id of the
 
513
            <command>&COMMANDNAME;</command> process started last.
 
514
          </para>
 
515
        </listitem>
 
516
      </varlistentry>
 
517
      <varlistentry>
 
518
        <term><filename class="devicefile">/dev/log</filename></term>
 
519
      </varlistentry>
 
520
      <varlistentry>
 
521
        <term><filename
 
522
        class="directory">/var/lib/mandos</filename></term>
 
523
        <listitem>
 
524
          <para>
 
525
            Directory where persistent state will be saved.  Change
 
526
            this with the <option>--statedir</option> option.  See
 
527
            also the <option>--no-restore</option> option.
390
528
          </para>
391
529
        </listitem>
392
530
      </varlistentry>
420
558
      backtrace.  This could be considered a feature.
421
559
    </para>
422
560
    <para>
423
 
      Currently, if a client is declared <quote>invalid</quote> due to
424
 
      having timed out, the server does not record this fact onto
425
 
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
427
 
    </para>
428
 
    <para>
429
 
      There is currently no way of querying the server of the current
430
 
      status of clients, other than analyzing its <systemitem
431
 
      class="service">syslog</systemitem> output.
432
 
    </para>
433
 
    <para>
434
561
      There is no fine-grained control over logging and debug output.
435
562
    </para>
436
563
    <para>
437
564
      Debug mode is conflated with running in the foreground.
438
565
    </para>
439
566
    <para>
440
 
      The console log messages does not show a timestamp.
 
567
      This server does not check the expire time of clients’ OpenPGP
 
568
      keys.
441
569
    </para>
442
570
  </refsect1>
443
571
  
448
576
        Normal invocation needs no options:
449
577
      </para>
450
578
      <para>
451
 
        <userinput>mandos</userinput>
 
579
        <userinput>&COMMANDNAME;</userinput>
452
580
      </para>
453
581
    </informalexample>
454
582
    <informalexample>
455
583
      <para>
456
584
        Run the server in debug mode, read configuration files from
457
 
        the <filename>~/mandos</filename> directory, and use the
458
 
        Zeroconf service name <quote>Test</quote> to not collide with
459
 
        any other official Mandos server on this host:
 
585
        the <filename class="directory">~/mandos</filename> directory,
 
586
        and use the Zeroconf service name <quote>Test</quote> to not
 
587
        collide with any other official Mandos server on this host:
460
588
      </para>
461
589
      <para>
462
590
 
463
591
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
592
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
593
 
466
594
      </para>
467
595
    </informalexample>
473
601
      <para>
474
602
 
475
603
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
604
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
605
 
478
606
      </para>
479
607
    </informalexample>
480
608
  </refsect1>
481
 
 
 
609
  
482
610
  <refsect1 id="security">
483
611
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
612
    <refsect2 id="server">
485
613
      <title>SERVER</title>
486
614
      <para>
487
615
        Running this <command>&COMMANDNAME;</command> server program
488
616
        should not in itself present any security risk to the host
489
 
        computer running it.  The program does not need any special
490
 
        privileges to run, and is designed to run as a non-root user.
 
617
        computer running it.  The program switches to a non-root user
 
618
        soon after startup.
491
619
      </para>
492
620
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
621
    <refsect2 id="clients">
494
622
      <title>CLIENTS</title>
495
623
      <para>
496
624
        The server only gives out its stored data to clients which
503
631
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
504
632
        <manvolnum>5</manvolnum></citerefentry>)
505
633
        <emphasis>must</emphasis> be made non-readable by anyone
506
 
        except the user running the server.
 
634
        except the user starting the server (usually root).
507
635
      </para>
508
636
      <para>
509
637
        As detailed in <xref linkend="checking"/>, the status of all
511
639
        compromised if they are gone for too long.
512
640
      </para>
513
641
      <para>
514
 
        If a client is compromised, its downtime should be duly noted
515
 
        by the server which would therefore declare the client
516
 
        invalid.  But if the server was ever restarted, it would
517
 
        re-read its client list from its configuration file and again
518
 
        regard all clients therein as valid, and hence eligible to
519
 
        receive their passwords.  Therefore, be careful when
520
 
        restarting servers if it is suspected that a client has, in
521
 
        fact, been compromised by parties who may now be running a
522
 
        fake Mandos client with the keys from the non-encrypted
523
 
        initial RAM image of the client host.  What should be done in
524
 
        that case (if restarting the server program really is
525
 
        necessary) is to stop the server program, edit the
526
 
        configuration file to omit any suspect clients, and restart
527
 
        the server program.
528
 
      </para>
529
 
      <para>
530
642
        For more details on client-side security, see
531
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
643
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
644
        <manvolnum>8mandos</manvolnum></citerefentry>.
533
645
      </para>
534
646
    </refsect2>
535
647
  </refsect1>
536
 
 
 
648
  
537
649
  <refsect1 id="see_also">
538
650
    <title>SEE ALSO</title>
539
651
    <para>
540
 
      <citerefentry>
541
 
        <refentrytitle>mandos.conf</refentrytitle>
542
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
546
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
 
      </citerefentry>
 
652
      <citerefentry><refentrytitle>intro</refentrytitle>
 
653
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
654
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
655
      <manvolnum>5</manvolnum></citerefentry>,
 
656
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
657
      <manvolnum>5</manvolnum></citerefentry>,
 
658
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
659
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
660
      <citerefentry><refentrytitle>sh</refentrytitle>
 
661
      <manvolnum>1</manvolnum></citerefentry>
549
662
    </para>
550
663
    <variablelist>
551
664
      <varlistentry>
572
685
      </varlistentry>
573
686
      <varlistentry>
574
687
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
688
          <ulink url="http://www.gnu.org/software/gnutls/"
 
689
          >GnuTLS</ulink>
577
690
        </term>
578
691
      <listitem>
579
692
        <para>
585
698
      </varlistentry>
586
699
      <varlistentry>
587
700
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
701
          RFC 4291: <citetitle>IP Version 6 Addressing
 
702
          Architecture</citetitle>
591
703
        </term>
592
704
        <listitem>
593
 
          <para>
594
 
            The clients use IPv6 link-local addresses, which are
595
 
            immediately usable since a link-local addresses is
596
 
            automatically assigned to a network interfaces when it is
597
 
            brought up.
598
 
          </para>
 
705
          <variablelist>
 
706
            <varlistentry>
 
707
              <term>Section 2.2: <citetitle>Text Representation of
 
708
              Addresses</citetitle></term>
 
709
              <listitem><para/></listitem>
 
710
            </varlistentry>
 
711
            <varlistentry>
 
712
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
713
              Address</citetitle></term>
 
714
              <listitem><para/></listitem>
 
715
            </varlistentry>
 
716
            <varlistentry>
 
717
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
718
            Addresses</citetitle></term>
 
719
            <listitem>
 
720
              <para>
 
721
                The clients use IPv6 link-local addresses, which are
 
722
                immediately usable since a link-local addresses is
 
723
                automatically assigned to a network interfaces when it
 
724
                is brought up.
 
725
              </para>
 
726
            </listitem>
 
727
            </varlistentry>
 
728
          </variablelist>
599
729
        </listitem>
600
730
      </varlistentry>
601
731
      <varlistentry>
602
732
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
733
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
734
          Protocol Version 1.1</citetitle>
605
735
        </term>
606
736
      <listitem>
607
737
        <para>
611
741
      </varlistentry>
612
742
      <varlistentry>
613
743
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
744
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
745
        </term>
617
746
      <listitem>
618
747
        <para>
622
751
      </varlistentry>
623
752
      <varlistentry>
624
753
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
754
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
755
          Security</citetitle>
627
756
        </term>
628
757
      <listitem>
629
758
        <para>
635
764
    </variablelist>
636
765
  </refsect1>
637
766
</refentry>
 
767
<!-- Local Variables: -->
 
768
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
769
<!-- time-stamp-end: "[\"']>" -->
 
770
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
771
<!-- End: -->