Running a LISPmob device on the public Internet requires the following:

xTR - MN

•   an EID from a Mapping Service Provider (MSP),
•   the RLOC of the Map-Server that will accept the registration of this EID,
•   an authentication token to register the EID with the Map-Server,
•   the RLOC of a Map-Resolver,
•   the RLOC of a Proxy-ETR,
•   a publicly routable RLOC for the device running LISPmob, which is neither firewalled, nor behind NAT (see however "NAT traversal" section for details on this).

RTR

• the RLOC of a Map-Resolver,
• a publicly routable RLOC for the device running LISPmob, which is neither firewalled, nor behind NAT.

MS/MR

• a publicly routable RLOC for the device running LISPmob, which is neither firewalled, nor behind NAT.

The above information is used for configuring 'lispd' via the configuration file 'lispd.conf'. See section "OpenWRT" for OpenWRT configuration details and "Android" for Android configuration details.

Visit http://www.lisp4.net/ for more info on the deployment status of the LISP beta-network and how you can join the testbed.

Software Prerequisites

To build LISPmob for a standard Linux, you will need:

• a Linux hosts
• a C compiler (tested with `gcc`)
• GNU make
• git, unless you use a tarball
• OpenSSL development headers
• libConfuse
• gengetopt
• libcap v2+
• libzmq v3
• libxml2

On Debian-derived Linux distributions (including Ubuntu), installing the following packages will provide all necessary dependencies:

• 'build-essential'
• 'git-core'
• 'libconfuse-dev'
• 'gengetopt'
• 'libcap2-bin'
• 'libzmq3-dev'
• 'libxml2-dev'
•  

The latest version of the LISPmob source code can be obtained from Github:
    git clone git://github.com/LISPmob/lispmob.git

Installation

To build and install the code, run the following in the top-level directory:

    make

To install it in `/usr/local/sbin`, run

    sudo make install

To build the code for OpenWRT you will need the OpenWRT official SDK. However, for your convenience, we encourage you to install the precompiled .ipk, from our website. Check section "OpenWRT" for details.

Running LISPmob

Once the code is successfully installed on the device, `lispd.conf.example` should be copied to `/etc/lispd.conf` and edited with the proper values. Again, see section 'OpenWRT' for OpenWRT details about this. Additionally the device's interface used for physical network connectivity (such as 'eth0', 'wlan0' or 'ppp0') must also be specified in the configuration file.

Prior to execute LISPmob, make sure that each external interface (such as 'wan0') has defined a default route with different 'metric' in the routing table (there is a 'default' entry for each outgoing interface). In most cases, this is auto-configured by the operating system during start-up.

Check that sysctl options configuration is correct. Make sure that rp_filter kernel network parameter is disabled. It is disabled by default in OpenWRT, but, for instance, it is enabled by default in Ubuntu. Make sure too that IP forwarding is enabled. It should be enabled by default in OpenWRT. 
   
You can instruct your system to auto-configure these values during system boot-up if you add the following lines to `/etc/sysctl.conf`. Remember to reboot your system after adding these lines.

sudo sysctl net.ipv4.conf.default.rp_filter=0
sudo sysctl net.ipv4.conf.all.rp_filter=0
sudo sysctl net.ipv4.ip_forward=1
sudo sysctl net.ipv6.conf.all.forwarding=1 

The user space daemon can be started by a non privileged user with the appropriate permissions (particularly CAP_NET_ADMIN and CAP_NET_RAW). Such user can run the daemon with:

    lispd -f /etc/lispd.conf

It will set up networking and register to the mapping system, after which you can enjoy all the benefits of LISP.

Features

Version 0.5 introduced major changes in LISPmob. The code was abstracted and modularized in order to provide support for different LISP devices and to facilitate the implementation of new functionalities.

This is the list of supported features at this moment

xTR / MN

• Register to the Mapping System
• Request mappings
• Reply to mapping requests
• Encapsulate data packets
• Decapsulate data packets
• RLOC Probing (user configurable)
• IPv6 full support (EIDs and RLOCs)
• Interface management
• Multihoming
• Explicit Locator Path (ELPs)

RTR

• Request mappings
• Reply to mapping requests
• Reencapsulate data packets
• RLOC Probing (user configurable)
• IPv6 full support (EIDs and RLOCs)
• Interface management
• Multihoming
• Explicit Locator Path (ELPs)

MS / MR

• Process registration requests
• Notify correct registration
• Accept more specific entries
• Reply to mapping requests when Proxy Relpy activated
• Forward requests to xTRs
• IPv6 full support (EIDs and RLOCs)
• Interface management
• Explicit Locator Path (ELPs)

LISPmob operating modes

Mobile Node mode (MN)

When 'lispd' is running in MN mode, the EID obtained configured is associated to the 'lispTun0' virtual interface. Two /1 routes covering the full IP addresses space should appear in the routing table. These routes should be pointing to 'lispTun0' device. The following lines show an example of how 'ip addr' and 'ip route' will look like with IPv4, expect a similar output with IPv6:

    $ ip addr
    1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue state UNKNOWN
        link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
        inet 127.0.0.1/8 scope host lo
           valid_lft forever preferred_lft forever
    2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <RLOC> brd <RLOC_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    3: lispTun0: <POINTOPOINT,UP,LOWER_UP> mtu 1450 qdisc pfifo_fast state UNKNOWN qlen 500
        link/none
        inet <EID> scope host lispTun0

    $ ip route
    <RLOC_Network> dev eth0  proto kernel  scope link  src <RLOC>
    169.254.0.0/16 dev eth0  scope link  metric 1000
    0.0.0.0/1 dev lispTun0
    128.0.0.0/1 dev lispTun0
    default via <RLOC_GW> dev eth0  metric 100

xTR mode

To configure LISPmob to use it on xTR mode take into account the following considerations.
An EID /30 (at least) prefix is required for IPv4 EIDs. For IPv6 you should have a /126 (at least). This prefix should be used as the network prefix for the subnet where the hosts on the EID space connected to the router are allocated. Assign the EID to an interface on the router and configure it as you would do for a normal network prefix (static configuration, DHCP, etc...). No EID is used for the 'lispTun0' interface in router mode (a local address is automatically used by LISPmob instead).
The following lines show an example of how 'ip addr' and 'ip route' will look like with IPv4, expect a similar output with IPv6:

    $ ip addr
    1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue state UNKNOWN
        link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
        inet 127.0.0.1/8 scope host lo
           valid_lft forever preferred_lft forever
    2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <RLOC> brd <RLOC_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <EID1> brd <EID1_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    4: eth2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <EID2> brd <EID2_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    5: lispTun0: <POINTOPOINT,UP,LOWER_UP> mtu 1440 qdisc pfifo_fast state UNKNOWN qlen 500
        link/none

    $ ip route
    <RLOC_Network> dev eth0  proto kernel  scope link  src <RLOC>
    <EID1_Network> dev eth1  proto kernel  scope link  src <EID1>
    <EID2_Network> dev eth2  proto kernel  scope link  src <EID2>
    default via <RLOC_GW> dev eth0  metric 100

    $ ip rule
    0:      from all lookup local
    x:      from <RLOC> lookup x
    99:     from all to <EID1_Network> lookup main
    99:     from all to <EID2_Network> lookup main 
    100:    from <EID1_Network> lookup 100
    100:    from <EID2_Network> lookup 100
    32766:  from all lookup main
    32767:  from all lookup default

RTR mode

When running in RTR mode, LISPmob serves as a Re-encapsulating Tunnel Router that decapsulates the received traffic to reencapsulate it again towards the next hop. To configure an RTR, select the corresponding operating-mode and fill the parameters of the RTR section and Tunnel Router general configuration of the configuration file
The following lines show an example of how 'ip addr' and 'ip route' will look like with IPv4, expect a similar output with IPv6:

    $ ip addr
    1: lo: <LOOPBACK,UP,LOWER_UP> mtu 16436 qdisc noqueue state UNKNOWN
        link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
        inet 127.0.0.1/8 scope host lo
           valid_lft forever preferred_lft forever
    2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <RLOC1> brd <RLOC1_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    3: eth1: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP qlen 1000
        link/ether 00:00:00:00:00:00 brd ff:ff:ff:ff:ff:ff
        inet <RLOC2> brd <RLOC2_BROADCAST> scope global eth0
           valid_lft forever preferred_lft forever
    4: lispTun0: <POINTOPOINT,UP,LOWER_UP> mtu 1440 qdisc pfifo_fast state UNKNOWN qlen 500
        link/none

    $ ip route
    <RLOC1_Network> dev eth0  proto kernel  scope link  src <RLOC1>
    <RLOC2_Network> dev eth1  proto kernel  scope link  src <RLOC2>
    default via <RLOC_GW_1> dev eth0  metric 100
    default via <RLOC_GW_2> dev eth1  metric 110

    $ ip rule
    0:      from all lookup local
    x:      from <RLOC1> lookup x
    y:     from <RLOC2> lookup y
    32766:  from all lookup main
    32767:  from all lookup default

MS/MR mode

LISPmob 0.5 can be configured as a basic MS/MR where configured EID prefixes can be registered by xTRs. LISPmob will also reply to MapRequests addressed to those prefixes.
To configure LISPmob as a MS/MR, select the corresponding operating-mode and fill the parameters of the MS section of the configuration file

OpenWrt

To enable OpenWRT configuration mode and the specific routing operations, the code should have been compiled with the `platform=openwrt` option during OpenWRT package creation. Please note that the best way to get LISPmob on OpenWRT is get a precompiled binary (either the full system or just the LISPmob package) from the LISPmob website (http://lispmob.org/downloads/openwrt).

LISPmob is also available on the official OpenWRT repositories, but it is not guaranteed that this version would be the latest one. You can try to install LISPmob from OpenWRT package feeds with:

    opkg update
    opkg install lispd

In OpenWRT, the configuration is performed through the OpenWRT standard configuration tool UCI, instead of using 'lispd.conf' file. Configure the UCI file manually in '/etc/config/lispd' (by default), use the UCI CLI application, or use the web interface (if available). The configuration fields are analogue to those in the 'lispd.conf' file.

Android

Since version 0.4, LISPmob includes support for Android devices operating as LISP-MN.
Version 0.5 maintains Android support however, given that NAT traversal is not yet available for this version, the usage of LISPmob 0.5 on Android is limited to devices with a public address. For production environments is recommended to use version 0.4.x. that does not have this limitation.
Please see the README.android.md file to get details on LISPmob for Android installation, compilation and usage.

Other Platforms

If you are running either Raspbian or Arch Linux you may find useful this installation guide contributed by Michiel Blokzijl

NAT traversal

The NAT traversal support has not been yet implemented in LISPmob 0.5. If you require this feature, please use the version 0.4.x.