Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/OpenOverlayRouter/oor

OpenOverlayRouter is an implementation to create programmable overlay networks.
https://github.com/OpenOverlayRouter/oor

lisp openwrt overlay router

Last synced: about 2 months ago
JSON representation

OpenOverlayRouter is an implementation to create programmable overlay networks.

Awesome Lists containing this project

README 

        
Overview

--------



The Open Overlay Router (OOR) project aims to deliver a flexible and modular

open-source implementation to deploy programmable overlay networks. It

leverages on encapsulating overlay-specific packets into underlay-compatible

packets at the edges of the instantiated overlay and route them over the

physical underlying infrastructure. In order to do so, it maps overlay

identifiers to underlay locators and keeps those mappings updated over 

time. In the current version, OOR uses the LISP protocol for the 

control-plane (e.g. mapping retrieval and updating, etc), NETCONF/YANG for 

the management-plane (e.g. overlay identifiers provisioning, etc) and can 

use both LISP and VXLAN-GPE headers for encapsulation. 



Most of the OOR architecture revolves around the LISP protocol and its 

components, that we introduce briefly here. The Locator/ID Separation 

Protocol (LISP) is an IETF protocol (RFC6830) that decouples the semantics 

of identity and location on current IP addresses. It uses the concept of 

Endpoint IDentifiers (EIDs) to name hosts in edge networks, and Routing 

LOCators (RLOCs) for nodes in transit networks. EIDs and RLOCs are 

syntactically indistinguishable from current IPv4 and IPv6 addresses, 

enabling backwards compatibility with the existing Internet architecture. 

A distributed database, the Mapping System, is responsible for maintaining 

the associations between EIDs and RLOCs. LISP Mobile Node (LISP-MN) is a 

specification to enable fast host mobility using LISP. For convenience, OOR 

uses terminology borrowed from the LISP protocol and thus uses the term EID 

for the overlay identifiers and the term RLOC for the underlay locators. 

Regarding the LISP devices that OOR implements, currently it can operate as 

an xTR, LISP-MN, MS, MR, DDT Node or RTR.



Nowadays, OOR runs on desktop Linux, OpenWrt home routers and Android and iOS 

devices. The current reference platform for OOR development is Ubuntu 

Server 16.04 LTS (Xenial Xerus), OpenWrt 18.06 and Android 6.0 (Marshmallow),

iOS 11.3.



OOR can work together with the Vector Packet Processing (VPP) technology to 

obtain an xTR capable to reach bandwith close to the 10 GBps. To use VPP as 

the OOR dataplane, refears to the README.vpp.md.



OpenOverlayRouter is a rename of the LISPmob.org project.



Network Prerequisites

---------------------



Running a Open Overlay Router 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 OOR, 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 OOR, which is neither 

  firewalled, nor behind NAT.



MS - MR - DDT

  * a publicly routable RLOC for the device running OOR, which is neither 

  firewalled, nor behind NAT.



The above information is used for configuring 'oor' via the configuration file 

'oor.conf'. See section "OpenWrt" for OpenWrt configuration details,"Android" 

for Android configuration details and "iOS" for Apple iOS configuration.



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 Open Overlay Router for a standard Linux, you will need:



  * a Linux hosts

  * a C compiler (tested with `gcc`)

  * GNU make

  * git, unless you use a tarball

  * 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 Open Overlay Router source code can be obtained 

from Github:



    git clone git://github.com/OpenOverlayRouter/oor.git



Installation

------------



To build the code for Linux operating run the following in the top-level directory:



    make 



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



    sudo make install



A `Vagrantfile` is provided for quick installation in a dedicated VM, see the

"Using Vagrant" section.

    

To build the code for OpenWrt you will need the OpenWrt official SDK. However,

for your convenience, we encourage you to install the official packet from OpenWrt

repository. Check section "OpenWrt" for details.



Running Open Overlay Router

---------------------------



Once the code is successfully installed on the device, `oor.conf.example` should 

be copied to `/etc/oor.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 Open Overlay Router, 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.



    net.ipv4.conf.default.rp_filter=0

    net.ipv4.conf.all.rp_filter=0

    net.ipv4.ip_forward=1

    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: 



    oor -f /etc/oor.conf



It will set up networking and register to the mapping system, after which you

can enjoy all the benefits of LISP. 



Features

--------



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 (LISP and VXLAN-GPE)

    - Decapsulate data packets (LISP and VXLAN-GPE)

    - RLOC Probing (user configurable)

    - IPv6 full support (EIDs and RLOCs)

    - Interface management 

    - Multihoming

    - Experimental NAT traversal

    - Explicit Locator Path (ELPs)

    - Instance ID / VNI support

    - NETCONF/YANG configurable

    - VPP support (only for IPv4 RLOCs)

    - Specify destination EID prefixes (only linux and OpenWrt)

    - Remote RLOC registration



* RTR



    - Request mappings

    - Reply to mapping requests

    - Reencapsulate data packets (LISP and VXLAN-GPE)

    - RLOC Probing (user configurable)

    - IPv6 full support (EIDs and RLOCs)

    - Interface management 

    - Multihoming

    - Explicit Locator Path (ELPs)

    - Instance ID / VNI support

    - Experimental NAT traversal



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

    - Instance ID support

    - Experimental NAT traversal

    - Process DDT Map Requests



* DDT

    - DDT authoritative sites

    - DDT delegated sites

    - Process encapsulated DDT map request

    - Generate Map Referrals

    - Instance ID / VNI support



* DDT-MR

    - Process mapping requests and forward them to DDT root nodes

    - Process replies from DDT mapping system

    - Instance ID / VNI support

    

Note: OOR doesn't support overlapping local prefixes with different IIDs when operating as 

a XTR or MN.    



Mobile Node mode (MN)

---------------------

When 'oor' 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:  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:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    3: lispTun0:  mtu 1450 qdisc pfifo_fast state UNKNOWN qlen 500

        link/none 

        inet  scope host lispTun0



    $ ip route

     dev eth0  proto kernel  scope link  src 

    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  dev eth0  metric 100



xTR mode

--------

 

To configure Open Overlay Router to use it on x Tunnel Router (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 OOR 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:  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:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    3: eth1:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    4: eth2:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    5: lispTun0:  mtu 1440 qdisc pfifo_fast state UNKNOWN qlen 500

        link/none 



    $ ip route

     dev eth0  proto kernel  scope link  src 

     dev eth1  proto kernel  scope link  src 

     dev eth2  proto kernel  scope link  src 

    default via  dev eth0  metric 100



    $ ip rule

    0:      from all lookup local 

    x:      from  lookup x 

    99:     from all to  lookup main

    99:     from all to  lookup main  

    100:    from  lookup 100

    100:    from  lookup 100 

    32766:  from all lookup main 

    32767:  from all lookup default



This output is only valid when OOR is not compiled to work with VPP.



RTR mode

--------



When running in RTR mode, Open Overlay Router serves as a Re-encapsulating Tunnel Router 

that decapsulates the received traffic to reencapsulate it again towards the next hop.

An RTR can also be used to provide NAT support to xTRs/MNs when it works together with a

MS with NAT Traversal support.



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:  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:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    3: eth1:  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  brd  scope global eth0

           valid_lft forever preferred_lft forever

    4: lispTun0:  mtu 1440 qdisc pfifo_fast state UNKNOWN qlen 500

        link/none 



    $ ip route

     dev eth0  proto kernel  scope link  src 

     dev eth1  proto kernel  scope link  src 

    default via  dev eth0  metric 100

    default via  dev eth1  metric 110



    $ ip rule

    0:      from all lookup local 

    x:      from  lookup x 

    y:     from  lookup y

    32766:  from all lookup main 

    32767:  from all lookup default



MS mode

-------



Open Overlay Router can be configured as a basic Map Server (MS) where configured EID prefixes

can be registered by xTRs. OOR will also reply to MapRequests addressed to those prefixes.

MS can be associated with an RTR in order to provide NAT support to xTRs/MN.



To configure Open Overlay Router as a MS/MR, select the corresponding operating-mode and 

fill the parameters of the MS section of the configuration file.



DDT mode

--------



Open Overlay Router implements the LISP Delegated Database Tree (LISP-DDT) specified

in the RFC 8111. LISP-DDT is a hierarchical distributed database that embodies the 

delegation of authority to provide mappings from LISP EIDs to RLOCs. It is a statically 

defined distribution of the EID namespace among a set of LISP-speaking servers called 

"DDT nodes".  Each DDT node is configured as "authoritative" for one or more EID-prefixes, 

along with the set of RLOCs for Map-Servers or "child" DDT nodes to which more-specific 

EID-prefixes are delegated.



To configure OOR as a DDT node, define the authoritative sites and the delegated sites.

Delegated sites could be of type MAP_SERVER_DDT_NODE if the next hop is a Map Server, or 

CHILD_DDT_NODE if next hop is a DDT node with more-specific EID prefix information.

The node authoritative for all EID space is usually called DDT ROOT node.



MR mode

-------



A LISP Map Resolver (MR) is a node that forwards Map Requests from xTRs to the MSs 

responsibles of the requested EID. The MR implemented by Open Overlay Router use LISP-DDT to

find the suitable MS.



To configure OOR as a MR, specify the addresses of the DDT Root nodes to be used.



Using Vagrant

-------------



The top-level directory of the tree has a `Vagrantfile` to allow quick

creation of a VM with all prerequisites preinstalled so the code can be built

quickly in an isolated environment. This is especially useful for development

on platforms other than Linux, where code editing is done on the native host

OS, and the Linux VM created by Vagrant is used only for building and testing

the code.



Vagrant automatically sets up a shared folder `/vagrant` pointing to the

folder where the Vagrantfile resides, in this case the top-level folder of the

source tree. This way, changes to the source code on the host computer are

automatically reflected in the VM, and binaries created in the VM are also

automatically available to the host OS.



To create the VM, run:



    vagrant up



This will create a VM called `oor-dev` by downloading the base box (currently

Ubuntu 17.10), updating packages to the latest version, and installing build

dependencies for OOR. It may be useful to install the `vagrant-cachier` plugin

to cache Ubuntu packages, in order to speed up rebuilds of the VM, if done

often:



    vagrant plugin install vagrant-cachier



Once provisioning of the VM finished, it can be accessed with:



    vagrant ssh



There is also a VM definition called `oor-dev-android`, which is not

provisioned by default. It does all of the above, and in addition it creates

the environment for building the Android APK. Provisioning it requires using

the VM name explicitly in the `vagrant up` command:



    vagrant up oor-dev-android

    

Using Dockers

-------------



Docker is a platform that is based on packaging applications in containers. It 

immediately improves security, reduce costs and gain cloud portability.

All these improvements can be achieved without changing the original code.



The OOR can work as a Docker Container. This will allow to get the lifecycle of 

OOR from development to production shorter receiving and running automatically 

the last code of OOR from github. 



Using OOR as a container can also be used to provide LISP support to other running

containers in the host. 



In the Docker directory you can find a README.md file with more details in how to 

create and use OOR as a container.



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 Open Overlay Router on OpenWrt is using the official package from OpenWrt

repository or get a precompiled binary  from the  github website

(https://github.com/OpenOverlayRouter/oor/wiki/Downloads). 



In OpenWrt, the configuration is performed through the OpenWrt standard

configuration tool UCI, instead of using 'oor.conf' file. Configure the UCI

file manually in '/etc/config/oor' (by default), use the UCI CLI application,

or use the web interface (if available). The configuration fields are analogue

to those in the 'oor.conf' file.



Android

-------



Open Overlay Router includes support for Android devices operating as LISP-MN.

Please see the [android/README.md](android/README.md) file to get details on

Open Overlay Router for Android installation, compilation and usage.



iOS

---



Open Overlay Router includes support for iOS devices operating as LISP-MN.

Please see the [Apple/README.md](Apple/README.md) file to get details on

Open Overlay Router for iOS installation, compilation and usage.



VPP

---



Open Overlay Router has adopted VPP as a new data plane that can be used to 

encapsulate and decapsulate LISP traffic in a high performance rate.

Please see the VPP/README.md file to get details on how to configure OOR and

VPP to work together. 



NAT traversal

-------------



Since version 1.1, Open Overlay Router includes experimental NAT traversal 

capabilities for the modalities of xTR and MN (see LISP NAT traversal draft). 

In order to use NAT traversal with Open Overlay Router you will need a MS and 

an RTR (Re-encapsulating Tunnel Router) that are NAT traversal capable. If you 

are using the beta-network, please take into account that, at the time of this 

writing (release 1.1), not all devices on the beta-network have been updated 

to support NAT traversal yet.



If NAT traversal feature is enabled, Open Overlay Router is configured to send 

all data traffic through RTRs even if the interface has a public address. On its 

current form, NAT traversal support on Open Overlay Router ignores IPv6 addresses 

on RLOC interfaces, besides, the current NAT traversal implementation in the 

beta-network only supports the registration of a single EID prefix per device. 



Contact

-------



Should you have questions regarding the use of the Open Overlay Router distribution, 

please subscribe to the [email protected] mailing list and ask there

(http://mail.openoverlayrouter.org/mailman/listinfo/users).



If you wish to participate in the development of Open Overlay Router, use the 

dedicated mailing list, [email protected] 

(http://mail.openoverlayrouter.org/mailman/listinfo/devel).



Additionally, important announcements are sent to the low volume mailing list

[email protected] 

(http://mail.openoverlayrouter.org/mailman/listinfo/announce).



More interactive help can sometimes be obtained on the '#openoverlayrouter' IRC channel on

FreeNode.



Bugs you encounter should be filed at the [repository's issue tracker on

Github](https://github.com/OpenOverlayRouter/oor/issues).