/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 05:57:11 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818055711-2rpzat3hkbq3us62
No code or documentation changes.

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