/mandos/trunk

<!ENTITY COMMANDNAME "mandos-client">

<!ENTITY TIMESTAMP "2010-09-26">

<!ENTITY % common SYSTEM "../common.ent">

%common;

    <!-- NWalsh’s docbook scripts use this to generate the footer: -->

    <productnumber>&version;</productnumber>

      <year>2009</year>

  

      Client for <application>Mandos</application>

  

        <replaceable>ADDRESS</replaceable><literal>:</literal

        <replaceable>ADDRESS</replaceable><literal>:</literal

        <option>--delay <replaceable>SECONDS</replaceable></option>

      </arg>

      <sbr/>

      <arg>

  

      to get a password.  In slightly more detail, this client program

      brings up a network interface, uses the interface’s IPv6

      link-local address to get network connectivity, uses Zeroconf to

      find servers on the local network, and communicates with servers

      using TLS with an OpenPGP key to ensure authenticity and

      confidentiality.  This client program keeps running, trying all

      servers on the network, until it receives a satisfactory reply

      or a TERM signal is received.  If no servers are found, or after

      all servers have been tried, it waits indefinitely for new

      servers to appear.

        <term><option>--interface=<replaceable

        >NAME</replaceable></option></term>

            Mandos servers to connect to.  The default is the empty

            string, which will automatically choose an appropriate

            interface.

          <para>

            Note that since this program will normally run in the

            initial RAM disk environment, the interface must be an

            interface which exists at that stage.  Thus, the interface

            can not be a pseudo-interface such as <quote>br0</quote>

            or <quote>tun0</quote>; such interfaces will not exist

            until much later in the boot process, and can not be used

            by this program.

          </para>

          <para>

            <replaceable>NAME</replaceable> can be the string

            <quote><literal>none</literal></quote>; this will not use

            any specific interface, and will not bring up an interface

            on startup.  This is not recommended, and only meant for

            advanced users.

          </para>

            OpenPGP public key file name.  The default name is

            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename

            ></quote>.

      

            OpenPGP secret key file name.  The default name is

            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename

            ></quote>.

      

 

      <varlistentry>

        <term><option>--delay=<replaceable

        >SECONDS</replaceable></option></term>

        <listitem>

          <para>

            After bringing the network interface up, the program waits

            for the interface to arrive in a <quote>running</quote>

            state before proceeding.  During this time, the kernel log

            level will be lowered to reduce clutter on the system

            console, alleviating any other plugins which might be

            using the system console.  This option sets the upper

            limit of seconds to wait.  The default is 2.5 seconds.

          </para>

        </listitem>

      </varlistentry>

      

  

      at all.  This is why a separate plugin runner (<citerefentry>

      <refentrytitle>plugin-runner</refentrytitle>

      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run

      both this program and others in in parallel,

      <emphasis>one</emphasis> of which will prompt for passwords on

      the system console.

      to get a decryptable password and print it.

  <refsect1 id="files">

  

        Search for Mandos servers (and connect to them) using another

        interface:

        Run in debug mode, and use a custom key:

 

<!-- do not wrap this line -->

<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>

 

        Run in debug mode, with a custom key, and do not use Zeroconf

        to locate a server; connect directly to the IPv6 link-local

        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,

        using interface eth2:

<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>

  

      and communicate with the server.  To safeguard against this, the

      server is supposed to notice the client disappearing and stop

      giving out the encrypted data.  Therefore, it is important to

      set the timeout and checker interval values tightly on the

      server.  See <citerefentry><refentrytitle