/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 03:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

Show diffs side-by-side

added added

removed removed

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