Add files to facilitate building of openSIP IMS from source

Author: herlesupreeth

.github/workflows/docker-publish.yml

@@ -59,6 +59,9 @@ jobs:
           - image: docker_eupf
             context: eupf
             file: Dockerfile
+          - image: docker_opensips
+            context: opensips_ims_base
+            file: Dockerfile
 
     runs-on: ubuntu-latest
     permissions:

4g-volte-opensips-ims-deploy.yaml

@@ -298,7 +298,7 @@ services:
       default:
         ipv4_address: ${PYHSS_IP}
   icscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: icscf
     dns: ${DNS_IP}
     volumes:
@@ -309,7 +309,6 @@ services:
       - .env
     environment:
       - COMPONENT_NAME=icscf
-    entrypoint: /mnt/icscf/icscf_init.sh
     depends_on:
       - dns
       - mysql
@@ -323,7 +322,7 @@ services:
       default:
         ipv4_address: ${ICSCF_IP}
   scscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: scscf
     dns: ${DNS_IP}
     volumes:
@@ -334,7 +333,6 @@ services:
       - .env
     environment:
       - COMPONENT_NAME=scscf
-    entrypoint: /mnt/scscf/scscf_init.sh
     depends_on:
       - dns
       - mysql
@@ -348,7 +346,7 @@ services:
       default:
         ipv4_address: ${SCSCF_IP}
   pcscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: pcscf
     dns: ${DNS_IP}
     privileged: true
@@ -363,7 +361,6 @@ services:
     environment:
       - COMPONENT_NAME=pcscf
       - DEPLOY_MODE=4G
-    entrypoint: /mnt/pcscf/pcscf_init.sh
     depends_on:
       - dns
       - mysql

README.md

@@ -10,6 +10,7 @@ Quite contrary to the name of the repository, this repository contains docker fi
 - srsRAN_Project (5G gNB) - https://github.com/srsran/srsRAN_Project
 - UERANSIM (5G gNB + 5G UE) - https://github.com/aligungr/UERANSIM
 - eUPF (5G UPF) - https://github.com/edgecomllc/eupf
+- OpenSIPS IMS - https://github.com/OpenSIPS/opensips
 
 ## Tested Setup
 
@@ -69,6 +70,9 @@ docker tag ghcr.io/herlesupreeth/docker_kamailio:master docker_kamailio
 
 docker pull ghcr.io/herlesupreeth/docker_mysql:master
 docker tag ghcr.io/herlesupreeth/docker_mysql:master docker_mysql
+
+docker pull ghcr.io/herlesupreeth/docker_opensips:master
+docker tag ghcr.io/herlesupreeth/docker_opensips:master docker_opensips
 ```
 
 For srsRAN components:
@@ -91,8 +95,14 @@ For OAI components:
 docker pull ghcr.io/herlesupreeth/docker_oai_enb:master
 docker tag ghcr.io/herlesupreeth/docker_oai_enb:master docker_oai_enb
 
-docker pull ghcr.io/herlesupreeth/docker_oai_ue:master
-docker tag ghcr.io/herlesupreeth/docker_oai_ue:master docker_oai_ue
+docker pull ghcr.io/herlesupreeth/docker_oai_gnb:master
+docker tag ghcr.io/herlesupreeth/docker_oai_gnb:master docker_oai_gnb
+```
+
+For EUPF component:
+```
+docker pull ghcr.io/herlesupreeth/docker_eupf:master
+docker tag ghcr.io/herlesupreeth/docker_eupf:master docker_eupf
 ```
 
 ### Build Docker images from source
@@ -119,6 +129,14 @@ docker build --no-cache --force-rm -t docker_srsran .
 # Build docker images for UERANSIM (gNB + UE)
 cd ../ueransim
 docker build --no-cache --force-rm -t docker_ueransim .
+
+# Build docker images for EUPF
+cd ../eupf
+docker build --no-cache --force-rm -t docker_eupf .
+
+# Build docker images for OpenSIPS IMS
+cd ../opensips_ims_base
+docker build --no-cache --force-rm -t docker_opensips .
 ```
 
 #### Build docker images for additional components

custom_deployments/open5gs_hss_cx/4g-volte-opensips-ims-deploy.yaml

@@ -272,7 +272,7 @@ services:
       default:
         ipv4_address: ${MYSQL_IP}
   icscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: icscf
     dns: ${DNS_IP}
     volumes:
@@ -283,7 +283,6 @@ services:
       - .custom_env
     environment:
       - COMPONENT_NAME=icscf
-    entrypoint: /mnt/icscf/icscf_init.sh
     depends_on:
       - dns
       - mysql
@@ -297,7 +296,7 @@ services:
       default:
         ipv4_address: ${ICSCF_IP}
   scscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: scscf
     dns: ${DNS_IP}
     volumes:
@@ -308,7 +307,6 @@ services:
       - .custom_env
     environment:
       - COMPONENT_NAME=scscf
-    entrypoint: /mnt/scscf/scscf_init.sh
     depends_on:
       - dns
       - mysql
@@ -322,7 +320,7 @@ services:
       default:
         ipv4_address: ${SCSCF_IP}
   pcscf:
-    image: opensips/opensips:ims-ce
+    image: docker_opensips
     container_name: pcscf
     dns: ${DNS_IP}
     privileged: true
@@ -337,7 +335,6 @@ services:
     environment:
       - COMPONENT_NAME=pcscf
       - DEPLOY_MODE=4G
-    entrypoint: /mnt/pcscf/pcscf_init.sh
     depends_on:
       - dns
       - mysql

custom_deployments/open5gs_hss_cx/opensips_ims_icscf/icscf_init.sh

@@ -34,6 +34,9 @@ cp /mnt/icscf/freeDiameter.conf /etc/opensips
 cp /mnt/icscf/icscf.dictionary /etc/opensips
 cp /mnt/icscf/opensips.cfg /etc/opensips
 
+# For mi_fifo module.
+mkdir -p /var/run/opensips
+
 sed -i 's|ICSCF_IP|'$ICSCF_IP'|g' /etc/opensips/freeDiameter.conf
 sed -i 's|HSS_IP|'$HSS_IP'|g' /etc/opensips/freeDiameter.conf
 sed -i 's|IMS_DOMAIN|'$IMS_DOMAIN'|g' /etc/opensips/freeDiameter.conf
@@ -48,4 +51,4 @@ sed -i 's|EPC_DOMAIN|'$EPC_DOMAIN'|g' /etc/opensips/opensips.cfg
 # Sync docker time
 #ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
 
-exec /usr/sbin/opensips -F $@
+exec opensips -f /etc/opensips/opensips.cfg -F $@

custom_deployments/open5gs_hss_cx/opensips_ims_icscf/opensips.cfg

@@ -41,7 +41,7 @@ socket=tcp:ICSCF_IP:4060
 alias="icscf.IMS_DOMAIN"
 
 #set module path
-mpath="/usr/lib/x86_64-linux-gnu/opensips/modules"
+mpath="/usr/local/opensips/modules"
 
 ####### Modules Section ########
 ####### http module ######
@@ -77,7 +77,7 @@ loadmodule "sipmsgops.so"
 
 #### FIFO Management Interface
 loadmodule "mi_fifo.so"
-modparam("mi_fifo", "fifo_name", "/run/opensips/opensips_fifo")
+modparam("mi_fifo", "fifo_name", "/var/run/opensips/opensips_fifo")
 modparam("mi_fifo", "fifo_mode", 0666)
 
 #### USeR LOCation module

custom_deployments/open5gs_hss_cx/opensips_ims_scscf/opensips.cfg

@@ -42,7 +42,7 @@ socket=tcp:SCSCF_IP:6060
 alias="scscf.IMS_DOMAIN"
 
 #set module path
-mpath="/usr/lib/x86_64-linux-gnu/opensips/modules"
+mpath="/usr/local/opensips/modules"
 
 ####### Modules Section ########
 
@@ -75,7 +75,7 @@ loadmodule "sipmsgops.so"
 
 #### FIFO Management Interface
 loadmodule "mi_fifo.so"
-modparam("mi_fifo", "fifo_name", "/run/opensips/opensips_fifo")
+modparam("mi_fifo", "fifo_name", "/var/run/opensips/opensips_fifo")
 modparam("mi_fifo", "fifo_mode", 0666)
 
 #### USeR LOCation module
@@ -112,7 +112,7 @@ modparam("aaa_diameter", "aaa_url",
 	"diameter:/etc/opensips/freeDiameter.conf;extra-avps-file:/etc/opensips/scscf.dictionary")
 loadmodule "auth_aka.so"
 modparam("auth_aka", "default_av_mgm", "diameter")
-modparam("auth_aka", "default_qop", "auth,auth-int")
+modparam("auth_aka", "default_qop", "auth")
 loadmodule "aka_av_diameter.so"
 modparam("aka_av_diameter", "realm",
         "scscf.IMS_DOMAIN")

custom_deployments/open5gs_hss_cx/opensips_ims_scscf/scscf_init.sh

@@ -34,6 +34,9 @@ cp /mnt/scscf/freeDiameter.conf /etc/opensips
 cp /mnt/scscf/scscf.dictionary /etc/opensips
 cp /mnt/scscf/opensips.cfg /etc/opensips
 
+# For mi_fifo module.
+mkdir -p /var/run/opensips
+
 while ! mysqladmin ping -h ${MYSQL_IP} --silent; do
 	sleep 5;
 done
@@ -73,4 +76,4 @@ sed -i 's|MYSQL_IP|'$MYSQL_IP'|g' /etc/opensips/opensips.cfg
 # Sync docker time
 #ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
 
-exec /usr/sbin/opensips -F $@
+exec opensips -f /etc/opensips/opensips.cfg -F $@

opensips_ims_base/Dockerfile

@@ -0,0 +1,52 @@
+# BSD 2-Clause License
+
+# Copyright (c) 2020, Supreeth Herle
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+FROM debian:bullseye
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Install updates and dependencies
+RUN apt-get update && \
+	apt-get -y install tcpdump git gcc flex bison make pkg-config iproute2 net-tools iputils-ping \
+					libssl-dev libcurl4-openssl-dev libxml2-dev libpcre2-dev bash-completion g++ autoconf \
+					libmnl-dev libsctp-dev libradcli-dev libradcli4 libjson-c-dev libevent-dev libnghttp2-dev uuid-dev \
+					libfreediameter-dev default-libmysqlclient-dev libpcre3-dev libmicrohttpd-dev librabbitmq-dev \
+					libncurses-dev mariadb-client
+
+# Fetch OpenSIPS code
+RUN mkdir -p /usr/local && cd /usr/local && \
+	git clone https://github.com/OpenSIPS/opensips && \
+	cd opensips && git checkout tags/3.5.5
+
+# Build and Install OpenSIPS
+COPY Makefile.conf /usr/local/opensips
+RUN cd /usr/local/opensips && \
+	make -j`nproc` all | tee make_all.txt && \
+	make install | tee make_install.txt && \
+	ldconfig
+
+COPY opensips_init.sh /
+CMD ["/opensips_init.sh"]