Tag v1.4.5

Author: Simewu

5G_Core_Network/README.md

@@ -73,10 +73,16 @@ By default, the configuration process automatically unregisters all subscribers,
     <td>...2</td>
   </tr>
   <tr>
-    <td>netns</td>
-    <td>ue1</td>
-    <td>ue2</td>
-    <td>ue3</td>
+    <td>Address</td>
+    <td>10.45.0.101</td>
+    <td>...102</td>
+    <td>...103</td>
+  </tr>
+  <tr>
+    <td>Namespace</td>
+     <td>ue1</td>
+     <td>ue2</td>
+     <td>ue3</td>
   </tr>
   <!-- <tr>
     <td>TX Port</td>

5G_Core_Network/full_install.sh

@@ -34,22 +34,14 @@ set -e
 APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo $APTVARS apt-get install -y coreutils
+    sudo env $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
 cd "$SCRIPT_DIR"
 
-# Check if the YAML editor is installed, and install it if not
-if ! command -v yq &>/dev/null; then
-    sudo "$SCRIPT_DIR/install_scripts/./install_yq.sh"
-fi
-# Check that the correct version of yq is installed
-if ! yq --version 2>/dev/null | grep -q 'https://github\.com/mikefarah/yq'; then
-    echo "ERROR: Detected an incompatible yq installation."
-    echo "Please ensure the Python yq is uninstalled with \"pip uninstall -y yq\", then re-run this script."
-    exit 1
-fi
+# Ensure the correct YAML editor is installed
+sudo "$SCRIPT_DIR/install_scripts/./ensure_consistent_yq.sh"
 
 echo "Parsing options.yaml..."
 # Check if the YAML file exists, if not, set and save default values
@@ -93,7 +85,7 @@ if [[ "$USE_SYSTEMCTL" == "null" || -z "$USE_SYSTEMCTL" ]]; then
 fi
 
 # Check for open5gs-amfd and open5gs-upfd binaries to determine if Open5GS is already installed
-if [ -f "open5gs/install/bin/open5gs-amfd" ] && [ -f "open5gs/install/bin/open5gs-upfd" ]; then
+if [ -f "open5gs/install/bin/open5gs-amfd" ] && [ -f "open5gs/install/bin/open5gs-upfd" ] && command -v mongod &>/dev/null; then
     echo "Open5GS is already installed, skipping."
     exit 0
 fi
@@ -159,11 +151,11 @@ sudo usermod -a -G open5gs open5gs
 echo "Installing dependencies for building Open5GS..."
 
 # Code from (https://open5gs.org/open5gs/docs/guide/02-building-open5gs-from-sources#building-open5gs):
-sudo $APTVARS apt-get install -y python3-pip python3-setuptools python3-wheel ninja-build build-essential flex bison git cmake libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libmongoc-dev libbson-dev libyaml-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson
+sudo env $APTVARS apt-get install -y python3-pip python3-setuptools python3-wheel ninja-build build-essential flex bison git cmake libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libmongoc-dev libbson-dev libyaml-dev libmicrohttpd-dev libcurl4-gnutls-dev libnghttp2-dev libtins-dev libtalloc-dev meson
 if apt-cache show libidn-dev >/dev/null 2>&1; then
-    sudo $APTVARS apt-get install -y --no-install-recommends libidn-dev
+    sudo env $APTVARS apt-get install -y --no-install-recommends libidn-dev
 else
-    sudo $APTVARS apt-get install -y --no-install-recommends libidn11-dev
+    sudo env $APTVARS apt-get install -y --no-install-recommends libidn11-dev
 fi
 
 rm -rf build

5G_Core_Network/full_uninstall.sh

@@ -31,12 +31,12 @@
 # Do not exit immediately if a command fails
 set +e
 
-echo "# Script: $(realpath $0)..."
+echo "# Script: $(realpath "$0")..."
 
 APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo $APTVARS apt-get install -y coreutils
+    sudo env $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
@@ -85,5 +85,5 @@ sudo rm -rf install_time.txt
 echo
 echo
 echo "################################################################################"
-echo "# Successfully uninstalled 5G Core                                             #"
+echo "# Successfully uninstalled Open5GS                                             #"
 echo "################################################################################"

5G_Core_Network/generate_configurations.sh

@@ -36,22 +36,14 @@ UE_NUMBERS=(3 2 1) # Subscribers from UE 3 to UE 1
 APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
 if ! command -v realpath &>/dev/null; then
     echo "Package \"coreutils\" not found, installing..."
-    sudo $APTVARS apt-get install -y coreutils
+    sudo env $APTVARS apt-get install -y coreutils
 fi
 
 SCRIPT_DIR=$(dirname "$(realpath "$0")")
 cd "$SCRIPT_DIR"
 
-# Check if the YAML editor is installed, and install it if not
-if ! command -v yq &>/dev/null; then
-    sudo "$SCRIPT_DIR/install_scripts/./install_yq.sh"
-fi
-# Check that the correct version of yq is installed
-if ! yq --version 2>/dev/null | grep -q 'https://github\.com/mikefarah/yq'; then
-    echo "ERROR: Detected an incompatible yq installation."
-    echo "Please ensure the Python yq is uninstalled with \"pip uninstall -y yq\", then re-run this script."
-    exit 1
-fi
+# Ensure the correct YAML editor is installed
+sudo "$SCRIPT_DIR/install_scripts/./ensure_consistent_yq.sh"
 
 echo "Parsing options.yaml..."
 # Check if the YAML file exists, if not, set and save default values
@@ -350,39 +342,22 @@ if [[ "$OGSTUN_IPV6" == "null" || -z "$OGSTUN_IPV6" ]]; then
     exit 1
 fi
 
-# Extract the first IPv4 address from a CIDR block by replacing the last octet with '.1'
-# For example, 10.45.0.0/16 --> 10.45.0.1/16
-grab_first_ipv4_address() {
-    local IP=$1
-    echo ${IP%.*}.1/${IP#*/}
-}
-
-# Extract the first IPv6 address from a CIDR block by replacing the suffix with '::1'.
-# For example, 2001:db8:cafe::/48 --> 2001:db8:cafe::1/48
-grab_first_ipv6_address() {
-    local IP=$1
-    echo ${IP%::*}::1/${IP#*/}
-}
-
-# Remove the CIDR suffix from an IP address
-# For example, 10.45.0.1/16 --> 10.45.0.1
-remove_cidr_suffix() {
-    local IP=$1
-    echo ${IP%/*}
-}
+if ! command -v python3 &>/dev/null; then
+    echo "Python is not installed. Installing Python..."
+    sudo apt-get update
+    sudo apt-get install -y python3
+fi
 
 # Extract the first IPv4 and IPv6 addresses from the CIDR blocks
-OGSTUN_IPV4_1=$(grab_first_ipv4_address "$OGSTUN_IPV4")
-OGSTUN_IPV6_1=$(grab_first_ipv6_address "$OGSTUN_IPV6")
-OGSTUN_IPV4_1_NO_CIDR=$(remove_cidr_suffix "$OGSTUN_IPV4_1")
-OGSTUN_IPV6_1_NO_CIDR=$(remove_cidr_suffix "$OGSTUN_IPV6_1")
+OGSTUN_IPV4_1="$(python3 install_scripts/fetch_nth_ip.py "$OGSTUN_IPV4" 0)"
+OGSTUN_IPV6_1="$(python3 install_scripts/fetch_nth_ip.py "$OGSTUN_IPV6" 0)"
 
 if [ "$EXPOSE_AMF_OVER_HOSTNAME" = true ]; then
     AMF_IP=$(hostname -I | awk '{print $1}')
     set_configuration_server_ips $AMF_IP
     # Need an address for the gNodeB to bind to that is not the host IP.
     if [ "$IS_OPEN5GS_ON_HOST" = true ]; then
-        AMF_IP_BIND=$OGSTUN_IPV4_1_NO_CIDR
+        AMF_IP_BIND=$OGSTUN_IPV4_1
     else
         AMF_IP_BIND=$AMF_IP
     fi
@@ -391,7 +366,7 @@ else
     AMF_IP_BIND="127.0.0.1"
 fi
 
-set_configuration_session_gateways $OGSTUN_IPV4 $OGSTUN_IPV4_1_NO_CIDR $OGSTUN_IPV6 $OGSTUN_IPV6_1_NO_CIDR
+set_configuration_session_gateways $OGSTUN_IPV4 $OGSTUN_IPV4_1 $OGSTUN_IPV6 $OGSTUN_IPV6_1
 
 # Configure the Single Network Slice Selection Assistance Information (S-NSSAI)
 set_snssai "$SST" "$SD"
@@ -413,6 +388,9 @@ configure_plmn_tac $MCC $MNC $TAC
 
 sudo ./install_scripts/network_config.sh
 
+# Enable SCTP kernel module
+sudo ./install_scripts/enable_sctp.sh
+
 # Enable IPv4/IPv6 Forwarding
 sudo sysctl -w net.ipv4.ip_forward=1
 sudo sysctl -w net.ipv6.conf.all.forwarding=1
@@ -433,11 +411,20 @@ echo "Unregistering all subscribers in Open5GS database..."
 
 # Register the subscribers
 for UE_NUMBER in "${UE_NUMBERS[@]}"; do
+    UE_INDEX=$((UE_NUMBER + 99))
+    UE_IPV4=$(python3 install_scripts/fetch_nth_ip.py "$OGSTUN_IPV4" "$UE_INDEX")
+    if [ $? -eq 0 ]; then
+        IPV4_LINE="--ipv4 $UE_IPV4"
+    else
+        IPV4_LINE=""
+    fi
+
     echo
     echo "Registering UE $UE_NUMBER..."
+
     # Fetch the UE's OPc, IMEI, IMSI, KEY, and NAMESPACE
     read -r UE_OPC UE_IMEI UE_IMSI UE_KEY UE_NAMESPACE < <("$UE_CREDENTIAL_GENERATOR_SCRIPT" "$UE_NUMBER" "$PLMN")
-    ./install_scripts/register_subscriber.sh --imsi "$UE_IMSI" --key "$UE_KEY" --opc "$UE_OPC" --apn "$DNN" --sst "$SST" --sd "$SD"
+    ./install_scripts/register_subscriber.sh --imsi "$UE_IMSI" --key "$UE_KEY" --opc "$UE_OPC" --apn "$DNN" --sst "$SST" --sd "$SD" $IPV4_LINE
 done
 
 # Restart Open5GS services to apply changes

5G_Core_Network/install_scripts/disable_firewall.sh

@@ -28,7 +28,7 @@
 # damage to property. The software developed by NIST employees is not subject to
 # copyright protection within the United States.
 
-echo "# Script: $(realpath $0)..."
+echo "# Script: $(realpath "$0")..."
 
 ATTEMPTS=0
 MAX_ATTEMPTS=10

…_Equipment/install_scripts/install_yq.sh …e_Network/install_scripts/enable_sctp.shUser_Equipment/install_scripts/install_yq.sh renamed to 5G_Core_Network/install_scripts/enable_sctp.sh User_Equipment/install_scripts/install_yq.sh renamed to 5G_Core_Network/install_scripts/enable_sctp.sh

@@ -28,76 +28,47 @@
 # damage to property. The software developed by NIST employees is not subject to
 # copyright protection within the United States.
 
-echo "# Script: $(realpath $0)..."
+echo "# Script: $(realpath "$0")..."
 
-# Uninstall yq with: sudo rm -rf /usr/local/bin/yq; hash -r
-if command -v yq &>/dev/null; then
-    echo "Already installed yq, skipping."
-    exit 0
-fi
+# Exit immediately if a command fails
+set -e
 
-echo "Installing yq..."
+APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
+if ! dpkg -s lksctp-tools >/dev/null 2>&1; then
+    sudo apt-get update
+    sudo env $APTVARS apt-get install -y lksctp-tools
+fi
+if ! dpkg -s libsctp1 >/dev/null 2>&1; then
+    sudo apt-get update
+    sudo env $APTVARS apt-get install -y libsctp1
+fi
+if ! dpkg -s libsctp-dev >/dev/null 2>&1; then
+    sudo apt-get update
+    sudo env $APTVARS apt-get install -y libsctp-dev
+fi
 
-# Determine the processor architecture
-ARCH_SUFFIX=""
-case $(uname -m) in
-"x86_64")
-    ARCH_SUFFIX="linux_amd64"
-    ;;
-"aarch64")
-    ARCH_SUFFIX="linux_arm64"
-    ;;
-"armv7l" | "armv6l")
-    ARCH_SUFFIX="linux_arm"
-    ;;
-"i386" | "i686")
-    ARCH_SUFFIX="linux_386"
-    ;;
-"ppc64le")
-    ARCH_SUFFIX="linux_ppc64le"
-    ;;
-"s390x")
-    ARCH_SUFFIX="linux_s390x"
-    ;;
-"mips")
-    ARCH_SUFFIX="linux_mips"
-    ;;
-"mips64")
-    ARCH_SUFFIX="linux_mips64"
-    ;;
-"mips64el" | "mips64le")
-    ARCH_SUFFIX="linux_mips64le"
-    ;;
-"mipsel" | "mipsle")
-    ARCH_SUFFIX="linux_mipsle"
-    ;;
-*)
-    echo "Unsupported architecture for yq: $(uname -m)"
-    exit 1
-    ;;
-esac
+# Load necessary kernel modules
+sudo modprobe overlay || true
+sudo modprobe br_netfilter || true
 
-YQ_URL="https://github.com/mikefarah/yq/releases/latest/download/yq_${ARCH_SUFFIX}.tar.gz"
+# Load SCTP module
+sudo modprobe sctp
 
-# Create a temporary directory for the download
-TEMP_DIR=$(mktemp -d)
-TEMP_PATH="$TEMP_DIR/yq.tar.gz"
+# Get the kernel major version
+KERNEL_VERSION="$(uname -r | cut -d'-' -f1)"
+MAJOR_VERSION="$(echo "$KERNEL_VERSION" | cut -d'.' -f1)"
 
-echo "Downloading yq from $YQ_URL..."
-HTTP_STATUS=$(curl -L -w "%{http_code}" -o "$TEMP_PATH" "$YQ_URL")
-if [ "$HTTP_STATUS" -eq 200 ]; then
-    echo "Extracting yq..."
-    tar -xzf "$TEMP_PATH" -C "$TEMP_DIR"
-    if [ -f "$TEMP_DIR/./yq_$ARCH_SUFFIX" ]; then
-        sudo mv "$TEMP_DIR/./yq_$ARCH_SUFFIX" /usr/local/bin/yq
-        sudo chmod +x /usr/local/bin/yq
-        echo "Successfully installed yq."
-    else
-        echo "Failed to extract yq from the tar.gz."
-        exit 1
-    fi
+# Conditional loading of connection tracking modules based on kernel version
+if [ "$MAJOR_VERSION" -lt 5 ]; then
+    # For older kernels (before version 5), load IPv4 and IPv6 specific modules
+    sudo modprobe nf_conntrack_ipv4 || true
+    sudo modprobe nf_conntrack_ipv6 || true
+    sudo modprobe nf_conntrack_proto_sctp || true
 else
-    sudo rm -rf "$TEMP_DIR"
-    echo "Failed to download yq for the architecture: ${ARCH_SUFFIX}, HTTP status was $HTTP_STATUS."
-    exit 1
+    # For newer kernels (version 5 and later), use the unified nf_conntrack module
+    sudo modprobe nf_conntrack || true
+    sudo modprobe nf_conntrack_sctp || true
 fi
+
+echo "SCTP kernel module present:"
+lsmod | grep -E '(^| )sctp( |$)' || echo "WARNING: sctp not loaded"

…re_Network/install_scripts/install_yq.sh …/install_scripts/ensure_consistent_yq.sh5G_Core_Network/install_scripts/install_yq.sh renamed to 5G_Core_Network/install_scripts/ensure_consistent_yq.sh 5G_Core_Network/install_scripts/install_yq.sh renamed to 5G_Core_Network/install_scripts/ensure_consistent_yq.sh

@@ -28,12 +28,26 @@
 # damage to property. The software developed by NIST employees is not subject to
 # copyright protection within the United States.
 
-echo "# Script: $(realpath $0)..."
+# Exit immediately if a command fails
+set -e
+
+YQ_VERSION="v4.47.2"
 
-# Uninstall yq with: sudo rm -rf /usr/local/bin/yq; hash -r && hash -r
 if command -v yq &>/dev/null; then
-    echo "Already installed yq, skipping."
-    exit 0
+    # Check that the correct version of yq is installed
+    if ! yq --version 2>/dev/null | grep -q 'https://github\.com/mikefarah/yq'; then
+        echo "ERROR: Detected an incompatible yq installation."
+        echo "Please ensure the Python yq is uninstalled with \"pip uninstall -y yq\", then re-run this script."
+        exit 1
+    fi
+
+    if yq --version 2>/dev/null | grep -q "$YQ_VERSION"; then
+        exit 0
+    fi
+
+    echo "Removing incompatible yq..."
+    sudo rm -rf /usr/local/bin/yq
+    hash -r
 fi
 
 echo "Installing yq..."
@@ -77,12 +91,18 @@ case $(uname -m) in
     ;;
 esac
 
-YQ_URL="https://github.com/mikefarah/yq/releases/latest/download/yq_${ARCH_SUFFIX}.tar.gz"
+YQ_URL="https://github.com/mikefarah/yq/releases/download/$YQ_VERSION/yq_${ARCH_SUFFIX}.tar.gz"
 
 # Create a temporary directory for the download
 TEMP_DIR=$(mktemp -d)
 TEMP_PATH="$TEMP_DIR/yq.tar.gz"
 
+if ! command -v curl &>/dev/null; then
+    echo "Package \"curl\" not found, installing..."
+    APTVARS="NEEDRESTART_MODE=l NEEDRESTART_SUSPEND=1 DEBIAN_FRONTEND=noninteractive"
+    sudo env $APTVARS apt-get install -y curl
+fi
+
 echo "Downloading yq from $YQ_URL..."
 HTTP_STATUS=$(curl -L -w "%{http_code}" -o "$TEMP_PATH" "$YQ_URL")
 if [ "$HTTP_STATUS" -eq 200 ]; then