/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 plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-26 21:54:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080926215454-7kfrl0gxmisz71gw
* mandos: Remove unused "select" module.  Import "ctypes.util".
  (AvahiError.__init__): Call __init__ of superclass.
  (AvahiService.__init__): Rename keyword arg "type" to "servicetype".
  (AvahiService.rename): Bug fix: use "self.rename_count".
  (Client.__init__): Use "None" instead of "{}" as default value.
  (tcp_handler): Renamed to "TCP_handler".  All callers changed.
  (IPv6_TCPServer.__init__): Don't "return", just call the superclass
                             method.
  (if_nametoindex): Don't import "ctypes.util" here.
  (main): Removed unused variable "main_loop_started".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-client">
5
 
<!ENTITY TIMESTAMP "2009-02-09">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
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>
93
91
      </arg>
94
92
      <sbr/>
95
93
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
94
        <option>--debug</option>
101
95
      </arg>
102
96
    </cmdsynopsis>
126
120
      <command>&COMMANDNAME;</command> is a client program that
127
121
      communicates with <citerefentry><refentrytitle
128
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
 
      to get a password.  In slightly more detail, this client program
130
 
      brings up a network interface, uses the interface’s IPv6
131
 
      link-local address to get network connectivity, uses Zeroconf to
132
 
      find servers on the local network, and communicates with servers
133
 
      using TLS with an OpenPGP key to ensure authenticity and
134
 
      confidentiality.  This client program keeps running, trying all
135
 
      servers on the network, until it receives a satisfactory reply
136
 
      or a TERM signal is received.  If no servers are found, or after
137
 
      all servers have been tried, it waits indefinitely for new
138
 
      servers to appear.
 
123
      to get a password.  It uses IPv6 link-local addresses to get
 
124
      network connectivity, Zeroconf to find servers, and TLS with an
 
125
      OpenPGP key to ensure authenticity and confidentiality.  It
 
126
      keeps running, trying all servers on the network, until it
 
127
      receives a satisfactory reply or a TERM signal is received.
139
128
    </para>
140
129
    <para>
141
130
      This program is not meant to be run directly; it is really meant
195
184
      </varlistentry>
196
185
      
197
186
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
187
        <term><option>--interface=
 
188
        <replaceable>NAME</replaceable></option></term>
200
189
        <term><option>-i
201
190
        <replaceable>NAME</replaceable></option></term>
202
191
        <listitem>
203
192
          <para>
204
193
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
 
194
            Mandos servers to connect to.  The default it
206
195
            <quote><literal>eth0</literal></quote>.
207
196
          </para>
208
197
          <para>
210
199
            specifies the interface to use to connect to the address
211
200
            given.
212
201
          </para>
213
 
          <para>
214
 
            Note that since this program will normally run in the
215
 
            initial RAM disk environment, the interface must be an
216
 
            interface which exists at that stage.  Thus, the interface
217
 
            can not be a pseudo-interface such as <quote>br0</quote>
218
 
            or <quote>tun0</quote>; such interfaces will not exist
219
 
            until much later in the boot process, and can not be used
220
 
            by this program.
221
 
          </para>
222
 
          <para>
223
 
            <replaceable>NAME</replaceable> can be the empty string;
224
 
            this will not use any specific interface, and will not
225
 
            bring up an interface on startup.  This is not
226
 
            recommended, and only meant for advanced users.
227
 
          </para>
228
202
        </listitem>
229
203
      </varlistentry>
230
204
      
275
249
          </para>
276
250
        </listitem>
277
251
      </varlistentry>
278
 
 
279
 
      <varlistentry>
280
 
        <term><option>--delay=<replaceable
281
 
        >SECONDS</replaceable></option></term>
282
 
        <listitem>
283
 
          <para>
284
 
            After bringing the network interface up, the program waits
285
 
            for the interface to arrive in a <quote>running</quote>
286
 
            state before proceeding.  During this time, the kernel log
287
 
            level will be lowered to reduce clutter on the system
288
 
            console, alleviating any other plugins which might be
289
 
            using the system console.  This option sets the upper
290
 
            limit of seconds to wait.  The default is 2.5 seconds.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
252
      
295
253
      <varlistentry>
296
254
        <term><option>--debug</option></term>
385
343
    </para>
386
344
  </refsect1>
387
345
  
388
 
  <refsect1 id="files">
 
346
  <refsect1 id="file">
389
347
    <title>FILES</title>
390
348
    <variablelist>
391
349
      <varlistentry>
452
410
    <informalexample>
453
411
      <para>
454
412
        Run in debug mode, with a custom key, and do not use Zeroconf
455
 
        to locate a server; connect directly to the IPv6 link-local
456
 
        address <quote><systemitem class="ipaddress"
457
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
458
 
        using interface eth2:
 
413
        to locate a server; connect directly to the IPv6 address
 
414
        <quote><systemitem class="ipaddress"
 
415
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
416
        port 4711, using interface eth2:
459
417
      </para>
460
418
      <para>
461
419
 
462
420
<!-- do not wrap this line -->
463
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
421
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
464
422
 
465
423
      </para>
466
424
    </informalexample>
491
449
      The only remaining weak point is that someone with physical
492
450
      access to the client hard drive might turn off the client
493
451
      computer, read the OpenPGP keys directly from the hard drive,
494
 
      and communicate with the server.  To safeguard against this, the
495
 
      server is supposed to notice the client disappearing and stop
496
 
      giving out the encrypted data.  Therefore, it is important to
497
 
      set the timeout and checker interval values tightly on the
498
 
      server.  See <citerefentry><refentrytitle
 
452
      and communicate with the server.  The defense against this is
 
453
      that the server is supposed to notice the client disappearing
 
454
      and will stop giving out the encrypted data.  Therefore, it is
 
455
      important to set the timeout and checker interval values tightly
 
456
      on the server.  See <citerefentry><refentrytitle
499
457
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
500
458
    </para>
501
459
    <para>