/mandos/trunk

<!ENTITY COMMANDNAME "mandos-client">

<!ENTITY TIMESTAMP "2009-01-24">

<!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.

          <para>

            If the <option>--connect</option> option is used, this

            specifies the interface to use to connect to the address

            given.

          </para>

          <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>

            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">

    <variablelist>

      <varlistentry>

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

        ></term>

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

        ></term>

        <listitem>

          <para>

            OpenPGP public and private key files, in <quote>ASCII

            Armor</quote> format.  These are the default file names,

            they can be changed with the <option>--pubkey</option> and

            <option>--seckey</option> options.

          </para>

        </listitem>

      </varlistentry>

    </variablelist>

  </refsect1>

  

<!--   <refsect1 id="bugs"> -->

<!--     <title>BUGS</title> -->

<!--     <para> -->

<!--     </para> -->

<!--   </refsect1> -->

  

      Note that normally, command line options will not be given

      directly, but via options for the Mandos <citerefentry

      ><refentrytitle>plugin-runner</refentrytitle>

      <manvolnum>8mandos</manvolnum></citerefentry>.

    <informalexample>

      <para>

        Normal invocation needs no options, if the network interface

        is <quote>eth0</quote>:

      </para>

      <para>

        <userinput>&COMMANDNAME;</userinput>

      </para>

    </informalexample>

    <informalexample>

      <para>

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

        interface:

      </para>

      <para>

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

        <userinput>&COMMANDNAME; --interface eth1</userinput>

      </para>

    </informalexample>

    <informalexample>

      <para>

        Run in debug mode, and use a custom key:

      </para>

      <para>

 

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

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

 

      </para>

    </informalexample>

    <informalexample>

      <para>

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

        to locate a server; connect directly to the IPv6 address

        <quote><systemitem class="ipaddress"

        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,

        port 4711, using interface eth2:

      </para>

      <para>

 

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

<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>

 

      </para>

    </informalexample>

  

      This program is set-uid to root, but will switch back to the

      original (and presumably non-privileged) user and group after

      bringing up the network interface.

    </para>

    <para>

      To use this program for its intended purpose (see <xref

      linkend="purpose"/>), the password for the root file system will

      have to be given out to be stored in a server computer, after

      having been encrypted using an OpenPGP key.  This encrypted data

      which will be stored in a server can only be decrypted by the

      OpenPGP key, and the data will only be given out to those

      clients who can prove they actually have that key.  This key,

      however, is stored unencrypted on the client side in its initial

      <acronym>RAM</acronym> disk image file system.  This is normally

      readable by all, but this is normally fixed during installation

      of this program; file permissions are set so that no-one is able

      to read that file.

    </para>

    <para>

      The only remaining weak point is that someone with physical

      access to the client hard drive might turn off the client

      computer, read the OpenPGP keys directly from the hard drive,

      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

      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.

    </para>

    <para>

      It will also help if the checker program on the server is

      configured to request something from the client which can not be

      spoofed by someone else on the network, unlike unencrypted

      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.

    </para>

    <para>

      <emphasis>Note</emphasis>: This makes it completely insecure to

      have <application >Mandos</application> clients which dual-boot

      to another operating system which is <emphasis>not</emphasis>

      trusted to keep the initial <acronym>RAM</acronym> disk image

      confidential.

  

      <citerefentry><refentrytitle>cryptsetup</refentrytitle>

      <manvolnum>8</manvolnum></citerefentry>,

      <citerefentry><refentrytitle>crypttab</refentrytitle>

      <manvolnum>5</manvolnum></citerefentry>,

    <variablelist>

      <varlistentry>

        <term>

          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>

        </term>

        <listitem>

          <para>

            Zeroconf is the network protocol standard used for finding

            Mandos servers on the local network.

          </para>

        </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          <ulink url="http://www.avahi.org/">Avahi</ulink>

        </term>

      <listitem>

        <para>

          Avahi is the library this program calls to find Zeroconf

          services.

        </para>

      </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          <ulink url="http://www.gnu.org/software/gnutls/"

          >GnuTLS</ulink>

        </term>

      <listitem>

        <para>

          GnuTLS is the library this client uses to implement TLS for

          communicating securely with the server, and at the same time

          send the public OpenPGP key to the server.

        </para>

      </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          <ulink url="http://www.gnupg.org/related_software/gpgme/"

                 >GPGME</ulink>

        </term>

        <listitem>

          <para>

            GPGME is the library used to decrypt the OpenPGP data sent

            by the server.

          </para>

        </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          RFC 4291: <citetitle>IP Version 6 Addressing

          Architecture</citetitle>

        </term>

        <listitem>

          <variablelist>

            <varlistentry>

              <term>Section 2.2: <citetitle>Text Representation of

              Addresses</citetitle></term>

              <listitem><para/></listitem>

            </varlistentry>

            <varlistentry>

              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6

              Address</citetitle></term>

              <listitem><para/></listitem>

            </varlistentry>

            <varlistentry>

            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast

            Addresses</citetitle></term>

            <listitem>

              <para>

                This client uses IPv6 link-local addresses, which are

                immediately usable since a link-local addresses is

                automatically assigned to a network interfaces when it

                is brought up.

              </para>

            </listitem>

            </varlistentry>

          </variablelist>

        </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          RFC 4346: <citetitle>The Transport Layer Security (TLS)

          Protocol Version 1.1</citetitle>

        </term>

      <listitem>

        <para>

          TLS 1.1 is the protocol implemented by GnuTLS.

        </para>

      </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>

        </term>

      <listitem>

        <para>

          The data received from the server is binary encrypted

          OpenPGP data.

        </para>

      </listitem>

      </varlistentry>

      <varlistentry>

        <term>

          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer

          Security</citetitle>

        </term>

      <listitem>

        <para>

          This is implemented by GnuTLS and used by this program so

          that OpenPGP keys can be used.

        </para>

      </listitem>

      </varlistentry>

    </variablelist>