Install n2n-Edgenode¶

Requirements¶

To install n2n you will need the following:

• a installed and supported operating system (e.g. CentOS 6.x)
• root-access
• EPEL repository
• a fast internet connection

Preliminary note¶

most of this is taken from

• [[http://www.ntop.org/products/n2n/]]
• [[https://github.com/lukablurr/n2n_v2_fork/blob/master/doc/multiple-supernodes.pdf]]
• [[http://listgateway.unipi.it/mailman/listinfo/n2n]]
• [[http://listgateway.unipi.it/pipermail/n2n/2009-October/000300.html]]

Install¶

The EPEL-Repository is a requirement.

Install EPEL repository

yum install n2n

manual testing¶

starting Edgenode¶

maybe simple as

edge -a 10.1.2.5 -c mynetwork -k mypwd -l 94.136.160.87:5644

edge -d n2n0 -c mynetwork -k encryptme -u 99 -g 99 -m DE:AD:BE:EF:01:23 -a 192.168.254.7 -p 50001 -l 123.121.120.119:7654

Start edge with TAP device n2n0 on community "mynetwork" with community supernode at 123.121.120.119 UDP port 7654 and bind the locally used UDP port to50001. Use "encryptme" as the single permanent shared encryption key. Assign MACaddress DE:AD:BE:EF:01:23 to the n2n interface and drop to user=99 and group=99 after the TAP device is successfull configured.

Add the -f option to stop edge running as a daemon.

Somewhere else setup another edge with similar parameters, eg.

edge -d n2n0 -c mynetwork -k encryptme -u 99 -g 99 -m DE:AD:BE:EF:01:21 -a 192.168.254.5 -p 50001 -l 123.121.120.119:7654

Now you can ping from 192.168.254.5 to 192.168.254.7.

The MAC address (-m <MAC>) and virtual IP address (-a <addr>) must be differenton all edges in the same community.

running n2n-EdgeNode as a service¶

if everything is working as expected we maybe want n2n-edgenode to survive a system-reboot.

The following should work without modification:

Create a folder /etc/n2n and create configuration files (as described below) using following file name format:

mkdir /etc/n2n

edge-host1.example.com
edge-host2.example.com
edge-*.example.com

The interesting contents of 'edge-host1.example.com' would look similar to this:

vim /etc/n2n/edge-host1.example.com

# == edge configuration values parsed by /etc/rc.d/init.d/edged ==
# Each value is read by the init script - do not modify variable names.
# Read 'man edge' for details about these values...

# Uncomment N2N_FORWARD if you want to route packets via VPN...
#  N2N_FORWARD="-r" 
#  N2N_DAEMONISE="-f" 
N2N_TUN_IF="tun10" 
N2N_IP="10.10.10.11" 
N2N_NETMASK="255.255.255.0" 
N2N_KEY="MySecretCode" 
N2N_COMMUNITY="MyCommunityName" 

# Better to use numeric public IP rather than DNS hostname, but...
N2N_SUPERNODE="gw1.example.com" 
N2N_PORT="8765" 
N2N_UID="99" 
N2N_GID="99" 
# Other options...
#   N2N_OPTIONS="-p 1234 -M 1200 -t -b -v" 
N2N_OPTIONS="" 
# === end edge-host1.example.com config. file ===================

Read comments in the scripts below to make more sense out of how they work.

Here is the init-script that works when used with configuration files as described above:

vim /etc/init.d/edged

#!/bin/sh
# $Id: n2n-edge.init,v 1.9 2009/10/23 12:34:56
# n2n edge    startup script.
#
# chkconfig:    345 97 25
# processname:  edge
# pidfile: /var/run/n2n-edge.pid
#
# short-description: Provides client-to-client VPN access via Internet
# description: This is startup script for n2n 'edge',
#   n2n edge + supernode provide internet connection for vpn peers
#
# SEE:
#    for more options n2n 'man edge' and 'man supernode'
#
# NOTE:
#   Option to enter 'debug' as second var: e.g 'supernode start debug'
#   Using grep -w switch searches for whole word reduces ambiguity
#   Comment in/out the 'echo' stuff depending if things work as expected
#   Config files located/named in: /etc/n2n/edge-your.example.com
#   Assumes CentOS init scripts located in /etc/rc.d/init.d/
#
# Created: FOOFORCE RB 2009-10-24
# License GPL: free to copy, improve and use.
# ===========================================================
# ==== main init script variables ===========================
# Make sure you include path where 'edge' + sh + tools are installed..
# PATH="/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin" 
PATH="/sbin:/bin:/usr/sbin:/usr/bin" 

# The name + path to the executable program/daemon file...
NAME="edge" 
DAEMON="/usr/sbin/${NAME}" 

# Modify $NAME to filter on 'grep -w [s]supernode' - faster than 'grep -v grep'...
GREPNAME=$(echo "[e]${NAME#e}")

# Enable some simple debug messages when running this script...
if [[ "${2}" == "debug" ]]; then
     echo "DEBUG: ${GREPNAME} ${2}" 
fi

PIDFILE="/var/run/edge.pid" 
LOGFILE="/var/log/n2n-${NAME}.log" 
STAMP=$(/bin/date +%T)

# Get the host/domain name to identify local configfile..
HOST=$(/bin/hostname)
FQDN=$(/bin/hostname -f)

# Initialise configfile variable to empty value...
CONFIGDIR="/etc/n2n" 

# Initialise configfile variable to empty value...
CONFIGFILE="" 

# Load values from configfile using our local domain name:
# Example:
#   Our local FQDN = 'myhost.example.com'
#   Our configfile = 'edge-myhost.example.com'
#
if [[ "${HOST}" == "" ]]; then
#if [[ "${FQDN}" == "" ]]; then
      #echo " ERROR: Missing ${FQDN} hostname in config file /etc/rc.d/init.d/${NAME}" 
      echo " ERROR: Missing ${HOST} hostname in config file /etc/rc.d/init.d/${NAME}" 
      exit 1
else
      #CONFIGFILE="${CONFIGDIR}/edge-${FQDN}" 
      CONFIGFILE="${CONFIGDIR}/edge-${HOST}" 
fi

if [[ -f "${CONFIGFILE}" ]]; then
     # Get values from local configuration file...
     echo " Found config file: ${CONFIGFILE}" 
     . ${CONFIGFILE}
else
     echo "ERROR: Missing config file ${CONFIGFILE}" 
     exit 1
fi

# See if pid file exists and get pid number...
if [[ -f "${PIDFILE}" ]]; then
     CURPID=$(cat ${PIDFILE})
fi

# Quit if we can't find application...
test -f ${DAEMON} || exit 0

set -e

# Set any value to enable this script...
# N2N_RUN=1
#
# test -n "${N2N_RUN}" || exit 0

# Optionaly change into n2n config directory...
if [[ -d "${CONFIGDIR}" ]]; then
     cd ${CONFIGDIR}
fi
# =========================================================

# Should not need to change much below here...

# ==== see how we were called  + act accordingly ==========
case "${1}" in
     start)
         # echo " ${NAME} ${1} process is ${0} on pid: ${$})..." 
         echo "${STAMP} start n2n /etc/rc.d/init.d/${NAME}" > ${LOGFILE}

         if [[ -n "${CURPID}" ]]; then
             echo " A PID:${CURPID} already exists for ${0}:" 
             echo " To re-start with current config settings, run '$0 stop' then '$0 start' ..." 
         else
        if [ -d /var/lock/subsys ] ; then
                 touch /var/lock/subsys/${NAME};
             fi

             # =====================================================
             # If using third-part tools to set tun device..
             # tunctl -t ${N2N_TUN_IF}

             # All variables read from ${CONFIGFILE}...
             # Use configfile ${FORWARD}   = '-r' switch to enable packet forwarding/routing
             # Use configfile ${DAEMONISE} = '-f' switch to daemonise in background....
             #
             # Uncomment to display all the variable source values...
             # echo "DEBUG: ${DAEMON} ${FORWARD} ${N2N_DAEMONISE}\
             #    -d ${N2N_TUN_IF} -c ${N2N_COMMUNITY} -k ${N2N_KEY} -u ${N2N_UID} -g ${N2N_GID} \
             #    -a ${N2N_IP} -s ${N2N_NETMASK} -p ${N2N_UDP} -l ${N2N_SUPERNODE}:${N2N_PORT} ${N2N_OPTIONS}" 
             # If variable value not empty then add command-line switch to variable...
             if [[ -n "${N2N_TUN_IF}" ]]; then N2N_TUN_IF="-d ${N2N_TUN_IF}"; fi
             if [[ -n "${N2N_IP}" ]]; then N2N_IP="-a ${N2N_IP}"; fi
             if [[ -n "${N2N_NETMASK}" ]]; then N2N_NETMASK="-s ${N2N_NETMASK}"; fi
             if [[ -n "${N2N_COMMUNITY}" ]]; then N2N_COMMUNITY="-c ${N2N_COMMUNITY}"; fi
             if [[ -n "${N2N_KEY}" ]]; then N2N_KEY="-k ${N2N_KEY}"; fi
             if [[ -n "${N2N_UID}" ]]; then N2N_UID="-u ${N2N_UID}"; fi
             if [[ -n "${N2N_GID}" ]]; then N2N_GID="-g ${N2N_GID}"; fi
             if [[ -n "${N2N_SUPERNODE}" ]]; then N2N_SUPERNODE="-l ${N2N_SUPERNODE}"; fi
             if [[ -n "${N2N_PORT}" ]]; then N2N_PORT=":${N2N_PORT}"; fi

             if [[ "${2}" == "debug" ]]; then
                 echo "DEBUG: display values for ${DAEMON} from configfile:" 
                 echo "  ${FORWARD} ${N2N_DAEMONISE} ${N2N_TUN_IF} ${N2N_IP} ${N2N_NETMASK} ${N2N_COMMUNITY}" 
                 echo "   ${N2N_KEY} ${N2N_UID} ${N2N_GID} ${N2N_SUPERNODE}${N2N_PORT} ${N2N_OPTIONS}" 
             fi

             # Execute the command + switches + values sources from config file...
             ${DAEMON} ${FORWARD} ${N2N_DAEMONISE} ${N2N_TUN_IF} ${N2N_IP} ${N2N_NETMASK} ${N2N_COMMUNITY} \
                 ${N2N_KEY} ${N2N_UID} ${N2N_GID} ${N2N_SUPERNODE}${N2N_PORT} ${N2N_OPTIONS}

             # ====================================================
             echo " NOTICE: Starting:${NAME}" 
             rm -f ${PIDFILE}
             touch ${PIDFILE}

             for PID in $(ps ax | grep -w "${GREPNAME}" | grep -v "(restart|stop|start)" | awk '{ print $1 }')
             do
                 echo " Setting PID: ${PID}" 
                 echo ${PID} >> ${PIDFILE}
             done
         fi
        ;;
     stop)
             # echo " DEBUG: Searching for at least one live process id..." 
             PID=$(ps ax | grep -w "${GREPNAME}" | grep -v "(restart|stop|start)" | awk '{ print $1 }')

             if [[ "${2}" == "debug" ]]; then
                 echo " ${NAME} ${1} process is ${0} on pid: ${$}) for ${PID}..." 
             fi

             echo "${STAMP} stop /etc/rc.d/init.d/${NAME}" >> ${LOGFILE}

             # echo "  NOTICE: Kill name:${NAME} pid:${pid} before stopping..." 
             # kill -9 $(cat /var/run/${NAME}_pid) && rm /var/run/${NAME}_pid

             # If a pid value found in file or in process id, then kill it...
             if [[ -n "${PID}" ]]; then
                 echo " Stopping; ${NAME} pid:${PID}..." 
                 # kill -9 $(cat /var/run/${NAME}.pid) && rm /var/run/${NAME}.pid
                 kill ${PID}
                 sleep 2s
                 rm -f ${PIDFILE}
             else
                 # Else assume stale pid...
                 if [[ "${2}" == "debug" ]]; then
                     echo " NOTICE: No current active process ${PID}..." 
                 fi

                 if [[ -f "${PIDFILE}" ]]; then
                     echo "removing stale pidfile..." 
                     rm -f ${PIDFILE}
                 fi
             fi

             # Indiscriminate pid killer...
             # for PID in $(ps ax | grep -w ${NAME} | grep -v grep | awk '{ print $1 }')
             # do
            #    echo " Killing currently active ${NAME} pid(s): ${PID}" 
            #    # kill -HUP $PID
            #    kill ${PID}
             # done

             if [[ -f /var/lock/subsys/${NAME} ]]; then
                 echo " Removing stale lock file..." 
                rm -f /var/lock/subsys/${NAME}
             fi

             if [[ -f "${PIDFILE}" ]]; then
                 echo " Removing stale pid file..." 
                rm -f /var/lock/subsys/${NAME}
             fi
        ;;
     restart)
             echo "* Re-start ${NAME}..." 
             ${0} stop ${2}

             # Not a race....
             sleep 4s

             ${0} start ${2}
        ;;
     status)
            # status ${NAME}
             PID=$(ps ax | grep -w "${GREPNAME}" | grep -v "status" | awk '{ print $1 }')

             if [[ "${2}" == "debug" ]]; then
                 echo " This ${NAME} ${1} init query is ${0} running on pid: ${$})..." 
             fi

             # If at least one active session, look for more...
             if [[ -n "${PID}" ]]; then
                 for PID in $(ps ax | grep -w "${GREPNAME}" | grep -v "status" | awk '{ print $1 }')
                 do
                     if [[ -n "${PID}" ]]; then
                        echo " * Found current active ${GREPNAME} pid(s): ${PID}" 
                         else
                        echo " * No active session found for ${0}" 
                     fi
                 done
             else
                echo " * No active session(s) found for ${0}" 
             fi
        ;;
         *)
            echo " Usage: ${0} {start|stop|status|restart|any debug}" >&2
            exit 1
        ;;
     esac
exit 0
# === end edged =============================================

make init-script executeable

chmod +x /etc/init.d/edged

Using CentOS tools to activate the sys.v init scripts:

chkconfig --add edged
chkconfig edged on

Command line syntax:

service edged [start|stop|restart|any debug]

For example:

service edged restart

…OR…

service edged restart debug

provides some extra clues.