/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: 2008-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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