/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-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

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