/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: 2009-01-06 00:58:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106005817-lnxyism0yjkmmlj1
Tags: version-1.0.3-1
* Makefile (version): Changed to "1.0.3".
* NEWS (Version 1.0.3): New entry.
* debian/changelog (1.0.3-1): New entry.

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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-30">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
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
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
70
50
      Gives encrypted passwords to authenticated Mandos clients
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
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>
 
57
      <group>
 
58
        <arg choice="plain"><option>--interface
 
59
        <replaceable>NAME</replaceable></option></arg>
 
60
        <arg choice="plain"><option>-i
 
61
        <replaceable>NAME</replaceable></option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--address
 
66
        <replaceable>ADDRESS</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-a
 
68
        <replaceable>ADDRESS</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
 
72
        <arg choice="plain"><option>--port
 
73
        <replaceable>PORT</replaceable></option></arg>
 
74
        <arg choice="plain"><option>-p
 
75
        <replaceable>PORT</replaceable></option></arg>
 
76
      </group>
 
77
      <sbr/>
 
78
      <arg><option>--priority
 
79
      <replaceable>PRIORITY</replaceable></option></arg>
 
80
      <sbr/>
 
81
      <arg><option>--servicename
 
82
      <replaceable>NAME</replaceable></option></arg>
 
83
      <sbr/>
 
84
      <arg><option>--configdir
 
85
      <replaceable>DIRECTORY</replaceable></option></arg>
 
86
      <sbr/>
 
87
      <arg><option>--debug</option></arg>
94
88
    </cmdsynopsis>
95
89
    <cmdsynopsis>
96
90
      <command>&COMMANDNAME;</command>
97
91
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
92
        <arg choice="plain"><option>--help</option></arg>
 
93
        <arg choice="plain"><option>-h</option></arg>
100
94
      </group>
101
95
    </cmdsynopsis>
102
96
    <cmdsynopsis>
103
97
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
98
      <arg choice="plain"><option>--version</option></arg>
105
99
    </cmdsynopsis>
106
100
    <cmdsynopsis>
107
101
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
102
      <arg choice="plain"><option>--check</option></arg>
109
103
    </cmdsynopsis>
110
104
  </refsynopsisdiv>
111
 
 
 
105
  
112
106
  <refsect1 id="description">
113
107
    <title>DESCRIPTION</title>
114
108
    <para>
123
117
      Any authenticated client is then given the stored pre-encrypted
124
118
      password for that specific client.
125
119
    </para>
126
 
 
127
120
  </refsect1>
128
121
  
129
122
  <refsect1 id="purpose">
130
123
    <title>PURPOSE</title>
131
 
 
132
124
    <para>
133
125
      The purpose of this is to enable <emphasis>remote and unattended
134
126
      rebooting</emphasis> of client host computer with an
135
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
128
      linkend="overview"/> for details.
137
129
    </para>
138
 
 
139
130
  </refsect1>
140
131
  
141
132
  <refsect1 id="options">
142
133
    <title>OPTIONS</title>
143
 
 
144
134
    <variablelist>
145
135
      <varlistentry>
 
136
        <term><option>--help</option></term>
146
137
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
148
138
        <listitem>
149
139
          <para>
150
140
            Show a help message and exit
151
141
          </para>
152
142
        </listitem>
153
143
      </varlistentry>
154
 
 
 
144
      
155
145
      <varlistentry>
 
146
        <term><option>--interface</option>
 
147
        <replaceable>NAME</replaceable></term>
156
148
        <term><option>-i</option>
157
149
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
160
150
        <listitem>
161
151
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
152
        </listitem>
163
153
      </varlistentry>
164
 
 
 
154
      
165
155
      <varlistentry>
166
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
 
        ADDRESS</replaceable></literal></term>
 
156
        <term><option>--address
 
157
        <replaceable>ADDRESS</replaceable></option></term>
 
158
        <term><option>-a
 
159
        <replaceable>ADDRESS</replaceable></option></term>
168
160
        <listitem>
169
161
          <xi:include href="mandos-options.xml" xpointer="address"/>
170
162
        </listitem>
171
163
      </varlistentry>
172
 
 
 
164
      
173
165
      <varlistentry>
174
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
 
        PORT</replaceable></literal></term>
 
166
        <term><option>--port
 
167
        <replaceable>PORT</replaceable></option></term>
 
168
        <term><option>-p
 
169
        <replaceable>PORT</replaceable></option></term>
176
170
        <listitem>
177
171
          <xi:include href="mandos-options.xml" xpointer="port"/>
178
172
        </listitem>
179
173
      </varlistentry>
180
 
 
 
174
      
181
175
      <varlistentry>
182
 
        <term><literal>--check</literal></term>
 
176
        <term><option>--check</option></term>
183
177
        <listitem>
184
178
          <para>
185
179
            Run the server’s self-tests.  This includes any unit
187
181
          </para>
188
182
        </listitem>
189
183
      </varlistentry>
190
 
 
 
184
      
191
185
      <varlistentry>
192
 
        <term><literal>--debug</literal></term>
 
186
        <term><option>--debug</option></term>
193
187
        <listitem>
194
188
          <xi:include href="mandos-options.xml" xpointer="debug"/>
195
189
        </listitem>
196
190
      </varlistentry>
197
 
 
 
191
      
198
192
      <varlistentry>
199
 
        <term><literal>--priority <replaceable>
200
 
        PRIORITY</replaceable></literal></term>
 
193
        <term><option>--priority <replaceable>
 
194
        PRIORITY</replaceable></option></term>
201
195
        <listitem>
202
196
          <xi:include href="mandos-options.xml" xpointer="priority"/>
203
197
        </listitem>
204
198
      </varlistentry>
205
 
 
 
199
      
206
200
      <varlistentry>
207
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
 
        </literal></term>
 
201
        <term><option>--servicename
 
202
        <replaceable>NAME</replaceable></option></term>
209
203
        <listitem>
210
204
          <xi:include href="mandos-options.xml"
211
205
                      xpointer="servicename"/>
212
206
        </listitem>
213
207
      </varlistentry>
214
 
 
 
208
      
215
209
      <varlistentry>
216
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
217
 
        </literal></term>
 
210
        <term><option>--configdir
 
211
        <replaceable>DIRECTORY</replaceable></option></term>
218
212
        <listitem>
219
213
          <para>
220
214
            Directory to search for configuration files.  Default is
226
220
          </para>
227
221
        </listitem>
228
222
      </varlistentry>
229
 
 
 
223
      
230
224
      <varlistentry>
231
 
        <term><literal>--version</literal></term>
 
225
        <term><option>--version</option></term>
232
226
        <listitem>
233
227
          <para>
234
228
            Prints the program version and exit.
237
231
      </varlistentry>
238
232
    </variablelist>
239
233
  </refsect1>
240
 
 
 
234
  
241
235
  <refsect1 id="overview">
242
236
    <title>OVERVIEW</title>
243
237
    <xi:include href="overview.xml"/>
244
238
    <para>
245
239
      This program is the server part.  It is a normal server program
246
240
      and will run in a normal system environment, not in an initial
247
 
      RAM disk environment.
 
241
      <acronym>RAM</acronym> disk environment.
248
242
    </para>
249
243
  </refsect1>
250
 
 
 
244
  
251
245
  <refsect1 id="protocol">
252
246
    <title>NETWORK PROTOCOL</title>
253
247
    <para>
305
299
      </row>
306
300
    </tbody></tgroup></table>
307
301
  </refsect1>
308
 
 
 
302
  
309
303
  <refsect1 id="checking">
310
304
    <title>CHECKING</title>
311
305
    <para>
319
313
      <manvolnum>5</manvolnum></citerefentry>.
320
314
    </para>
321
315
  </refsect1>
322
 
 
 
316
  
323
317
  <refsect1 id="logging">
324
318
    <title>LOGGING</title>
325
319
    <para>
329
323
      and also show them on the console.
330
324
    </para>
331
325
  </refsect1>
332
 
 
 
326
  
333
327
  <refsect1 id="exit_status">
334
328
    <title>EXIT STATUS</title>
335
329
    <para>
337
331
      critical error is encountered.
338
332
    </para>
339
333
  </refsect1>
340
 
 
 
334
  
341
335
  <refsect1 id="environment">
342
336
    <title>ENVIRONMENT</title>
343
337
    <variablelist>
357
351
      </varlistentry>
358
352
    </variablelist>
359
353
  </refsect1>
360
 
 
361
 
  <refsect1 id="file">
 
354
  
 
355
  <refsect1 id="files">
362
356
    <title>FILES</title>
363
357
    <para>
364
358
      Use the <option>--configdir</option> option to change where
387
381
        </listitem>
388
382
      </varlistentry>
389
383
      <varlistentry>
390
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
384
        <term><filename>/var/run/mandos.pid</filename></term>
391
385
        <listitem>
392
386
          <para>
393
387
            The file containing the process id of
428
422
      Currently, if a client is declared <quote>invalid</quote> due to
429
423
      having timed out, the server does not record this fact onto
430
424
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
 
425
      <xref linkend="clients"/>.
432
426
    </para>
433
427
    <para>
434
428
      There is currently no way of querying the server of the current
442
436
      Debug mode is conflated with running in the foreground.
443
437
    </para>
444
438
    <para>
445
 
      The console log messages does not show a timestamp.
 
439
      The console log messages does not show a time stamp.
 
440
    </para>
 
441
    <para>
 
442
      This server does not check the expire time of clients’ OpenPGP
 
443
      keys.
446
444
    </para>
447
445
  </refsect1>
448
446
  
483
481
      </para>
484
482
    </informalexample>
485
483
  </refsect1>
486
 
 
 
484
  
487
485
  <refsect1 id="security">
488
486
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
487
    <refsect2 id="server">
490
488
      <title>SERVER</title>
491
489
      <para>
492
490
        Running this <command>&COMMANDNAME;</command> server program
493
491
        should not in itself present any security risk to the host
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.
 
492
        computer running it.  The program switches to a non-root user
 
493
        soon after startup.
496
494
      </para>
497
495
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
496
    <refsect2 id="clients">
499
497
      <title>CLIENTS</title>
500
498
      <para>
501
499
        The server only gives out its stored data to clients which
508
506
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
509
507
        <manvolnum>5</manvolnum></citerefentry>)
510
508
        <emphasis>must</emphasis> be made non-readable by anyone
511
 
        except the user running the server.
 
509
        except the user starting the server (usually root).
512
510
      </para>
513
511
      <para>
514
512
        As detailed in <xref linkend="checking"/>, the status of all
525
523
        restarting servers if it is suspected that a client has, in
526
524
        fact, been compromised by parties who may now be running a
527
525
        fake Mandos client with the keys from the non-encrypted
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
 
526
        initial <acronym>RAM</acronym> image of the client host.  What
 
527
        should be done in that case (if restarting the server program
 
528
        really is necessary) is to stop the server program, edit the
531
529
        configuration file to omit any suspect clients, and restart
532
530
        the server program.
533
531
      </para>
534
532
      <para>
535
533
        For more details on client-side security, see
536
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
534
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
537
535
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
536
      </para>
539
537
    </refsect2>
540
538
  </refsect1>
541
 
 
 
539
  
542
540
  <refsect1 id="see_also">
543
541
    <title>SEE ALSO</title>
544
542
    <para>
547
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
546
        <refentrytitle>mandos.conf</refentrytitle>
549
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
 
548
        <refentrytitle>mandos-client</refentrytitle>
551
549
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
550
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
551
      </citerefentry>