/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-12-15 02:33:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081215023336-x319cdr0ycvrzp33
* mandos (_datetime_to_dbus_struct): Renamed to "_datetime_to_dbus";
                                     return a dbus.String containing
                                     an ISO 8601 formatted date+time.
  (Client.__init__): Renamed keyword argument "stop_hook" to
                     "disabled_hook".  All callers changed.
  (Client.started): Renamed to "enabled"; all users changed.
  (Client.last_started): Renamed to "last_enabled"; all users changed.
  (Client.stop_hook): Renamed to "disabled_hook"; all users changed.
  (Client.stop_initiator_tag): Renamed to "disable_initiator_tag"; all
                               users changed.
  (Client.start): Renamed to "enable".  All callers changed.
  (Client.stop): Renamed to "disable".  All callers changed.
  (Client.GetAllProperties): Property "last_started" renamed to
                             "last_enabled" and "started" renamed to
                             "enabled".
  (Client.Start): Renamed to "Enable".
  (Client.Stop): Renamed to "Disable".

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
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
4
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2009-02-09">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <year>2009</year>
36
35
      <holder>Teddy Hogeborn</holder>
37
36
      <holder>Björn Påhlsson</holder>
38
37
    </copyright>
93
92
      </arg>
94
93
      <sbr/>
95
94
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
95
        <option>--debug</option>
101
96
      </arg>
102
97
    </cmdsynopsis>
126
121
      <command>&COMMANDNAME;</command> is a client program that
127
122
      communicates with <citerefentry><refentrytitle
128
123
      >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.
 
124
      to get a password.  It uses IPv6 link-local addresses to get
 
125
      network connectivity, Zeroconf to find servers, and TLS with an
 
126
      OpenPGP key to ensure authenticity and confidentiality.  It
 
127
      keeps running, trying all servers on the network, until it
 
128
      receives a satisfactory reply or a TERM signal is received.
139
129
    </para>
140
130
    <para>
141
131
      This program is not meant to be run directly; it is really meant
195
185
      </varlistentry>
196
186
      
197
187
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
188
        <term><option>--interface=
 
189
        <replaceable>NAME</replaceable></option></term>
200
190
        <term><option>-i
201
191
        <replaceable>NAME</replaceable></option></term>
202
192
        <listitem>
203
193
          <para>
204
194
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
 
195
            Mandos servers to connect to.  The default it
206
196
            <quote><literal>eth0</literal></quote>.
207
197
          </para>
208
198
          <para>
210
200
            specifies the interface to use to connect to the address
211
201
            given.
212
202
          </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
203
        </listitem>
229
204
      </varlistentry>
230
205
      
275
250
          </para>
276
251
        </listitem>
277
252
      </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
253
      
295
254
      <varlistentry>
296
255
        <term><option>--debug</option></term>
452
411
    <informalexample>
453
412
      <para>
454
413
        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:
 
414
        to locate a server; connect directly to the IPv6 address
 
415
        <quote><systemitem class="ipaddress"
 
416
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
417
        port 4711, using interface eth2:
459
418
      </para>
460
419
      <para>
461
420
 
462
421
<!-- 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>
 
422
<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
423
 
465
424
      </para>
466
425
    </informalexample>