This repository was made to help us decease the time it takes for us to setup a 5G core network.
- On an Ubuntu machine, you can run the following command to install virtualbox and vagrant:
$ sudo apt-get install virtualbox vagrant
- On a Windows machine, use the GUI to install virtualbox and vagrant from here.
- Please install git and clone this repository.
$ git clone https://github.com/spg-iitd/Cellular-Security.git
Note: If you would like to install both Open5GS and UERANSIM seperately, you can follow the instructions in the docs folder.
Most of the tasks that we shall be doing in this repository will be done on the virtual machine and you shall be SSHing into the VM. So, in a terminal window on your host machine, cd into the repository folder, and use the following command to boot the VM:
vagrant up # starting the VMs
vagrant ssh [name of the vm] # logging into the VM
vagrant halt # stopping the VM
vagrant destroy -f # destroying the VMYou can find a quickstart guide for Vagrant here. You will find vagrant files for open5gs and ueransim already made in the virtual-machine-installation folder.
SSH into your machine which has the Open5GS machine, you should explore the folder open5gs/install/. You'll find configuration settings in etc folder and binaries in bin. Make the edits to both as per requirement and start the services one after the other.
You can run the following commands to start the services:
sudo ./open5gs-nrfd &
sudo ./open5gs-scpd &
sudo ./open5gs-smfd &
sudo ./open5gs-ausfd &
sudo ./open5gs-nssfd &
sudo ./open5gs-pcfd &
sudo ./open5gs-bsfd &
sudo ./open5gs-udmd &
sudo ./open5gs-udrd &
sudo ./open5gs-upfd &
sudo ./open5gs-amfd & By default the configuration file will be taken from the open5gs/install/etc/open5gs/ folder. You can change the location of the configuration file by using the -c flag.
SSH into your machine which has the UERANSIM installed, you should explore the folder UERANSIM/. If the installation was done correctly, you should see a build folder with the binaries for all the 5G core services. You can run the following commands to start the services:
./build/nr-gnb -c config/open5gs-gnb.yaml &
./build/nr-ue -c config/open5gs-ue.yaml &Confirm that the gNodeB and UE are connected by checking the logs and looking at the interfaces on the gNodeB. You can further explore each of the config files to understand the parameters that are being used.
nr-cligives you a CLI to interact with the gNodeB and UE states.
If you are using the two VM setup, you can use the following commands to check if the UE is sucessfully able to connect to the internet :
ping google.com -I uesimtun0
curl --interface uesimtun0 -X GET "https://httpbin.org/get"- https://github.com/eatsan/open5gs-ueransim-vagrant-config
- https://open5gs.org/open5gs/docs/guide/02-building-open5gs-from-sources/
- In case of an SCTP error, set the NatNetwork address in the Oracle VM box(/tools/network) to 192.168.56.0/24. Then for both VMs select the network attached to 'NAT network' and promiscuous mode to 'allow all '