/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

merge

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