This document provides instructions for installing and configuring the free5GC open source 5G core network on an Ubuntu 18.04 virtual machine. It describes downloading and compiling the free5GC source code, setting up the network interfaces and prerequisites, testing the installation, configuring an eNodeB to connect, making a programmable SIM card, registering the SIM in the core network web interface, and basic troubleshooting steps. The overall process guides the user to build a basic standalone 5G core network on a virtual machine that can connect to an eNodeB and SIM card.

1. free5GC Installation
李家安, 徐浚于
2019.07.19

2. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

3. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

4. Overview (1/4)
● 5G system architecture

5. Overview (2/4)

6. Overview (3/4)
● free5gc
○ open-source project for 5G mobile core network
○ developed by NCTU team
○ with AMF, SMF, UPF implemented
○ can run in all-in-one mode or cluster mode
○ official site: https://www.free5gc.org

7. Overview (4/4)
● Preparation
○ hardware & OS requirement
○ environment setup
● Build the program
○ compile the free5gc source
● Testing
○ run the test script
● Connect eNB & smartphone
○ configure eNB & free5gc
○ register SIM card
● Troubleshooting
○ when & how to use

8. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

9. Hardware(VM) Requirement (1/1)
● minimum hradware requirement
○ CPU: Intel i5 processor
○ RAM: 4GB
○ Disk capacity: 160G
○ NIC card: 1Gbps ethernet card
● recommended
○ CPU: Intel i7 processor
○ RAM: 8GB
○ Disk capacity: 160G
○ NIC card: 10Gbps ethernet card
● VM information
○ Linux kernel: 4.15.0-43-generic
○ we will install free5gc on Ubuntu 18.04

10. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

11. Environment Setup (1/6)
● prerequisties - install mongodb & golang compiler
○ sudo apt-get update
○ sudo apt-get install mongodb wget git
○ sudo systemctl start mongodb ( if deamon not running )
○ wget -q https://storage.googleapis.com/golang/getgo/installer_linux
○ chmod +x installer_linux
○ ./installer_linux
○ source ~/.bash_profile
○ rm -f installer_linux
○ go get -u -v "github.com/gorilla/mux"
○ go get -u -v "golang.org/x/net/http2"
○ go get -u -v "golang.org/x/sys/unix"

12. Environment Setup (2/6)
● Setup tun device
○ verify the availability
○ configure uptun
sudo sh -c "cat << EOF > /etc/systemd/network/99-free5gc.netdev
[NetDev]
Name=uptun
Kind=tun
EOF"

13. Environment Setup (3/6)
● Setup tun device ( cont. )
○ enable & restart networkd
sudo systemctl enable systemd-networkd && sudo systemctl restart systemd-
networkd
○ IPv6 kernel configuration
sysctl -n net.ipv6.conf.uptun.disable_ipv6
(if the output is 0 and IPv6 is enabled, skip the followings)
sudo sh -c "echo 'net.ipv6.conf.uptun.disable_ipv6=0' > /etc/sysctl.d/30-free5gc.conf"
sudo sysctl -p /etc/sysctl.d/30-free5gc.conf

14. Environment Setup (4/6)
● Setup tun device ( cont. )
○ configure the IP address of uptun ( networkd )
sudo sh -c "cat << EOF > /etc/systemd/network/99-free5gc.network
[Match]
Name=uptun
[Network]
Address=45.45.0.1/16
Address=cafe::1/64
EOF"
○ restart networkd
sudo systemctl restart systemd-networkd

15. Environment Setup (5/6)
● Setup tun device ( cont. )
○ configure the IP address of uptun ( networking )
○ add the following lines to /etc/network/interfaces
auto uptun
iface uptun inet static
address 45.45.0.1
netmask 255.255.0.0
iface uptun inet6 static
pre-up modprobe ipv6
address cafe::1
netmask 64
○ restart interface
sudo ip a flush uptun
sudo systemctl restart networking

16. Environment Setup (6/6)
● Verify the status of uptun
sudo apt-get -y install net-tools
ifconfig uptun

17. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

18. Install free5gc (1/1)
● Dependencies
sudo apt-get -y install autoconf libtool gcc pkg-config git flex bison
libsctp-dev libgnutls28-dev libgcrypt-dev libssl-dev libidn11-dev libmongoc-
dev libbson-dev libyaml-dev
● Build the source code
git clone https://bitbucket.org/nctu_5g/free5gc.git
cd free5gc
autoreconf -iv
./configure --prefix=`pwd`/install
make -j `nproc`
make install

19. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

20. Test the installation (1/1)
● Use the program free5gc/test/testngc to check whether the installation is
correct.
● Invoke the following command
./test/testngc -f install/etc/free5gc/test/free5gc.testngc.conf

21. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

22. eNode Setting (1/2)
● Foxconn FC4128 for example
○ Small Cell / Basic / WAN Configuration / IPv4 Configuration
■ Change IP
○ Small Cell / Data Model / Device / Services / FAPService / 1 / FAPControl / LTE / Gateway /
S1SigLinkServerList
■ Change MME IP

23. eNode Setting (2/2)
● Foxconn FC4128 for example
○ Small Cell / Data Model / Device / Services / FAPService / 1 / CellConfig / LTE / EPC
■ Check Ciphering / Integrity / TAC
○ Small Cell / Data Model / Device / Services / FAPService / 1 / CellConfig / LTE / EPC /
PLMNList / 1 / PLMNID
■ Check PLMNID

24. Configure the Core Network
In install/etc/free5gc/free5gc.conf, check:
● amf s1ap IP
○ line 67
● smf upf IP
○ line 162
● amf gummei
○ line 89 - 94
● amf tai
○ line 128 - 132
● upf pfcp IP
○ line 236
● upf gtpu IP
○ line 252

25. s1 setup
Check if eNodeB can connect to Core Network
Run ./free5gc-ngcd

26. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

27. Make a SIM card (1/6)
● Programmable SIM Card:
○ sysmoUSIM SJS1 with ADM keys
○ http://shop.sysmocom.de/products/sysmousim-sjs1
● SIM Card Reader

28. Make a SIM card (2/6)
● Install essential packages
○ sudo apt-get install pcscd pcsc-tools libccid python-dev swig python-setuptools python-pip
libpcsclite-dev
○ sudo pip install pycrypto
● Download PySIM
○ git clone https://git.osmocom.org/pysim.git
● Change to pyscard folder and install
○ cd pyscard path
○ sudo /usr/bin/python setup.py build_ext install

29. Make a SIM card (3/6)
● Verify your reader is ready
○ sudo pcsc_scan

30. Make a SIM card (4/6)
● Check whether your reader can read the SIM card
○ cd <pysim-clone-path>
○ ./pySim-read.py -p 0

31. Make a SIM card (5/6)
● Prepare for the following information
○ MCC: Mobile Country Code ，代表國家
○ MNC: Mobile Network Code ，代表電信業者
○ IMSI: International Mobile Subscriber Identity ，代表 SIM 卡用戶的號碼
○ OP: 電信業者用來產生加密 key 的號碼
○ KI: Authentication key ，給電信商驗證的密碼
○ ICCID: IC 卡獨一無二的識別碼
○ ADM1: 更改 SIM 卡資料的密碼
● IMSI、K、OP/OPc 需要保留備用
○ 用以將 SIM 註冊進 Core Network

32. Make a SIM card (6/6)
● Program your SIM card information
○ ./pySim-prog.py -p 0 -x 208 -y 93 -t sysmoUSIM-SJS1 -i 208930000000003 --
op=8e27b6af0e692e750f32667a3b14605d -k 8baf473f2f8fd09487cccbd7097c6862 -s
8988211000000088313 -a 23605945
● 再用 read 的指令驗證，看看有沒有正確寫入

33. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

34. Register the SIM card
● sudo apt-get -y install nodejs npm
● cd webui && npm install
● npm run dev
● Go to browser => http://localhost:3000
○ Login
■ account: admin
■ password: 1423
○ Add subscriber
■ IMSI: 208930000000003
■ K: 8baf473f2f8fd09487cccbd7097c6862
■ OPc: 8e27b6af0e692e750f32667a3b14605d

35. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

36. Outline
● Overview
● Hardware(VM) requirement
● Environment setup
● Install free5gc
● Test the installation
● Configure & attach eNodeB
● Make a SIM card
● Register the SIM card
● Connecting to the Internet
● Troubleshooting
● Reference

37. Throubleshooting
● ./test/testngc failed
○ If configuration correct?
○ Clean zombie: sudo killall -9 testngc
○ Clean subscriber
■ $ mongo
■ > use free5gc
■ > db.subscriber.find() # Check if subscriber remind
■ > db.subscriber.drop()
■ > db.subscriber.find() # double check if drop the subscriber
● ./free5gc-ngcd failed
○ sudo killall -9 testngc / sudo killall -9 free5gc-ngcd
● ERRR: - The certificate is expired
○ cd support/freeDiameter
○ ./make_certs.sh .
○ cd .. && make install

38. Reference
● https://www.free5gc.org/installation
● https://www.youtube.com/channel/UCywP5Acj50GlhSxZTJXlqtw/videos
● http://inuyashaos.blogspot.com/2018/09/nextepc-sim.html
● https://nextepc.org/