Host Identity Protocol implementation
-------------------------------------

The documentation hipdoc.html contains more details, but here are
some quick instructions for the impatient.

LINUX INSTALL (kernel mode) 
---------------------------

1. Patch linux 2.6.X kernel with linux-2.6.X-hip.patch and build:

   su
   tar xjf linux-2.6.X.tar.bz2
   mv linux-2.6.X linux-2.6.X-hip
   cd linux-2.6.X-hip
   patch -p1 < ../linux-2.6.X-hip.patch
   make xconfig
   make bzImage
   make modules
   make modules_install
   make install
   ln -s /usr/src/linux-2.6.X-hip /usr/src/linux

2. Patch ipsec-tools 0.6 with ipsec-tools-0.6-hip.patch:

   tar xvf ipsec-tools-0.6.tar.gz
   cd ipsec-tools-0.6
   patch -p1 < ../ipsec-tools-0.6-hip.patch
   ./configure
   make install

3. Build hipd and hitgen binaries:

   cd hipd/src
   make

   There is no 'make install' for hipd, it can be run from any
   directory as root. 

4. Use hitgen to write new configuration and identity files:

   ./hitgen -conf
   ./hitgen
   ./hitgen -publish

5. Now you can run the "hipd" daemon program. See hipdoc.html for
   more detailed configuration and usage information.


REQUIREMENTS
-----------------------------------------------
This release consists of a user-space HIP daemon (hipd), a kernel patch, 
and patches to IPsec tools. Also included is a hitgen utility used for initial
setup and generating Host Identities, and scripts for setting up HIP. 
The daemon requires the following (most recently tested version numbers):
    * openssl (0.9.8) cryptographic libraries
    * libxml2 (2.6.20) XML libraries
    * ipsec-tools 0.6 patched with ipsec-tools-0.6-hip.patch
    * Linux kernel 2.6.X patched with linux-2.6.X-hip.patch
      (this patch may work for similar versions of the kernel)

FILES
-----------------------------------------------
The hipd program uses the following files:
    * hipd
    * hitgen (for setup only)
    * /etc/hip/hip.conf
    * /etc/hip/my_host_identities
    * /etc/hip/known_host_identities
    * /var/run/hip.pid
    * /var/log/hipd.log


