onetoonenat

README

NAT IOModule

This module is a One to One NAT that implements internal to external and reverse natting. In particular each internal ip address (if mapped), is translated into a new external address.

notes:

• first port is always attached to internal network, second port to external one.
• nat iomodule should be part of the code of the router. This is not possible for framework issues (hover does not allow to use 1+ eBPF programs inside the same iomodule).
• this is a transparent nat:
• always attach a nat to a router.
• the layer 2 (arp request, layer 2 rewrite) is managed by the router.
• the nat only modifies packet layers 3

API:

• SetAddressAssociation(internal_ip string, external_ip string): Set the NAT rules.
• internal_ip: internal ip address.
• external_ip: external ip address.

How to use

Using iovisor-ovn daemon in standalone mode, the user can deploy and configure a single or a chain of IOModules. The entire setup can be deployed starting from a YAML configuration file.

$GOPATH/bin/iovisorovnd -file <configuration.yaml>

Some examples are available in /examples folder:

• Nat One-to-One and Router

Please note that NAT One-to-One IOModule Must be deployed attached to a Router.

YAML Configuration Format

The following is an example of the configuration of a NAT:

[...]
- name: Nat
  type: onetoonenat
  config:
    nat_entries:
    - internal_ip: 10.0.1.1
      external_ip: 130.192.1.1

    - internal_ip: 10.0.1.2
      external_ip: 130.192.1.2

[...]

• nat_entries: defines the ip mapping.
• internl_ip: is the internal IP address.
• external_ip: is the correspondent external IP address.

Limitations

• The first port of the nat is always attached to the internal network.
• The second port of the nat is always attached to the public network.

Documentation

Overview

Copyright 2017 Politecnico di Torino

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2017 Politecnico di Torino

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type NatModule
  • func Create(hc *hover.Client) *NatModule
  • func (n *NatModule) AttachExternalInterface(ifaceName string) (err error)
  • func (n *NatModule) AttachToIoModule(ifaceId int, ifaceName string) (err error)
  • func (n *NatModule) Configure(conf interface{}) (err error)
  • func (n *NatModule) Deploy() (err error)
  • func (n *NatModule) Destroy() (err error)
  • func (n *NatModule) DetachExternalInterface(ifaceName string) (err error)
  • func (n *NatModule) DetachFromIoModule(ifaceName string) (err error)
  • func (n *NatModule) GetModuleId() string
  • func (n *NatModule) SetAddressAssociation(internal_ip net.IP, external_ip net.IP) (err error)
• type NatModuleInterface

Variables

var NatCode = `` /* 11197-byte string literal not displayed */

Types

type NatModule

type NatModule struct {
	ModuleId   string
	PortsCount int //number of allocated ports
	Interfaces map[string]*NatModuleInterface
	// contains filtered or unexported fields
}

func Create

func Create(hc *hover.Client) *NatModule

func (*NatModule) AttachExternalInterface

func (n *NatModule) AttachExternalInterface(ifaceName string) (err error)

func (*NatModule) AttachToIoModule

func (n *NatModule) AttachToIoModule(ifaceId int, ifaceName string) (err error)

func (*NatModule) Configure

func (n *NatModule) Configure(conf interface{}) (err error)

func (*NatModule) Deploy

func (n *NatModule) Deploy() (err error)

func (*NatModule) Destroy

func (n *NatModule) Destroy() (err error)

func (*NatModule) DetachExternalInterface

func (n *NatModule) DetachExternalInterface(ifaceName string) (err error)

func (*NatModule) DetachFromIoModule

func (n *NatModule) DetachFromIoModule(ifaceName string) (err error)

func (*NatModule) GetModuleId

func (n *NatModule) GetModuleId() string

func (*NatModule) SetAddressAssociation

func (n *NatModule) SetAddressAssociation(internal_ip net.IP, external_ip net.IP) (err error)

type NatModuleInterface

type NatModuleInterface struct {
	IfaceIdRedirectHover int    //Iface id inside hover (relative to the m:1234 the interface is attached to ...) and provided my the extended hover /links/ API
	IfaceFd              int    //Interface Fd inside External_Ids (42, etc...)
	LinkIdHover          string //iomodules Link Id
	IfaceName            string
}