/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: 2011-12-28 07:25:59 UTC
  • Revision ID: teddy@recompile.se-20111228072559-u9no7ozprpr28j6k
* mandos (PGPEngine.__init__): Add "--no-use-agent" to gpg options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
 
<!ENTITY VERSION "1.0">
 
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
7
4
<!ENTITY COMMANDNAME "mandos">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
8
8
]>
9
9
 
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>
 
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>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
60
42
  </refentryinfo>
61
 
 
 
43
  
62
44
  <refmeta>
63
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
    <manvolnum>8</manvolnum>
67
49
  <refnamediv>
68
50
    <refname><command>&COMMANDNAME;</command></refname>
69
51
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
52
      Gives encrypted passwords to authenticated Mandos clients
71
53
    </refpurpose>
72
54
  </refnamediv>
73
 
 
 
55
  
74
56
  <refsynopsisdiv>
75
57
    <cmdsynopsis>
76
58
      <command>&COMMANDNAME;</command>
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>    
 
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
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--statedir
 
101
      <replaceable>DIRECTORY</replaceable></option></arg>
 
102
    </cmdsynopsis>
 
103
    <cmdsynopsis>
 
104
      <command>&COMMANDNAME;</command>
 
105
      <group choice="req">
 
106
        <arg choice="plain"><option>--help</option></arg>
 
107
        <arg choice="plain"><option>-h</option></arg>
 
108
      </group>
 
109
    </cmdsynopsis>
 
110
    <cmdsynopsis>
 
111
      <command>&COMMANDNAME;</command>
 
112
      <arg choice="plain"><option>--version</option></arg>
 
113
    </cmdsynopsis>
 
114
    <cmdsynopsis>
 
115
      <command>&COMMANDNAME;</command>
 
116
      <arg choice="plain"><option>--check</option></arg>
 
117
    </cmdsynopsis>
107
118
  </refsynopsisdiv>
108
 
 
 
119
  
109
120
  <refsect1 id="description">
110
121
    <title>DESCRIPTION</title>
111
122
    <para>
112
123
      <command>&COMMANDNAME;</command> is a server daemon which
113
124
      handles incoming request for passwords for a pre-defined list of
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.
 
125
      client host computers. For an introduction, see
 
126
      <citerefentry><refentrytitle>intro</refentrytitle>
 
127
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
128
      uses Zeroconf to announce itself on the local network, and uses
 
129
      TLS to communicate securely with and to authenticate the
 
130
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
131
      use IPv6 link-local addresses, since the clients will probably
 
132
      not have any other addresses configured (see <xref
 
133
      linkend="overview"/>).  Any authenticated client is then given
 
134
      the stored pre-encrypted password for that specific client.
121
135
    </para>
122
 
 
123
 
  </refsect1>  
 
136
  </refsect1>
124
137
  
125
138
  <refsect1 id="purpose">
126
139
    <title>PURPOSE</title>
127
 
 
128
140
    <para>
129
141
      The purpose of this is to enable <emphasis>remote and unattended
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.
 
142
      rebooting</emphasis> of client host computer with an
 
143
      <emphasis>encrypted root file system</emphasis>.  See <xref
 
144
      linkend="overview"/> for details.
138
145
    </para>
139
 
 
140
 
  </refsect1>  
 
146
  </refsect1>
141
147
  
142
148
  <refsect1 id="options">
143
149
    <title>OPTIONS</title>
144
 
 
145
150
    <variablelist>
146
151
      <varlistentry>
147
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
152
        <term><option>--help</option></term>
 
153
        <term><option>-h</option></term>
148
154
        <listitem>
149
155
          <para>
150
156
            Show a help message and exit
151
157
          </para>
152
158
        </listitem>
153
159
      </varlistentry>
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
 
160
      
 
161
      <varlistentry>
 
162
        <term><option>--interface</option>
 
163
        <replaceable>NAME</replaceable></term>
 
164
        <term><option>-i</option>
 
165
        <replaceable>NAME</replaceable></term>
 
166
        <listitem>
 
167
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
168
        </listitem>
 
169
      </varlistentry>
 
170
      
 
171
      <varlistentry>
 
172
        <term><option>--address
 
173
        <replaceable>ADDRESS</replaceable></option></term>
 
174
        <term><option>-a
 
175
        <replaceable>ADDRESS</replaceable></option></term>
 
176
        <listitem>
 
177
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
178
        </listitem>
 
179
      </varlistentry>
 
180
      
 
181
      <varlistentry>
 
182
        <term><option>--port
 
183
        <replaceable>PORT</replaceable></option></term>
 
184
        <term><option>-p
 
185
        <replaceable>PORT</replaceable></option></term>
 
186
        <listitem>
 
187
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
188
        </listitem>
 
189
      </varlistentry>
 
190
      
 
191
      <varlistentry>
 
192
        <term><option>--check</option></term>
 
193
        <listitem>
 
194
          <para>
 
195
            Run the server’s self-tests.  This includes any unit
201
196
            tests, etc.
202
197
          </para>
203
198
        </listitem>
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>
 
199
      </varlistentry>
 
200
      
 
201
      <varlistentry>
 
202
        <term><option>--debug</option></term>
 
203
        <listitem>
 
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
 
209
        <term><option>--debuglevel
 
210
        <replaceable>LEVEL</replaceable></option></term>
 
211
        <listitem>
 
212
          <para>
 
213
            Set the debugging log level.
 
214
            <replaceable>LEVEL</replaceable> is a string, one of
 
215
            <quote><literal>CRITICAL</literal></quote>,
 
216
            <quote><literal>ERROR</literal></quote>,
 
217
            <quote><literal>WARNING</literal></quote>,
 
218
            <quote><literal>INFO</literal></quote>, or
 
219
            <quote><literal>DEBUG</literal></quote>, in order of
 
220
            increasing verbosity.  The default level is
 
221
            <quote><literal>WARNING</literal></quote>.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
      
 
226
      <varlistentry>
 
227
        <term><option>--priority <replaceable>
 
228
        PRIORITY</replaceable></option></term>
 
229
        <listitem>
 
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
231
        </listitem>
 
232
      </varlistentry>
 
233
      
 
234
      <varlistentry>
 
235
        <term><option>--servicename
 
236
        <replaceable>NAME</replaceable></option></term>
 
237
        <listitem>
 
238
          <xi:include href="mandos-options.xml"
 
239
                      xpointer="servicename"/>
 
240
        </listitem>
 
241
      </varlistentry>
 
242
      
 
243
      <varlistentry>
 
244
        <term><option>--configdir
 
245
        <replaceable>DIRECTORY</replaceable></option></term>
254
246
        <listitem>
255
247
          <para>
256
248
            Directory to search for configuration files.  Default is
257
 
            "<literal>/etc/mandos</literal>".  See <citerefentry>
258
 
            <refentrytitle>mandos.conf</refentrytitle>
 
249
            <quote><literal>/etc/mandos</literal></quote>.  See
 
250
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
259
251
            <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
260
252
            <refentrytitle>mandos-clients.conf</refentrytitle>
261
253
            <manvolnum>5</manvolnum></citerefentry>.
262
254
          </para>
263
255
        </listitem>
264
256
      </varlistentry>
265
 
 
 
257
      
266
258
      <varlistentry>
267
 
        <term><literal>--version</literal></term>
 
259
        <term><option>--version</option></term>
268
260
        <listitem>
269
261
          <para>
270
262
            Prints the program version and exit.
271
263
          </para>
272
264
        </listitem>
273
 
      </varlistentry>      
 
265
      </varlistentry>
 
266
      
 
267
      <varlistentry>
 
268
        <term><option>--no-dbus</option></term>
 
269
        <listitem>
 
270
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
271
          <para>
 
272
            See also <xref linkend="dbus_interface"/>.
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--no-ipv6</option></term>
 
279
        <listitem>
 
280
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-restore</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--statedir
 
293
        <replaceable>DIRECTORY</replaceable></option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
296
        </listitem>
 
297
      </varlistentry>
274
298
    </variablelist>
275
299
  </refsect1>
276
 
 
 
300
  
 
301
  <refsect1 id="overview">
 
302
    <title>OVERVIEW</title>
 
303
    <xi:include href="overview.xml"/>
 
304
    <para>
 
305
      This program is the server part.  It is a normal server program
 
306
      and will run in a normal system environment, not in an initial
 
307
      <acronym>RAM</acronym> disk environment.
 
308
    </para>
 
309
  </refsect1>
 
310
  
277
311
  <refsect1 id="protocol">
278
312
    <title>NETWORK PROTOCOL</title>
279
313
    <para>
280
314
      The Mandos server announces itself as a Zeroconf service of type
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.
 
315
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
 
316
      client connects to the announced address and port, and sends a
 
317
      line of text where the first whitespace-separated field is the
 
318
      protocol version, which currently is
 
319
      <quote><literal>1</literal></quote>.  The client and server then
 
320
      start a TLS protocol handshake with a slight quirk: the Mandos
 
321
      server program acts as a TLS <quote>client</quote> while the
 
322
      connecting Mandos client acts as a TLS <quote>server</quote>.
 
323
      The Mandos client must supply an OpenPGP certificate, and the
 
324
      fingerprint of this certificate is used by the Mandos server to
 
325
      look up (in a list read from <filename>clients.conf</filename>
 
326
      at start time) which binary blob to give the client.  No other
 
327
      authentication or authorization is done by the server.
293
328
    </para>
294
 
    <informaltable><tgroup cols="3"><thead>
 
329
    <table>
 
330
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
295
331
      <row>
296
332
        <entry>Mandos Client</entry>
297
333
        <entry>Direction</entry>
303
339
        <entry>-><!-- &rarr; --></entry>
304
340
      </row>
305
341
      <row>
306
 
        <entry>"<literal>1\r\en</literal>"</entry>
 
342
        <entry><quote><literal>1\r\n</literal></quote></entry>
307
343
        <entry>-><!-- &rarr; --></entry>
308
344
      </row>
309
345
      <row>
310
 
        <entry>TLS handshake</entry>
 
346
        <entry>TLS handshake <emphasis>as TLS <quote>server</quote>
 
347
        </emphasis></entry>
311
348
        <entry>&lt;-><!-- &xharr; --></entry>
312
 
        <entry>TLS handshake</entry>
 
349
        <entry>TLS handshake <emphasis>as TLS <quote>client</quote>
 
350
        </emphasis></entry>
313
351
      </row>
314
352
      <row>
315
353
        <entry>OpenPGP public key (part of TLS handshake)</entry>
318
356
      <row>
319
357
        <entry/>
320
358
        <entry>&lt;-<!-- &larr; --></entry>
321
 
        <entry>Binary blob</entry>
 
359
        <entry>Binary blob (client will assume OpenPGP data)</entry>
322
360
      </row>
323
361
      <row>
324
362
        <entry/>
325
363
        <entry>&lt;-<!-- &larr; --></entry>
326
364
        <entry>Close</entry>
327
365
      </row>
328
 
    </tbody></tgroup></informaltable>
329
 
  </refsect1>
330
 
 
 
366
    </tbody></tgroup></table>
 
367
  </refsect1>
 
368
  
 
369
  <refsect1 id="checking">
 
370
    <title>CHECKING</title>
 
371
    <para>
 
372
      The server will, by default, continually check that the clients
 
373
      are still up.  If a client has not been confirmed as being up
 
374
      for some time, the client is assumed to be compromised and is no
 
375
      longer eligible to receive the encrypted password.  (Manual
 
376
      intervention is required to re-enable a client.)  The timeout,
 
377
      extended timeout, checker program, and interval between checks
 
378
      can be configured both globally and per client; see
 
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
 
383
    </para>
 
384
  </refsect1>
 
385
  
 
386
  <refsect1 id="approval">
 
387
    <title>APPROVAL</title>
 
388
    <para>
 
389
      The server can be configured to require manual approval for a
 
390
      client before it is sent its secret.  The delay to wait for such
 
391
      approval and the default action (approve or deny) can be
 
392
      configured both globally and per client; see <citerefentry>
 
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
394
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
395
      will be approved immediately without delay.
 
396
    </para>
 
397
    <para>
 
398
      This can be used to deny a client its secret if not manually
 
399
      approved within a specified time.  It can also be used to make
 
400
      the server delay before giving a client its secret, allowing
 
401
      optional manual denying of this specific client.
 
402
    </para>
 
403
    
 
404
  </refsect1>
 
405
  
331
406
  <refsect1 id="logging">
332
407
    <title>LOGGING</title>
333
408
    <para>
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
 
409
      The server will send log message with various severity levels to
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
338
411
      <option>--debug</option> option, it will log even more messages,
339
412
      and also show them on the console.
340
413
    </para>
341
414
  </refsect1>
342
 
 
 
415
  
 
416
  <refsect1 id="dbus_interface">
 
417
    <title>D-BUS INTERFACE</title>
 
418
    <para>
 
419
      The server will by default provide a D-Bus system bus interface.
 
420
      This interface will only be accessible by the root user or a
 
421
      Mandos-specific user, if such a user exists.  For documentation
 
422
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
423
    </para>
 
424
  </refsect1>
 
425
  
343
426
  <refsect1 id="exit_status">
344
427
    <title>EXIT STATUS</title>
345
428
    <para>
347
430
      critical error is encountered.
348
431
    </para>
349
432
  </refsect1>
350
 
 
351
 
  <refsect1 id="file">
 
433
  
 
434
  <refsect1 id="environment">
 
435
    <title>ENVIRONMENT</title>
 
436
    <variablelist>
 
437
      <varlistentry>
 
438
        <term><envar>PATH</envar></term>
 
439
        <listitem>
 
440
          <para>
 
441
            To start the configured checker (see <xref
 
442
            linkend="checking"/>), the server uses
 
443
            <filename>/bin/sh</filename>, which in turn uses
 
444
            <varname>PATH</varname> to search for matching commands if
 
445
            an absolute path is not given.  See <citerefentry>
 
446
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
447
            </citerefentry>.
 
448
          </para>
 
449
        </listitem>
 
450
      </varlistentry>
 
451
    </variablelist>
 
452
  </refsect1>
 
453
  
 
454
  <refsect1 id="files">
352
455
    <title>FILES</title>
353
456
    <para>
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>
 
457
      Use the <option>--configdir</option> option to change where
 
458
      <command>&COMMANDNAME;</command> looks for its configurations
 
459
      files.  The default file names are listed here.
 
460
    </para>
 
461
    <variablelist>
 
462
      <varlistentry>
 
463
        <term><filename>/etc/mandos/mandos.conf</filename></term>
 
464
        <listitem>
 
465
          <para>
 
466
            Server-global settings.  See
 
467
            <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
468
            <manvolnum>5</manvolnum></citerefentry> for details.
 
469
          </para>
 
470
        </listitem>
 
471
      </varlistentry>
 
472
      <varlistentry>
 
473
        <term><filename>/etc/mandos/clients.conf</filename></term>
 
474
        <listitem>
 
475
          <para>
 
476
            List of clients and client-specific settings.  See
 
477
            <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
478
            <manvolnum>5</manvolnum></citerefentry> for details.
 
479
          </para>
 
480
        </listitem>
 
481
      </varlistentry>
 
482
      <varlistentry>
 
483
        <term><filename>/var/run/mandos.pid</filename></term>
 
484
        <listitem>
 
485
          <para>
 
486
            The file containing the process id of the
 
487
            <command>&COMMANDNAME;</command> process started last.
 
488
          </para>
 
489
        </listitem>
 
490
      </varlistentry>
 
491
      <varlistentry>
 
492
        <term><filename class="devicefile">/dev/log</filename></term>
 
493
      </varlistentry>
 
494
      <varlistentry>
 
495
        <term><filename
 
496
        class="directory">/var/lib/mandos</filename></term>
 
497
        <listitem>
 
498
          <para>
 
499
            Directory where persistent state will be saved.  Change
 
500
            this with the <option>--statedir</option> option.  See
 
501
            also the <option>--no-restore</option> option.
 
502
          </para>
 
503
        </listitem>
 
504
      </varlistentry>
 
505
      <varlistentry>
 
506
        <term><filename>/dev/log</filename></term>
 
507
        <listitem>
 
508
          <para>
 
509
            The Unix domain socket to where local syslog messages are
 
510
            sent.
 
511
          </para>
 
512
        </listitem>
 
513
      </varlistentry>
 
514
      <varlistentry>
 
515
        <term><filename>/bin/sh</filename></term>
 
516
        <listitem>
 
517
          <para>
 
518
            This is used to start the configured checker command for
 
519
            each client.  See <citerefentry>
362
520
            <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>
369
 
    </para>
370
 
  </refsect1>  
371
 
 
 
521
            <manvolnum>5</manvolnum></citerefentry> for details.
 
522
          </para>
 
523
        </listitem>
 
524
      </varlistentry>
 
525
    </variablelist>
 
526
  </refsect1>
 
527
  
372
528
  <refsect1 id="bugs">
373
529
    <title>BUGS</title>
374
530
    <para>
375
 
    </para>
376
 
  </refsect1>  
377
 
 
378
 
  <refsect1 id="examples">
379
 
    <title>EXAMPLES</title>
380
 
    <para>
381
 
    </para>
382
 
  </refsect1>
383
 
 
 
531
      This server might, on especially fatal errors, emit a Python
 
532
      backtrace.  This could be considered a feature.
 
533
    </para>
 
534
    <para>
 
535
      There is no fine-grained control over logging and debug output.
 
536
    </para>
 
537
    <para>
 
538
      Debug mode is conflated with running in the foreground.
 
539
    </para>
 
540
    <para>
 
541
      This server does not check the expire time of clients’ OpenPGP
 
542
      keys.
 
543
    </para>
 
544
  </refsect1>
 
545
  
 
546
  <refsect1 id="example">
 
547
    <title>EXAMPLE</title>
 
548
    <informalexample>
 
549
      <para>
 
550
        Normal invocation needs no options:
 
551
      </para>
 
552
      <para>
 
553
        <userinput>&COMMANDNAME;</userinput>
 
554
      </para>
 
555
    </informalexample>
 
556
    <informalexample>
 
557
      <para>
 
558
        Run the server in debug mode, read configuration files from
 
559
        the <filename class="directory">~/mandos</filename> directory,
 
560
        and use the Zeroconf service name <quote>Test</quote> to not
 
561
        collide with any other official Mandos server on this host:
 
562
      </para>
 
563
      <para>
 
564
 
 
565
<!-- do not wrap this line -->
 
566
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
567
 
 
568
      </para>
 
569
    </informalexample>
 
570
    <informalexample>
 
571
      <para>
 
572
        Run the server normally, but only listen to one interface and
 
573
        only on the link-local address on that interface:
 
574
      </para>
 
575
      <para>
 
576
 
 
577
<!-- do not wrap this line -->
 
578
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
579
 
 
580
      </para>
 
581
    </informalexample>
 
582
  </refsect1>
 
583
  
384
584
  <refsect1 id="security">
385
585
    <title>SECURITY</title>
386
 
    <para>
387
 
    </para>
 
586
    <refsect2 id="server">
 
587
      <title>SERVER</title>
 
588
      <para>
 
589
        Running this <command>&COMMANDNAME;</command> server program
 
590
        should not in itself present any security risk to the host
 
591
        computer running it.  The program switches to a non-root user
 
592
        soon after startup.
 
593
      </para>
 
594
    </refsect2>
 
595
    <refsect2 id="clients">
 
596
      <title>CLIENTS</title>
 
597
      <para>
 
598
        The server only gives out its stored data to clients which
 
599
        does have the OpenPGP key of the stored fingerprint.  This is
 
600
        guaranteed by the fact that the client sends its OpenPGP
 
601
        public key in the TLS handshake; this ensures it to be
 
602
        genuine.  The server computes the fingerprint of the key
 
603
        itself and looks up the fingerprint in its list of
 
604
        clients. The <filename>clients.conf</filename> file (see
 
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
606
        <manvolnum>5</manvolnum></citerefentry>)
 
607
        <emphasis>must</emphasis> be made non-readable by anyone
 
608
        except the user starting the server (usually root).
 
609
      </para>
 
610
      <para>
 
611
        As detailed in <xref linkend="checking"/>, the status of all
 
612
        client computers will continually be checked and be assumed
 
613
        compromised if they are gone for too long.
 
614
      </para>
 
615
      <para>
 
616
        For more details on client-side security, see
 
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
618
        <manvolnum>8mandos</manvolnum></citerefentry>.
 
619
      </para>
 
620
    </refsect2>
388
621
  </refsect1>
389
 
 
 
622
  
390
623
  <refsect1 id="see_also">
391
624
    <title>SEE ALSO</title>
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>
 
625
    <para>
 
626
      <citerefentry><refentrytitle>intro</refentrytitle>
 
627
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
628
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
629
      <manvolnum>5</manvolnum></citerefentry>,
 
630
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
631
      <manvolnum>5</manvolnum></citerefentry>,
 
632
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
633
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
634
      <citerefentry><refentrytitle>sh</refentrytitle>
 
635
      <manvolnum>1</manvolnum></citerefentry>
 
636
    </para>
 
637
    <variablelist>
 
638
      <varlistentry>
 
639
        <term>
 
640
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
641
        </term>
 
642
        <listitem>
 
643
          <para>
 
644
            Zeroconf is the network protocol standard used by clients
 
645
            for finding this Mandos server on the local network.
 
646
          </para>
 
647
        </listitem>
 
648
      </varlistentry>
 
649
      <varlistentry>
 
650
        <term>
 
651
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
652
        </term>
 
653
      <listitem>
 
654
        <para>
 
655
          Avahi is the library this server calls to implement
 
656
          Zeroconf service announcements.
 
657
        </para>
 
658
      </listitem>
 
659
      </varlistentry>
 
660
      <varlistentry>
 
661
        <term>
 
662
          <ulink url="http://www.gnu.org/software/gnutls/"
 
663
          >GnuTLS</ulink>
 
664
        </term>
 
665
      <listitem>
 
666
        <para>
 
667
          GnuTLS is the library this server uses to implement TLS for
 
668
          communicating securely with the client, and at the same time
 
669
          confidently get the client’s public OpenPGP key.
 
670
        </para>
 
671
      </listitem>
 
672
      </varlistentry>
 
673
      <varlistentry>
 
674
        <term>
 
675
          RFC 4291: <citetitle>IP Version 6 Addressing
 
676
          Architecture</citetitle>
 
677
        </term>
 
678
        <listitem>
 
679
          <variablelist>
 
680
            <varlistentry>
 
681
              <term>Section 2.2: <citetitle>Text Representation of
 
682
              Addresses</citetitle></term>
 
683
              <listitem><para/></listitem>
 
684
            </varlistentry>
 
685
            <varlistentry>
 
686
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
687
              Address</citetitle></term>
 
688
              <listitem><para/></listitem>
 
689
            </varlistentry>
 
690
            <varlistentry>
 
691
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
692
            Addresses</citetitle></term>
 
693
            <listitem>
 
694
              <para>
 
695
                The clients use IPv6 link-local addresses, which are
 
696
                immediately usable since a link-local addresses is
 
697
                automatically assigned to a network interfaces when it
 
698
                is brought up.
 
699
              </para>
 
700
            </listitem>
 
701
            </varlistentry>
 
702
          </variablelist>
 
703
        </listitem>
 
704
      </varlistentry>
 
705
      <varlistentry>
 
706
        <term>
 
707
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
708
          Protocol Version 1.1</citetitle>
 
709
        </term>
 
710
      <listitem>
 
711
        <para>
 
712
          TLS 1.1 is the protocol implemented by GnuTLS.
 
713
        </para>
 
714
      </listitem>
 
715
      </varlistentry>
 
716
      <varlistentry>
 
717
        <term>
 
718
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
719
        </term>
 
720
      <listitem>
 
721
        <para>
 
722
          The data sent to clients is binary encrypted OpenPGP data.
 
723
        </para>
 
724
      </listitem>
 
725
      </varlistentry>
 
726
      <varlistentry>
 
727
        <term>
 
728
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
729
          Security</citetitle>
 
730
        </term>
 
731
      <listitem>
 
732
        <para>
 
733
          This is implemented by GnuTLS and used by this server so
 
734
          that OpenPGP keys can be used.
 
735
        </para>
 
736
      </listitem>
 
737
      </varlistentry>
 
738
    </variablelist>
432
739
  </refsect1>
433
740
</refentry>
 
741
<!-- Local Variables: -->
 
742
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
743
<!-- time-stamp-end: "[\"']>" -->
 
744
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
745
<!-- End: -->