Release v1.0.0

Author: Simewu

5G_Core_Network/README.md

@@ -3,6 +3,7 @@
 The 5G Core Network operates as a standalone network based on the 3GPP specifications TS 23.501 [[1]][ts3144-3gpp] and TS 23.502 [[2]][ts3145-3gpp], implemented using the Open5GS software [[3]][open5gs-open5gs]. The 5G Core Network consists of the MME, SGWC, SMF, AMF, SGWU, UPF, HSS, PCRF, NRF, SCP, SEPP 1, SEPP 2, AUSF, UDM, PCF, NSSF, BSF, and UDR.
 
 ## Usage
+
 - **Compile**: Use `./full_install.sh` to build the 5G Core.
 - **Generate Configurations**: Use `./generate_configurations.sh` to create configuration files.
   - Configuration files can be accessed and modified in the `configs` directory.
@@ -13,7 +14,9 @@ The 5G Core Network operates as a standalone network based on the 3GPP specifica
 - **Logs**: Access logs by navigating to the `logs` directory.
 
 ### Custom PLMN and TAC Identifiers
+
 Modify the `5G_Core_Network/options.yaml` for different PLMN and TAC IDs, then apply changes with the following.
+
 ```console
 ./generate_configurations.sh
 ./stop.sh
@@ -24,9 +27,11 @@ cd ../5G_Core_Network
 ```
 
 ## Accessing Subscriber Data
+
 The WebUI hosts a web interface to access subscriber data. To access the WebUI, navigate to `http://localhost:9999` in a web browser, or run `start_webui.sh` to open it in Chrome or Firefox automatically.
 
 Alternatively, to create subscriber entries from command line, use the following.
+
 ```console
 ./install_scripts/register_subscriber.sh --imsi 001010123456780 --key 00112233445566778899AABBCCDDEEFF --opc 63BFA50EE6523365FF14C1F45F88737D --apn srsapn
 ```
@@ -69,7 +74,7 @@ By default, the configuration process automatically creates subscriber entries f
     <td>ue2</td>
     <td>ue3</td>
   </tr>
-  <tr>
+  <!-- <tr>
     <td>TX Port</td>
     <td>2101</td>
     <td>2201</td>
@@ -80,13 +85,14 @@ By default, the configuration process automatically creates subscriber entries f
     <td>2100</td>
     <td>2200</td>
     <td>2300</td>
-  </tr>
+  </tr> -->
 </tbody>
 </table>
 
 For more information on the subscriber data, refer to the blueprint [[4]][nist-tn] and the User_Eqiupment README document.
 
 ## References
+
 1. 3GPP TS 23.501: System Architecture for the 5G System. [https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=3144][ts3144-3gpp]
 2. 3GPP TS 23.502: Procedures for the 5G System. [https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=3145][ts3145-3gpp]
 3. Open Source implementation for 5G Core and EPC. Open5GS. [https://open5gs.org/][open5gs-open5gs]

5G_Core_Network/full_install.sh

@@ -127,16 +127,16 @@ else
         echo "No conflicting MongoDB installations found."
     fi
 
-    # If GPG step fails, try clearing MongoDB GPG key before proceeding:
-    # sudo apt-key del [KEY_ID]
-    # sudo rm /etc/apt/sources.list.d/mongodb-org-4.4.list
-
     # Step 2: Installing MongoDB 4.4
     echo "Updating package lists..."
-    sudo apt-get update || {
-        echo "Failed to update package lists"
-        exit 1
-    }
+    if ! sudo apt-get update; then
+        sudo "$SCRIPT_DIR/install_scripts/./remove_any_expired_apt_keys.sh"
+        echo "Trying to update package lists again..."
+        if ! sudo apt-get update; then
+            echo "Failed to update package lists"
+            exit 1
+        fi
+    fi
 
     echo "Installing gnupg and curl if not already installed..."
     sudo apt-get install -y gnupg curl || {

5G_Core_Network/generate_configurations.sh

@@ -39,12 +39,9 @@ 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
-    echo "Installing yq..."
-    YQ_PATH="https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64"
-    sudo wget $YQ_PATH -O /usr/bin/yq
-    sudo chmod +x /usr/bin/yq
-    # Uninstall with: sudo rm -rf /usr/bin/yq
+    sudo "$SCRIPT_DIR/install_scripts/./install_yq.sh"
 fi
 
 echo "Parsing options.yaml..."

RAN_Intelligent_Controllers/Non-Real-Time-RIC/install_scripts/handle_disk_pressure_taint.sh renamed to 5G_Core_Network/install_scripts/install_yq.sh

@@ -30,42 +30,74 @@
 
 echo "# Script: $(realpath $0)..."
 
-# If the disk-pressure taint is not present then skip
-if ! kubectl describe nodes | grep Taints | grep -q "disk-pressure"; then
-    echo "No disk-pressure taint found on any nodes, skipping."
+# Uninstall yq with: sudo rm -rf /usr/bin/yq
+if command -v yq &>/dev/null; then
+    echo "Already installed yq, skipping."
     exit 0
 fi
 
-# Get a list of nodes with the disk-pressure taint
-AFFECTED_NODES=$(kubectl get nodes -o jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.spec.taints[*].key}{"\t"}{.spec.taints[*].effect}{"\n"}' | grep "disk-pressure" | cut -f1)
-if [ -z "$AFFECTED_NODES" ]; then
-    echo "No nodes with disk-pressure taint found, skipping."
-    exit 0
-fi
+echo "Installing yq..."
 
-# Remove the disk-pressure taint from each affected node
-for NODE in $AFFECTED_NODES; do
-    echo "Removing taint disk-pressure from $NODE..."
-    if ! kubectl taint nodes $NODE node.kubernetes.io/disk-pressure- --overwrite; then
-        echo "Failed to remove taint from $NODE. Check your permissions or connectivity."
-    fi
-done
+# 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
+
+YQ_URL="https://github.com/mikefarah/yq/releases/latest/download/yq_${ARCH_SUFFIX}.tar.gz"
 
-sleep 1
+# Create a temporary directory for the download
+TEMP_DIR=$(mktemp -d)
+TEMP_PATH="$TEMP_DIR/yq.tar.gz"
 
-# Check if the taint was successfully removed from each affected node
-TAINT_REMOVAL_FAILED=0
-for NODE in $AFFECTED_NODES; do
-    if kubectl describe node $NODE | grep -q "node.kubernetes.io/disk-pressure"; then
-        echo "Error: Taint disk-pressure is still present on $NODE."
-        TAINT_REMOVAL_FAILED=1
+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 "Taint: disk-pressure was successfully removed from $NODE."
+        echo "Failed to extract yq from the tar.gz."
+        exit 1
     fi
-done
-
-# If any taint removal failed
-if [ $TAINT_REMOVAL_FAILED -eq 1 ]; then
-    echo "ERROR: Disk-pressure taint is active. Please ensure sufficient RAM and disk space is available."
+else
+    sudo rm -rf "$TEMP_DIR"
+    echo "Failed to download yq for the architecture: ${ARCH_SUFFIX}, HTTP status was $HTTP_STATUS."
     exit 1
 fi

5G_Core_Network/install_scripts/remove_any_expired_apt_keys.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+#
+# NIST-developed software is provided by NIST as a public service. You may use,
+# copy, and distribute copies of the software in any medium, provided that you
+# keep intact this entire notice. You may improve, modify, and create derivative
+# works of the software or any portion of the software, and you may copy and
+# distribute such modifications or works. Modified works should carry a notice
+# stating that you changed the software and should note the date and nature of
+# any such change. Please explicitly acknowledge the National Institute of
+# Standards and Technology as the source of the software.
+#
+# NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY
+# OF ANY KIND, EXPRESS, IMPLIED, IN FACT, OR ARISING BY OPERATION OF LAW,
+# INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND DATA ACCURACY. NIST
+# NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE
+# UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES
+# NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR
+# THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY,
+# RELIABILITY, OR USEFULNESS OF THE SOFTWARE.
+#
+# You are solely responsible for determining the appropriateness of using and
+# distributing the software and you assume all risks associated with its use,
+# including but not limited to the risks and costs of program errors, compliance
+# with applicable laws, damage to or loss of data, programs or equipment, and
+# the unavailability or interruption of operation. This software is not intended
+# to be used in any situation where a failure could cause risk of injury or
+# damage to property. The software developed by NIST employees is not subject to
+# copyright protection within the United States.
+
+echo "# Script: $(realpath $0)..."
+
+OUTPUT=$(sudo apt-get update 2>&1 | tee /dev/tty)
+
+# Look for EXPKEYSIG errors in the output
+if echo "$OUTPUT" | grep -iq "EXPKEYSIG"; then
+    # Extract the key IDs
+    KEYS=$(echo "$OUTPUT" | grep -io "EXPKEYSIG [0-9A-F]*" | awk '{print $2}' | sort | uniq)
+
+    if [ -n "$KEYS" ]; then
+        for KEY in $KEYS; do
+            echo
+            echo "Invalid key detected: $KEY"
+            # Determine the keyring file to be modified
+            KEYRING_PATH=""
+            for file in /etc/apt/keyrings/*.gpg; do
+                if sudo gpg --no-default-keyring --keyring "$file" --list-keys | grep -q "$KEY"; then
+                    KEYRING_PATH="$file"
+                    break
+                fi
+            done
+
+            if [ -n "$KEYRING_PATH" -a -f "$KEYRING_PATH" ]; then
+                echo "Removing key $KEY from keyring $KEYRING_PATH..."
+                sudo gpg --batch --yes --no-default-keyring --keyring "$KEYRING_PATH" --delete-keys "$KEY"
+            else
+                echo "No keyring file found for key: $KEY"
+            fi
+
+            # Find the corresponding list file(s) and remove them
+            FILES_LIST=""
+            for FILE in /etc/apt/sources.list.d/*.list; do
+                # Now we need to grep $KEY or grep $KEYRING_PATH exists in the file contents
+                if grep -q "$KEY" "$FILE" || grep -q "$KEYRING_PATH" "$FILE"; then
+                    FILES_LIST="$FILES_LIST $FILE"
+                fi
+            done
+            for FILE in $FILES_LIST; do
+                if [ -n "$FILE" ]; then
+                    echo "Removing file: $FILE"
+                    sudo rm "$FILE"
+                fi
+            done
+
+            if [ -z "$FILES_LIST" ]; then
+                echo "No corresponding .list files found to remove for key: $KEY"
+            else
+                echo "Successfully removed expired key $KEY and corresponding .list files."
+            fi
+        done
+    else
+        echo "No invalid keys found to remove."
+    fi
+else
+    echo "Successfully completed apt-get update with no EXPKEYSIG errors detected."
+fi

Additional_Scripts/download_dependency_repositories.sh.bat

@@ -30,6 +30,7 @@ REM copyright protection within the United States.
 
 : '
 REM This Linux shell/Windows batch script will download the 5G_Core_Network, gNodeB, User_Equipment and RAN_Intelligent_Controllers repositories for analyzing the source code without requiring a full testbed build and installation.
+@echo off
 '
 
 cd ..
@@ -38,14 +39,14 @@ cd 5G_Core_Network
 git clone https://github.com/open5gs/open5gs.git open5gs
 cd ..
 
-cd Next_Generation_Node_B
-git clone https://github.com/srsran/srsRAN_Project.git
+cd User_Equipment
+git clone https://github.com/srsran/srsRAN_4G.git
 git clone https://github.com/zeromq/libzmq.git
 git clone https://github.com/zeromq/czmq.git
 cd ..
 
-cd User_Equipment
-git clone https://github.com/srsran/srsRAN_4G.git
+cd Next_Generation_Node_B
+git clone https://github.com/srsran/srsRAN_Project.git
 cd ..
 
 cd RAN_Intelligent_Controllers/Near-Real-Time-RIC
@@ -57,15 +58,8 @@ cd xApps
 git clone https://gerrit.o-ran-sc.org/r/ric-app/hw-go
 cd ..
 cd ..
+cd ..
 
-cd RAN_Intelligent_Controllers/Non-Real-Time-RIC
-git clone https://gerrit.o-ran-sc.org/r/it/dep
-git clone https://gerrit.o-ran-sc.org/r/nonrtric/plt/ranpm -b j-release dep/ranpm
-git clone https://gerrit.o-ran-sc.org/r/ric-plt/ric-dep -b j-release dep/ric-dep
-git clone https://github.com/onap/multicloud-k8s.git dep/smo-install/multicloud-k8s
-git clone https://gerrit.onap.org/r/oom dep/smo-install/onap_oom
-
-git clone https://gerrit.o-ran-sc.org/r/portal/nonrtric-controlpanel
 echo "Repositories were cloned successfully."
 
 : '

Additional_Scripts/increase_file_descriptor_limits.sh

@@ -84,6 +84,11 @@ if [ -d 5G_Core/open5gs ] || [ -d gNodeB/srsRAN_Project ] || [ -d RAN_Intelligen
         sudo mv RAN_Intelligent_Controller/* RAN_Intelligent_Controllers/Near-Real-Time-RIC
         sudo rm -rf RAN_Intelligent_Controller
     fi
+
+    echo "Ensuring the apt keys are not expired..."
+    sudo ./Additional_Scripts/remove_any_expired_apt_keys.sh
+
+    echo
     echo "The 5G Core needs to be reinstalled with ./5G_Core_Network/full_install.sh."
     echo "Successfully migrated from commit 310ca91b9f5f83a0d0b94affebfdc940005daf1a to the new version."
     echo