/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-30 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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 "2008-12-28">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
35
34
      <holder>Teddy Hogeborn</holder>
36
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
39
60
  </refentryinfo>
40
 
  
 
61
 
41
62
  <refmeta>
42
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
64
    <manvolnum>8</manvolnum>
49
70
      Gives encrypted passwords to authenticated Mandos clients
50
71
    </refpurpose>
51
72
  </refnamediv>
52
 
  
 
73
 
53
74
  <refsynopsisdiv>
54
75
    <cmdsynopsis>
55
76
      <command>&COMMANDNAME;</command>
56
 
      <group>
57
 
        <arg choice="plain"><option>--interface
58
 
        <replaceable>NAME</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-i
60
 
        <replaceable>NAME</replaceable></option></arg>
61
 
      </group>
62
 
      <sbr/>
63
 
      <group>
64
 
        <arg choice="plain"><option>--address
65
 
        <replaceable>ADDRESS</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-a
67
 
        <replaceable>ADDRESS</replaceable></option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--port
72
 
        <replaceable>PORT</replaceable></option></arg>
73
 
        <arg choice="plain"><option>-p
74
 
        <replaceable>PORT</replaceable></option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <arg><option>--priority
78
 
      <replaceable>PRIORITY</replaceable></option></arg>
79
 
      <sbr/>
80
 
      <arg><option>--servicename
81
 
      <replaceable>NAME</replaceable></option></arg>
82
 
      <sbr/>
83
 
      <arg><option>--configdir
84
 
      <replaceable>DIRECTORY</replaceable></option></arg>
85
 
      <sbr/>
86
 
      <arg><option>--debug</option></arg>
87
 
      <sbr/>
88
 
      <arg><option>--no-dbus</option></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
81
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
82
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
83
      <arg>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
91
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
92
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
93
      <arg>--debug</arg>
89
94
    </cmdsynopsis>
90
95
    <cmdsynopsis>
91
96
      <command>&COMMANDNAME;</command>
92
97
      <group choice="req">
93
 
        <arg choice="plain"><option>--help</option></arg>
94
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
95
100
      </group>
96
101
    </cmdsynopsis>
97
102
    <cmdsynopsis>
98
103
      <command>&COMMANDNAME;</command>
99
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
100
105
    </cmdsynopsis>
101
106
    <cmdsynopsis>
102
107
      <command>&COMMANDNAME;</command>
103
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
104
109
    </cmdsynopsis>
105
110
  </refsynopsisdiv>
106
 
  
 
111
 
107
112
  <refsect1 id="description">
108
113
    <title>DESCRIPTION</title>
109
114
    <para>
118
123
      Any authenticated client is then given the stored pre-encrypted
119
124
      password for that specific client.
120
125
    </para>
 
126
 
121
127
  </refsect1>
122
128
  
123
129
  <refsect1 id="purpose">
124
130
    <title>PURPOSE</title>
 
131
 
125
132
    <para>
126
133
      The purpose of this is to enable <emphasis>remote and unattended
127
134
      rebooting</emphasis> of client host computer with an
128
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
129
136
      linkend="overview"/> for details.
130
137
    </para>
 
138
 
131
139
  </refsect1>
132
140
  
133
141
  <refsect1 id="options">
134
142
    <title>OPTIONS</title>
 
143
 
135
144
    <variablelist>
136
145
      <varlistentry>
 
146
        <term><option>-h</option></term>
137
147
        <term><option>--help</option></term>
138
 
        <term><option>-h</option></term>
139
148
        <listitem>
140
149
          <para>
141
150
            Show a help message and exit
142
151
          </para>
143
152
        </listitem>
144
153
      </varlistentry>
145
 
      
 
154
 
146
155
      <varlistentry>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
147
158
        <term><option>--interface</option>
148
159
        <replaceable>NAME</replaceable></term>
149
 
        <term><option>-i</option>
150
 
        <replaceable>NAME</replaceable></term>
151
160
        <listitem>
152
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
153
162
        </listitem>
154
163
      </varlistentry>
155
 
      
 
164
 
156
165
      <varlistentry>
157
 
        <term><option>--address
158
 
        <replaceable>ADDRESS</replaceable></option></term>
159
 
        <term><option>-a
160
 
        <replaceable>ADDRESS</replaceable></option></term>
 
166
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
167
        ADDRESS</replaceable></literal></term>
161
168
        <listitem>
162
169
          <xi:include href="mandos-options.xml" xpointer="address"/>
163
170
        </listitem>
164
171
      </varlistentry>
165
 
      
 
172
 
166
173
      <varlistentry>
167
 
        <term><option>--port
168
 
        <replaceable>PORT</replaceable></option></term>
169
 
        <term><option>-p
170
 
        <replaceable>PORT</replaceable></option></term>
 
174
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
175
        PORT</replaceable></literal></term>
171
176
        <listitem>
172
177
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
178
        </listitem>
174
179
      </varlistentry>
175
 
      
 
180
 
176
181
      <varlistentry>
177
 
        <term><option>--check</option></term>
 
182
        <term><literal>--check</literal></term>
178
183
        <listitem>
179
184
          <para>
180
185
            Run the server’s self-tests.  This includes any unit
182
187
          </para>
183
188
        </listitem>
184
189
      </varlistentry>
185
 
      
 
190
 
186
191
      <varlistentry>
187
 
        <term><option>--debug</option></term>
 
192
        <term><literal>--debug</literal></term>
188
193
        <listitem>
189
194
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
195
        </listitem>
191
196
      </varlistentry>
192
 
      
 
197
 
193
198
      <varlistentry>
194
 
        <term><option>--priority <replaceable>
195
 
        PRIORITY</replaceable></option></term>
 
199
        <term><literal>--priority <replaceable>
 
200
        PRIORITY</replaceable></literal></term>
196
201
        <listitem>
197
202
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
203
        </listitem>
199
204
      </varlistentry>
200
 
      
 
205
 
201
206
      <varlistentry>
202
 
        <term><option>--servicename
203
 
        <replaceable>NAME</replaceable></option></term>
 
207
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
208
        </literal></term>
204
209
        <listitem>
205
210
          <xi:include href="mandos-options.xml"
206
211
                      xpointer="servicename"/>
207
212
        </listitem>
208
213
      </varlistentry>
209
 
      
 
214
 
210
215
      <varlistentry>
211
 
        <term><option>--configdir
212
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
216
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
217
        </literal></term>
213
218
        <listitem>
214
219
          <para>
215
220
            Directory to search for configuration files.  Default is
221
226
          </para>
222
227
        </listitem>
223
228
      </varlistentry>
224
 
      
 
229
 
225
230
      <varlistentry>
226
 
        <term><option>--version</option></term>
 
231
        <term><literal>--version</literal></term>
227
232
        <listitem>
228
233
          <para>
229
234
            Prints the program version and exit.
230
235
          </para>
231
236
        </listitem>
232
237
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--no-dbus</option></term>
236
 
        <listitem>
237
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
238
 
          <para>
239
 
            See also <xref linkend="dbus"/>.
240
 
        </listitem>
241
 
      </varlistentry>
242
238
    </variablelist>
243
239
  </refsect1>
244
 
  
 
240
 
245
241
  <refsect1 id="overview">
246
242
    <title>OVERVIEW</title>
247
243
    <xi:include href="overview.xml"/>
248
244
    <para>
249
245
      This program is the server part.  It is a normal server program
250
246
      and will run in a normal system environment, not in an initial
251
 
      <acronym>RAM</acronym> disk environment.
 
247
      RAM disk environment.
252
248
    </para>
253
249
  </refsect1>
254
 
  
 
250
 
255
251
  <refsect1 id="protocol">
256
252
    <title>NETWORK PROTOCOL</title>
257
253
    <para>
309
305
      </row>
310
306
    </tbody></tgroup></table>
311
307
  </refsect1>
312
 
  
 
308
 
313
309
  <refsect1 id="checking">
314
310
    <title>CHECKING</title>
315
311
    <para>
323
319
      <manvolnum>5</manvolnum></citerefentry>.
324
320
    </para>
325
321
  </refsect1>
326
 
  
 
322
 
327
323
  <refsect1 id="logging">
328
324
    <title>LOGGING</title>
329
325
    <para>
333
329
      and also show them on the console.
334
330
    </para>
335
331
  </refsect1>
336
 
  
337
 
  <refsect1 id="dbus">
338
 
    <title>D-BUS INTERFACE</title>
339
 
    <para>
340
 
      The server will by default provide a D-Bus system bus interface.
341
 
      This interface will only be accessible by the root user or a
342
 
      Mandos-specific user, if such a user exists.
343
 
      <!-- XXX -->
344
 
    </para>
345
 
  </refsect1>
346
332
 
347
333
  <refsect1 id="exit_status">
348
334
    <title>EXIT STATUS</title>
351
337
      critical error is encountered.
352
338
    </para>
353
339
  </refsect1>
354
 
  
 
340
 
355
341
  <refsect1 id="environment">
356
342
    <title>ENVIRONMENT</title>
357
343
    <variablelist>
371
357
      </varlistentry>
372
358
    </variablelist>
373
359
  </refsect1>
374
 
  
375
 
  <refsect1 id="files">
 
360
 
 
361
  <refsect1 id="file">
376
362
    <title>FILES</title>
377
363
    <para>
378
364
      Use the <option>--configdir</option> option to change where
401
387
        </listitem>
402
388
      </varlistentry>
403
389
      <varlistentry>
404
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
390
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
405
391
        <listitem>
406
392
          <para>
407
393
            The file containing the process id of
442
428
      Currently, if a client is declared <quote>invalid</quote> due to
443
429
      having timed out, the server does not record this fact onto
444
430
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="clients"/>.
 
431
      <xref linkend="CLIENTS"/>.
446
432
    </para>
447
433
    <para>
448
434
      There is currently no way of querying the server of the current
456
442
      Debug mode is conflated with running in the foreground.
457
443
    </para>
458
444
    <para>
459
 
      The console log messages does not show a time stamp.
460
 
    </para>
461
 
    <para>
462
 
      This server does not check the expire time of clients’ OpenPGP
463
 
      keys.
 
445
      The console log messages does not show a timestamp.
464
446
    </para>
465
447
  </refsect1>
466
448
  
501
483
      </para>
502
484
    </informalexample>
503
485
  </refsect1>
504
 
  
 
486
 
505
487
  <refsect1 id="security">
506
488
    <title>SECURITY</title>
507
 
    <refsect2 id="server">
 
489
    <refsect2 id="SERVER">
508
490
      <title>SERVER</title>
509
491
      <para>
510
492
        Running this <command>&COMMANDNAME;</command> server program
511
493
        should not in itself present any security risk to the host
512
 
        computer running it.  The program switches to a non-root user
513
 
        soon after startup.
 
494
        computer running it.  The program does not need any special
 
495
        privileges to run, and is designed to run as a non-root user.
514
496
      </para>
515
497
    </refsect2>
516
 
    <refsect2 id="clients">
 
498
    <refsect2 id="CLIENTS">
517
499
      <title>CLIENTS</title>
518
500
      <para>
519
501
        The server only gives out its stored data to clients which
526
508
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
509
        <manvolnum>5</manvolnum></citerefentry>)
528
510
        <emphasis>must</emphasis> be made non-readable by anyone
529
 
        except the user starting the server (usually root).
 
511
        except the user running the server.
530
512
      </para>
531
513
      <para>
532
514
        As detailed in <xref linkend="checking"/>, the status of all
543
525
        restarting servers if it is suspected that a client has, in
544
526
        fact, been compromised by parties who may now be running a
545
527
        fake Mandos client with the keys from the non-encrypted
546
 
        initial <acronym>RAM</acronym> image of the client host.  What
547
 
        should be done in that case (if restarting the server program
548
 
        really is necessary) is to stop the server program, edit the
 
528
        initial RAM image of the client host.  What should be done in
 
529
        that case (if restarting the server program really is
 
530
        necessary) is to stop the server program, edit the
549
531
        configuration file to omit any suspect clients, and restart
550
532
        the server program.
551
533
      </para>
552
534
      <para>
553
535
        For more details on client-side security, see
554
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
536
        <citerefentry><refentrytitle>password-request</refentrytitle>
555
537
        <manvolnum>8mandos</manvolnum></citerefentry>.
556
538
      </para>
557
539
    </refsect2>
558
540
  </refsect1>
559
 
  
 
541
 
560
542
  <refsect1 id="see_also">
561
543
    <title>SEE ALSO</title>
562
544
    <para>
565
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
548
        <refentrytitle>mandos.conf</refentrytitle>
567
549
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
 
        <refentrytitle>mandos-client</refentrytitle>
 
550
        <refentrytitle>password-request</refentrytitle>
569
551
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
552
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
571
553
      </citerefentry>