/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-17 06:01:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817060158-o5xakkih6t3br9yq
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
            GPGME_CFLAGS, GPGME_LIBS): New; use libgnutls-config,
                                       pkg-config, and gpgme-config to
                                       get the correct compiler and
                                       linker flags.
  (MANPOST): New post-processing stage to man pages to fix a bug with
             having "\n" in the DocBook pages.
  (objects): Use $(addsuffix) instead of a for loop in a subshell.
  (plugin-runner, plugins.d/password-prompt): Removed; targets no
                                              longer necessary.
  (.PHONY): Added "doc".

* mandos.xml: Much improved.

* plugins.d/password-request.xml: Improved SEE ALSO section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
10
<refentry>
 
11
  <refentryinfo>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
    <manvolnum>8</manvolnum>
49
67
  <refnamediv>
50
68
    <refname><command>&COMMANDNAME;</command></refname>
51
69
    <refpurpose>
52
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
75
    <cmdsynopsis>
58
76
      <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>
97
 
    </cmdsynopsis>
98
 
    <cmdsynopsis>
99
 
      <command>&COMMANDNAME;</command>
100
 
      <group choice="req">
101
 
        <arg choice="plain"><option>--help</option></arg>
102
 
        <arg choice="plain"><option>-h</option></arg>
103
 
      </group>
104
 
    </cmdsynopsis>
105
 
    <cmdsynopsis>
106
 
      <command>&COMMANDNAME;</command>
107
 
      <arg choice="plain"><option>--version</option></arg>
108
 
    </cmdsynopsis>
109
 
    <cmdsynopsis>
110
 
      <command>&COMMANDNAME;</command>
111
 
      <arg choice="plain"><option>--check</option></arg>
112
 
    </cmdsynopsis>
 
77
      <arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
 
78
      <arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
 
79
      <arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
 
80
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
81
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
 
82
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
 
83
      <arg choice='opt'>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
 
88
      <arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
 
89
      <arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
 
90
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
91
      <arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
 
92
      <arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
 
93
      <arg choice='opt'>--debug</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--help</arg>
 
98
    </cmdsynopsis>
 
99
    <cmdsynopsis>
 
100
      <command>&COMMANDNAME;</command>
 
101
      <arg choice='plain'>--version</arg>
 
102
    </cmdsynopsis>
 
103
    <cmdsynopsis>
 
104
      <command>&COMMANDNAME;</command>
 
105
      <arg choice='plain'>--check</arg>
 
106
    </cmdsynopsis>    
113
107
  </refsynopsisdiv>
114
 
  
 
108
 
115
109
  <refsect1 id="description">
116
110
    <title>DESCRIPTION</title>
117
111
    <para>
118
112
      <command>&COMMANDNAME;</command> is a server daemon which
119
113
      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.
 
114
      client host computers.  The Mandos server uses Zeroconf to
 
115
      announce itself on the local network, and uses GnuTLS to
 
116
      communicate securely with and to authenticate the clients.
 
117
      Mandos uses IPv6 link-local addresses, since the clients are
 
118
      assumed to not have any other addresses configured yet.  Any
 
119
      authenticated client is then given the pre-encrypted password
 
120
      for that specific client.
130
121
    </para>
131
 
  </refsect1>
 
122
 
 
123
  </refsect1>  
132
124
  
133
125
  <refsect1 id="purpose">
134
126
    <title>PURPOSE</title>
 
127
 
135
128
    <para>
136
129
      The purpose of this is to enable <emphasis>remote and unattended
137
 
      rebooting</emphasis> of client host computer with an
138
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
139
 
      linkend="overview"/> for details.
 
130
      rebooting</emphasis> of any client host computer with an
 
131
      <emphasis>encrypted root file system</emphasis>.  The client
 
132
      host computer should start a Mandos client in the initial RAM
 
133
      disk environment, the Mandos client program communicates with
 
134
      this server program to get an encrypted password, which is then
 
135
      decrypted and used to unlock the encrypted root file system.
 
136
      The client host computer can then continue its boot sequence
 
137
      normally.
140
138
    </para>
141
 
  </refsect1>
 
139
 
 
140
  </refsect1>  
142
141
  
143
142
  <refsect1 id="options">
144
143
    <title>OPTIONS</title>
 
144
 
145
145
    <variablelist>
146
146
      <varlistentry>
147
 
        <term><option>--help</option></term>
148
 
        <term><option>-h</option></term>
 
147
        <term><literal>-h</literal>, <literal>--help</literal></term>
149
148
        <listitem>
150
149
          <para>
151
150
            Show a help message and exit
152
151
          </para>
153
152
        </listitem>
154
153
      </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>
188
 
        <listitem>
189
 
          <para>
190
 
            Run the server’s self-tests.  This includes any unit
 
154
 
 
155
      <varlistentry>
 
156
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
157
        IF</replaceable></literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Only announce the server and listen to requests on network
 
161
            interface <replaceable>IF</replaceable>.  Default is to
 
162
            use all available interfaces.
 
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
            "<literal>::FFFF:192.0.2.3</literal>" syntax.  Also, if a
 
176
            link-local address is specified, an interface should be
 
177
            set, since a link-local address is only valid on a single
 
178
            interface.  By default, the server will listen to all
 
179
            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>
 
198
        <listitem>
 
199
          <para>
 
200
            Run the server's self-tests.  This includes any unit
191
201
            tests, etc.
192
202
          </para>
193
203
        </listitem>
194
 
      </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>
 
204
      </varlistentry>      
 
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.  See
 
224
            <citerefentry><refentrytitle>gnutls_priority_init
 
225
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
226
            for the syntax.  The default is
 
227
            "<literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal>".
 
228
            <emphasis>Warning</emphasis>: changing this may make the
 
229
            TLS handshake fail, making communication with clients
 
230
            impossible.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>      
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
237
        </literal></term>
 
238
        <listitem>
 
239
          <para>
 
240
            Zeroconf service name.  The default is
 
241
            "<literal>Mandos</literal>".  You only need to change this
 
242
            if you for some reason want to run more than one server on
 
243
            the same <emphasis>host</emphasis>.  If there are name
 
244
            collisions on the same <emphasis>network</emphasis>, the
 
245
            new server will automatically rename itself to "Mandos
 
246
            #2", etc.
 
247
          </para>
 
248
        </listitem>
 
249
      </varlistentry>     
 
250
 
 
251
      <varlistentry>
 
252
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
253
        </literal></term>
241
254
        <listitem>
242
255
          <para>
243
256
            Directory to search for configuration files.  Default is
244
 
            <quote><literal>/etc/mandos</literal></quote>.  See
245
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
257
            "<literal>/etc/mandos</literal>".  See <citerefentry>
 
258
            <refentrytitle>mandos.conf</refentrytitle>
246
259
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
247
260
            <refentrytitle>mandos-clients.conf</refentrytitle>
248
261
            <manvolnum>5</manvolnum></citerefentry>.
249
262
          </para>
250
263
        </listitem>
251
264
      </varlistentry>
252
 
      
 
265
 
253
266
      <varlistentry>
254
 
        <term><option>--version</option></term>
 
267
        <term><literal>--version</literal></term>
255
268
        <listitem>
256
269
          <para>
257
270
            Prints the program version and exit.
258
271
          </para>
259
272
        </listitem>
260
 
      </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>
 
273
      </varlistentry>      
278
274
    </variablelist>
279
275
  </refsect1>
280
 
  
281
 
  <refsect1 id="overview">
282
 
    <title>OVERVIEW</title>
283
 
    <xi:include href="overview.xml"/>
284
 
    <para>
285
 
      This program is the server part.  It is a normal server program
286
 
      and will run in a normal system environment, not in an initial
287
 
      <acronym>RAM</acronym> disk environment.
288
 
    </para>
289
 
  </refsect1>
290
 
  
 
276
 
291
277
  <refsect1 id="protocol">
292
278
    <title>NETWORK PROTOCOL</title>
293
279
    <para>
294
280
      The Mandos server announces itself as a Zeroconf service of type
295
 
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
296
 
      client connects to the announced address and port, and sends a
297
 
      line of text where the first whitespace-separated field is the
298
 
      protocol version, which currently is
299
 
      <quote><literal>1</literal></quote>.  The client and server then
300
 
      start a TLS protocol handshake with a slight quirk: the Mandos
301
 
      server program acts as a TLS <quote>client</quote> while the
302
 
      connecting Mandos client acts as a TLS <quote>server</quote>.
303
 
      The Mandos client must supply an OpenPGP certificate, and the
304
 
      fingerprint of this certificate is used by the Mandos server to
305
 
      look up (in a list read from <filename>clients.conf</filename>
306
 
      at start time) which binary blob to give the client.  No other
307
 
      authentication or authorization is done by the server.
 
281
      "<literal>_mandos._tcp</literal>".  The Mandos client connects
 
282
      to the announced address and port, and sends a line of text
 
283
      where the first whitespace-separated field is the protocol
 
284
      version, which currently is "<literal>1</literal>".  The client
 
285
      and server then start a TLS protocol handshake with a slight
 
286
      quirk: the Mandos server program acts as a TLS "client" while
 
287
      the connecting Mandos client acts as a TLS "server".  The Mandos
 
288
      client must supply an OpenPGP certificate, and the fingerprint
 
289
      of this certificate is used by the Mandos server to look up (in
 
290
      a list read from a file at start time) which binary blob to give
 
291
      the client.  No other authentication or authorization is done by
 
292
      the server.
308
293
    </para>
309
 
    <table>
310
 
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
 
294
    <informaltable><tgroup cols="3"><thead>
311
295
      <row>
312
296
        <entry>Mandos Client</entry>
313
297
        <entry>Direction</entry>
319
303
        <entry>-><!-- &rarr; --></entry>
320
304
      </row>
321
305
      <row>
322
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
306
        <entry>"<literal>1\r\en</literal>"</entry>
323
307
        <entry>-><!-- &rarr; --></entry>
324
308
      </row>
325
309
      <row>
326
 
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
327
 
        </emphasis></entry>
 
310
        <entry>TLS handshake</entry>
328
311
        <entry>&lt;-><!-- &xharr; --></entry>
329
 
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
330
 
        </emphasis></entry>
 
312
        <entry>TLS handshake</entry>
331
313
      </row>
332
314
      <row>
333
315
        <entry>OpenPGP public key (part of TLS handshake)</entry>
336
318
      <row>
337
319
        <entry/>
338
320
        <entry>&lt;-<!-- &larr; --></entry>
339
 
        <entry>Binary blob (client will assume OpenPGP data)</entry>
 
321
        <entry>Binary blob</entry>
340
322
      </row>
341
323
      <row>
342
324
        <entry/>
343
325
        <entry>&lt;-<!-- &larr; --></entry>
344
326
        <entry>Close</entry>
345
327
      </row>
346
 
    </tbody></tgroup></table>
347
 
  </refsect1>
348
 
  
349
 
  <refsect1 id="checking">
350
 
    <title>CHECKING</title>
351
 
    <para>
352
 
      The server will, by default, continually check that the clients
353
 
      are still up.  If a client has not been confirmed as being up
354
 
      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>
373
 
      <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
 
    
384
 
  </refsect1>
385
 
  
 
328
    </tbody></tgroup></informaltable>
 
329
  </refsect1>
 
330
 
386
331
  <refsect1 id="logging">
387
332
    <title>LOGGING</title>
388
333
    <para>
389
 
      The server will send log message with various severity levels to
390
 
      <filename>/dev/log</filename>.  With the
 
334
      The server will log a lot of information with various severity
 
335
      levels to
 
336
      <citerefentry><refentrytitle>syslog</refentrytitle>
 
337
      <manvolnum>8</manvolnum></citerefentry>.  With the
391
338
      <option>--debug</option> option, it will log even more messages,
392
339
      and also show them on the console.
393
340
    </para>
394
341
  </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
 
  
 
342
 
406
343
  <refsect1 id="exit_status">
407
344
    <title>EXIT STATUS</title>
408
345
    <para>
410
347
      critical error is encountered.
411
348
    </para>
412
349
  </refsect1>
413
 
  
414
 
  <refsect1 id="environment">
415
 
    <title>ENVIRONMENT</title>
416
 
    <variablelist>
417
 
      <varlistentry>
418
 
        <term><envar>PATH</envar></term>
419
 
        <listitem>
420
 
          <para>
421
 
            To start the configured checker (see <xref
422
 
            linkend="checking"/>), the server uses
423
 
            <filename>/bin/sh</filename>, which in turn uses
424
 
            <varname>PATH</varname> to search for matching commands if
425
 
            an absolute path is not given.  See <citerefentry>
426
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
427
 
            </citerefentry>.
428
 
          </para>
429
 
        </listitem>
430
 
      </varlistentry>
431
 
    </variablelist>
432
 
  </refsect1>
433
 
  
434
 
  <refsect1 id="files">
 
350
 
 
351
  <refsect1 id="file">
435
352
    <title>FILES</title>
436
353
    <para>
437
 
      Use the <option>--configdir</option> option to change where
438
 
      <command>&COMMANDNAME;</command> looks for its configurations
439
 
      files.  The default file names are listed here.
 
354
      <itemizedlist>
 
355
        <listitem><para>
 
356
          <filename>/etc/mandos/mandos.conf</filename>  See <citerefentry>
 
357
            <refentrytitle>mandos.conf</refentrytitle>
 
358
            <manvolnum>5</manvolnum></citerefentry>.
 
359
        </para></listitem>
 
360
        <listitem><para>
 
361
          <filename>/etc/mandos/clients.conf</filename> See <citerefentry>
 
362
            <refentrytitle>mandos-clients.conf</refentrytitle>
 
363
            <manvolnum>5</manvolnum></citerefentry>.
 
364
        </para></listitem>
 
365
        <listitem><para>
 
366
          <filename>/var/run/mandos/mandos.pid</filename>
 
367
        </para></listitem>
 
368
      </itemizedlist>
440
369
    </para>
441
 
    <variablelist>
442
 
      <varlistentry>
443
 
        <term><filename>/etc/mandos/mandos.conf</filename></term>
444
 
        <listitem>
445
 
          <para>
446
 
            Server-global settings.  See
447
 
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
448
 
            <manvolnum>5</manvolnum></citerefentry> for details.
449
 
          </para>
450
 
        </listitem>
451
 
      </varlistentry>
452
 
      <varlistentry>
453
 
        <term><filename>/etc/mandos/clients.conf</filename></term>
454
 
        <listitem>
455
 
          <para>
456
 
            List of clients and client-specific settings.  See
457
 
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
458
 
            <manvolnum>5</manvolnum></citerefentry> for details.
459
 
          </para>
460
 
        </listitem>
461
 
      </varlistentry>
462
 
      <varlistentry>
463
 
        <term><filename>/var/run/mandos.pid</filename></term>
464
 
        <listitem>
465
 
          <para>
466
 
            The file containing the process id of the
467
 
            <command>&COMMANDNAME;</command> process started last.
468
 
          </para>
469
 
        </listitem>
470
 
      </varlistentry>
471
 
      <varlistentry>
472
 
        <term><filename>/dev/log</filename></term>
473
 
        <listitem>
474
 
          <para>
475
 
            The Unix domain socket to where local syslog messages are
476
 
            sent.
477
 
          </para>
478
 
        </listitem>
479
 
      </varlistentry>
480
 
      <varlistentry>
481
 
        <term><filename>/bin/sh</filename></term>
482
 
        <listitem>
483
 
          <para>
484
 
            This is used to start the configured checker command for
485
 
            each client.  See <citerefentry>
486
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
487
 
            <manvolnum>5</manvolnum></citerefentry> for details.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
    </variablelist>
492
 
  </refsect1>
493
 
  
 
370
  </refsect1>  
 
371
 
494
372
  <refsect1 id="bugs">
495
373
    <title>BUGS</title>
496
374
    <para>
497
 
      This server might, on especially fatal errors, emit a Python
498
 
      backtrace.  This could be considered a feature.
499
 
    </para>
500
 
    <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"/>.
504
 
    </para>
505
 
    <para>
506
 
      There is no fine-grained control over logging and debug output.
507
 
    </para>
508
 
    <para>
509
 
      Debug mode is conflated with running in the foreground.
510
 
    </para>
511
 
    <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.
517
 
    </para>
518
 
  </refsect1>
519
 
  
520
 
  <refsect1 id="example">
521
 
    <title>EXAMPLE</title>
522
 
    <informalexample>
523
 
      <para>
524
 
        Normal invocation needs no options:
525
 
      </para>
526
 
      <para>
527
 
        <userinput>&COMMANDNAME;</userinput>
528
 
      </para>
529
 
    </informalexample>
530
 
    <informalexample>
531
 
      <para>
532
 
        Run the server in debug mode, read configuration files from
533
 
        the <filename>~/mandos</filename> directory, and use the
534
 
        Zeroconf service name <quote>Test</quote> to not collide with
535
 
        any other official Mandos server on this host:
536
 
      </para>
537
 
      <para>
538
 
 
539
 
<!-- do not wrap this line -->
540
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
541
 
 
542
 
      </para>
543
 
    </informalexample>
544
 
    <informalexample>
545
 
      <para>
546
 
        Run the server normally, but only listen to one interface and
547
 
        only on the link-local address on that interface:
548
 
      </para>
549
 
      <para>
550
 
 
551
 
<!-- do not wrap this line -->
552
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
553
 
 
554
 
      </para>
555
 
    </informalexample>
556
 
  </refsect1>
557
 
  
 
375
    </para>
 
376
  </refsect1>  
 
377
 
 
378
  <refsect1 id="examples">
 
379
    <title>EXAMPLES</title>
 
380
    <para>
 
381
    </para>
 
382
  </refsect1>
 
383
 
558
384
  <refsect1 id="security">
559
385
    <title>SECURITY</title>
560
 
    <refsect2 id="server">
561
 
      <title>SERVER</title>
562
 
      <para>
563
 
        Running this <command>&COMMANDNAME;</command> server program
564
 
        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.
567
 
      </para>
568
 
    </refsect2>
569
 
    <refsect2 id="clients">
570
 
      <title>CLIENTS</title>
571
 
      <para>
572
 
        The server only gives out its stored data to clients which
573
 
        does have the OpenPGP key of the stored fingerprint.  This is
574
 
        guaranteed by the fact that the client sends its OpenPGP
575
 
        public key in the TLS handshake; this ensures it to be
576
 
        genuine.  The server computes the fingerprint of the key
577
 
        itself and looks up the fingerprint in its list of
578
 
        clients. The <filename>clients.conf</filename> file (see
579
 
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
580
 
        <manvolnum>5</manvolnum></citerefentry>)
581
 
        <emphasis>must</emphasis> be made non-readable by anyone
582
 
        except the user starting the server (usually root).
583
 
      </para>
584
 
      <para>
585
 
        As detailed in <xref linkend="checking"/>, the status of all
586
 
        client computers will continually be checked and be assumed
587
 
        compromised if they are gone for too long.
588
 
      </para>
589
 
      <para>
590
 
        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.
603
 
      </para>
604
 
      <para>
605
 
        For more details on client-side security, see
606
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
607
 
        <manvolnum>8mandos</manvolnum></citerefentry>.
608
 
      </para>
609
 
    </refsect2>
 
386
    <para>
 
387
    </para>
610
388
  </refsect1>
611
 
  
 
389
 
612
390
  <refsect1 id="see_also">
613
391
    <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
 
    <variablelist>
627
 
      <varlistentry>
628
 
        <term>
629
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
630
 
        </term>
631
 
        <listitem>
632
 
          <para>
633
 
            Zeroconf is the network protocol standard used by clients
634
 
            for finding this Mandos server on the local network.
635
 
          </para>
636
 
        </listitem>
637
 
      </varlistentry>
638
 
      <varlistentry>
639
 
        <term>
640
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
641
 
        </term>
642
 
      <listitem>
643
 
        <para>
644
 
          Avahi is the library this server calls to implement
645
 
          Zeroconf service announcements.
646
 
        </para>
647
 
      </listitem>
648
 
      </varlistentry>
649
 
      <varlistentry>
650
 
        <term>
651
 
          <ulink url="http://www.gnu.org/software/gnutls/"
652
 
          >GnuTLS</ulink>
653
 
        </term>
654
 
      <listitem>
655
 
        <para>
656
 
          GnuTLS is the library this server uses to implement TLS for
657
 
          communicating securely with the client, and at the same time
658
 
          confidently get the client’s public OpenPGP key.
659
 
        </para>
660
 
      </listitem>
661
 
      </varlistentry>
662
 
      <varlistentry>
663
 
        <term>
664
 
          RFC 4291: <citetitle>IP Version 6 Addressing
665
 
          Architecture</citetitle>
666
 
        </term>
667
 
        <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>
692
 
        </listitem>
693
 
      </varlistentry>
694
 
      <varlistentry>
695
 
        <term>
696
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
697
 
          Protocol Version 1.1</citetitle>
698
 
        </term>
699
 
      <listitem>
700
 
        <para>
701
 
          TLS 1.1 is the protocol implemented by GnuTLS.
702
 
        </para>
703
 
      </listitem>
704
 
      </varlistentry>
705
 
      <varlistentry>
706
 
        <term>
707
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
708
 
        </term>
709
 
      <listitem>
710
 
        <para>
711
 
          The data sent to clients is binary encrypted OpenPGP data.
712
 
        </para>
713
 
      </listitem>
714
 
      </varlistentry>
715
 
      <varlistentry>
716
 
        <term>
717
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
718
 
          Security</citetitle>
719
 
        </term>
720
 
      <listitem>
721
 
        <para>
722
 
          This is implemented by GnuTLS and used by this server so
723
 
          that OpenPGP keys can be used.
724
 
        </para>
725
 
      </listitem>
726
 
      </varlistentry>
727
 
    </variablelist>
 
392
    <itemizedlist spacing="compact">
 
393
      <listitem><para>
 
394
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
395
        <manvolnum>8mandos</manvolnum></citerefentry>
 
396
      </para></listitem>
 
397
      
 
398
      <listitem><para>
 
399
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
400
        <manvolnum>8mandos</manvolnum></citerefentry>
 
401
      </para></listitem>
 
402
      
 
403
      <listitem><para>
 
404
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
405
      </para></listitem>
 
406
      
 
407
      <listitem><para>
 
408
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
409
      </para></listitem>
 
410
      
 
411
      <listitem><para>
 
412
        <ulink
 
413
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
414
      </para></listitem>
 
415
      
 
416
      <listitem><para>
 
417
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
418
        Format</citetitle></citation>
 
419
      </para></listitem>
 
420
      
 
421
      <listitem><para>
 
422
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
423
        Transport Layer Security</citetitle></citation>
 
424
      </para></listitem>
 
425
      
 
426
      <listitem><para>
 
427
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
428
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
429
        Unicast Addresses</citation>
 
430
      </para></listitem>
 
431
    </itemizedlist>
728
432
  </refsect1>
729
433
</refentry>
730
 
<!-- Local Variables: -->
731
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
732
 
<!-- time-stamp-end: "[\"']>" -->
733
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
734
 
<!-- End: -->