Chapter 1. INTRODUCTION

Table of Contents

System Requirements
Documentation

This is a stand-alone, user mode application that implements a Dual-stack lite (DS-lite) Address Family Transition Router (AFTR, aka. carrier-grade NAT) as described in draft-ietf-softwire-dual-stack-lite-02.txt. It is expected to work on operating systems that support the tun (4) device with IPv6, and has been tested on Linux and FreeBSD.

System Requirements

  • OS: Linux or FreeBSD. Linux kernel version must be greater than 2.6.26, to correct a small-packet-drop problem in tunnel46_rcv().

  • CPU: Shouldn't matter, but we have only tested it with the Intel architecture. Either 32 or 64 bit CPU should be okay. Note that a 32 bit usermode app can run on a 64 bit kernel.

  • Memory: No special requirement.

  • Processor speed: No special requirement. Note the performance is bound to the kernel/user context switch latency, so a benchmarking program (bench.c, start and stop) is provided; this sends 1M pings to 192.168.0.4 from 10.0.0.1 through tun0 (*please* change these addresses in the code).

Documentation

  • README - This file.

  • README.B4 - Instructions for building a DS-lite B4 element.

  • README.natcntl - Information about UPnP/NAT-PMP.

  • README.static-bindings - Information about port forwarding.

  • book.pdf - A nicely formatted version of README and man pages.

  • man/ - This directory contains man pages for configuring, launching, and controlling the AFTR daemon.

  • html/ - This directory contains html versions of the book (README and man pages).

  • doc/ - This directory contains documentation sources, for those who like to play with such things.

  • confs/ - This directory contains configuration files from a development testbed. This testbed is used for testing.

  • confh/ - This directory contains an alternate set of configuration files from a slightly simpler testbed.This testbed uses real hardware and is very similar to configurations shown in demos.