Merge pull request #2742 from RestComm/issue_2741

jaimecasero · web-flow · commit 870a19724110 · 2018-04-04T15:10:20.000+02:00
Support for SBC in front of Restcomm Pull Request Review
diff --git a/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/advanced.conf b/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/advanced.conf
@@ -152,3 +152,8 @@ CACHE_NO_WAV=false
 
 #MSS Configuration
 TLS_CLIENT_AUTH_TYPE="Disabled" #Possible values Enabled, Want, Disabled,DisabledAll
+
+#USESBC: Option to disable all patch for NAT (Includes patch-for-nat-b2bua-sessions,disable-sdp-patching-on-updating-mediasession)
+RCUSESBC=false
+#Domain to be used in the SIP URI <user>@<domain>. If not defined, it will default to the webapp host name.
+WebOlympusDomain=""
diff --git a/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/autoconfig.d/config-olympus.sh b/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/autoconfig.d/config-olympus.sh
@@ -38,9 +38,16 @@ FILE=$BASEDIR/standalone/deployments/olympus.war/resources/xml/olympus.xml
 }
 
 
+DomainConf(){
+#Configure Web Olympus Domain.
+FILE=$BASEDIR/standalone/deployments/olympus.war/resources/xml/olympus.xml
+echo "WebOlympusDomain: $WebOlympusDomain"
+  xmlstarlet ed -L -P -u  "/olympus/server/address" -v ${WebOlympusDomain} $FILE
+}
 
 
 # MAIN
 echo 'Configuring Olympus...'
 #Reload Variables
 olympusPortConf
+DomainConf
diff --git a/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/autoconfig.d/config-restcomm.sh b/restcomm/configuration/config-scripts/as7-config-scripts/restcomm/autoconfig.d/config-restcomm.sh
@@ -687,6 +687,10 @@ otherRestCommConf(){
     echo "CACHE_NO_WAV $CACHE_NO_WAV"
     sed -i "s|<cache-no-wav>.*</cache-no-wav>|<cache-no-wav>${CACHE_NO_WAV}</cache-no-wav>|" $FILE
 
+    #Configure USESBC
+    echo "USESBC: $RCUSESBC"
+    sed -i "s|<use-sbc>.*</use-sbc>|<use-sbc>${RCUSESBC}</use-sbc>|" $FILE
+
     echo "End Rest RestComm configuration"
 }
 
diff --git a/restcomm/restcomm.application/src/main/webapp/WEB-INF/conf/restcomm.xml b/restcomm/restcomm.application/src/main/webapp/WEB-INF/conf/restcomm.xml
@@ -173,6 +173,10 @@
 			If set to false RestComm will use the Request URI to determine the destination. -->
 		<use-to>true</use-to>
 
+		<!-- if this flag is set to true, it will disable all patching done for NAT
+		 even if they are enabled in the configuration file-->
+		<use-sbc>false</use-sbc>
+
 		<!-- If set to true Restcomm will use the Local Address (or external address
 			if available) in the host part of the From header for calls to the outbound
 			proxy. Default is False, which means that Restcomm will use outbound proxy
diff --git a/restcomm/restcomm.dao/src/test/java/org/restcomm/connect/dao/mybatis/ExtensionConfigurationDaoTest.java b/restcomm/restcomm.dao/src/test/java/org/restcomm/connect/dao/mybatis/ExtensionConfigurationDaoTest.java
@@ -6,6 +6,7 @@
 import org.joda.time.DateTime;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 import org.restcomm.connect.commons.annotations.UnstableTests;
@@ -28,6 +29,7 @@
  * Created by gvagenas on 21/10/2016.
  */
 @Category(UnstableTests.class)
+@Ignore
 public class ExtensionConfigurationDaoTest {
     private static MybatisDaoManager manager;
     private MybatisExtensionsConfigurationDao extensionsConfigurationDao;
diff --git a/restcomm/restcomm.extension.controller/src/test/java/org.restcomm.connect.extension.controller/ExtensionsControllerTest.java b/restcomm/restcomm.extension.controller/src/test/java/org.restcomm.connect.extension.controller/ExtensionsControllerTest.java
@@ -19,12 +19,14 @@
 
 package org.restcomm.connect.extension.controller;
 
+import java.util.List;
+
+import javax.servlet.ServletContext;
+
 import org.apache.log4j.Logger;
+import org.junit.After;
 import org.junit.Assert;
-import org.junit.Ignore;
 import org.junit.Test;
-import org.junit.experimental.categories.Category;
-import org.restcomm.connect.commons.annotations.UnstableTests;
 import org.restcomm.connect.commons.dao.Sid;
 import org.restcomm.connect.extension.api.ApiRequest;
 import org.restcomm.connect.extension.api.ExtensionRequest;
@@ -34,10 +36,6 @@
 import org.restcomm.connect.extension.api.RestcommExtension;
 import org.restcomm.connect.extension.api.RestcommExtensionGeneric;
 
-import javax.servlet.ServletContext;
-import java.util.List;
-import org.junit.After;
-
 public class ExtensionsControllerTest {
 
     private static Logger logger = Logger.getLogger(ExtensionsControllerTest.class);
diff --git a/restcomm/restcomm.interpreter/src/main/java/org/restcomm/connect/interpreter/VoiceInterpreter.java b/restcomm/restcomm.interpreter/src/main/java/org/restcomm/connect/interpreter/VoiceInterpreter.java
@@ -2896,6 +2896,10 @@ public void execute(final Object message) throws Exception {
                         return;
                     } else {
                         if (callState == CallStateChanged.State.IN_PROGRESS) {
+                            if (logger.isInfoEnabled()) {
+                                String msg = String.format("At finishDialingState, will ASK call to hangup. Current VI State %s Call State: %s ",state, callState);
+                                logger.info(msg);
+                            }
                             call.tell(new Hangup(), self());
                         } else {
                             if (logger.isInfoEnabled()) {
diff --git a/restcomm/restcomm.sms/src/main/java/org/restcomm/connect/sms/SmsService.java b/restcomm/restcomm.sms/src/main/java/org/restcomm/connect/sms/SmsService.java
@@ -151,6 +151,13 @@ public SmsService(final Configuration configuration, final SipFactory factory,
         // final Configuration runtime = configuration.subset("runtime-settings");
         // TODO this.useTo = runtime.getBoolean("use-to");
         patchForNatB2BUASessions = runtime.getBoolean("patch-for-nat-b2bua-sessions", true);
+        boolean useSbc = runtime.getBoolean("use-sbc", false);
+        if(useSbc) {
+            if (logger.isDebugEnabled()) {
+                logger.debug("SmsService: use-sbc is true, overriding patch-for-nat-b2bua-sessions to false");
+            }
+            patchForNatB2BUASessions = false;
+        }
 
         extensions = ExtensionController.getInstance().getExtensions(ExtensionType.SmsService);
         if (logger.isInfoEnabled()) {
diff --git a/restcomm/restcomm.telephony.api/src/main/java/org/restcomm/connect/telephony/api/util/B2BUAHelper.java b/restcomm/restcomm.telephony.api/src/main/java/org/restcomm/connect/telephony/api/util/B2BUAHelper.java
@@ -120,20 +120,37 @@ public static boolean redirectToB2BUA(final ActorSystem system, final SipServlet
                  final String aor = registration.getAddressOfRecord();
                  SipURI to;
                  SipURI from;
-                 to = (SipURI) sipFactory.createURI(location);
+                 SipURI locationURI = null;
+
                  Sid fromOrganizationSid = OrganizationUtil.getOrganizationSidBySipURIHost(storage, (SipURI) request.getFrom().getURI());
                  // if both clients don't belong to same organization, call should not be allowed.
                  if(!toOrganizationSid.equals(fromOrganizationSid)){
                      logger.warn(String.format("B2B clients do not belong to same organization. from-client: %s belong to %s . where as to-client %s belong to %s", client.getLogin(), fromOrganizationSid, user, toOrganizationSid));
                      return false;
                  }
-                 from = (SipURI) sipFactory.createURI((registrations.getRegistration(client.getLogin(), fromOrganizationSid)).getLocation());
+                 if(patchForNat) {
+                     to = (SipURI) sipFactory.createURI(location);
+                     from = (SipURI) sipFactory.createURI((registrations.getRegistration(client.getLogin(), fromOrganizationSid)).getLocation());
+                 } else {
+                     // https://github.com/RestComm/Restcomm-Connect/issues/2741 support for SBC
+                     if (logger.isDebugEnabled()) {
+                         logger.debug("B2BUA not patched for NAT, using address of record for to and from");
+                     }
+                     to = (SipURI) sipFactory.createURI(aor);
+                     locationURI = (SipURI) sipFactory.createURI(location);
+                     from = (SipURI) sipFactory.createURI((registrations.getRegistration(client.getLogin(), fromOrganizationSid)).getAddressOfRecord());
+                 }
+
                  final SipSession incomingSession = request.getSession();
                  // create and send the outgoing invite and do the session linking
                  incomingSession.setAttribute(B2BUA_LAST_REQUEST, request);
                  SipServletRequest outRequest = sipFactory.createRequest(request.getApplicationSession(), request.getMethod(),
                          from, to);
-                 outRequest.setRequestURI(to);
+                 if(patchForNat) {
+                     outRequest.setRequestURI(to);
+                 } else {
+                     outRequest.setRequestURI(locationURI);
+                 }
 
                  if (request.getContent() != null) {
                      final byte[] sdp = request.getRawContent();
diff --git a/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/Call.java b/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/Call.java
@@ -254,6 +254,7 @@ public final class Call extends RestcommUntypedActor implements TransitionEndLis
     private Configuration runtimeSettings;
     private Configuration configuration;
     private boolean disableSdpPatchingOnUpdatingMediaSession;
+    private boolean useSbc;
 
     private Sid inboundCallSid;
     private boolean inboundConfirmCall;
@@ -435,6 +436,14 @@ public Call(final Sid accountSid, final SipFactory factory, final MediaServerCon
         this.configuration = configuration;
         final Configuration runtime = this.configuration.subset("runtime-settings");
         this.disableSdpPatchingOnUpdatingMediaSession = runtime.getBoolean("disable-sdp-patching-on-updating-mediasession", false);
+        this.useSbc = runtime.getBoolean("use-sbc", false);
+        if(useSbc) {
+            if (logger.isDebugEnabled()) {
+                logger.debug("Call: use-sbc is true, disable-sdp-patching-on-updating-mediasession to true");
+            }
+            disableSdpPatchingOnUpdatingMediaSession = true;
+        }
+
         this.enable200OkDelay = runtime.getBoolean("enable-200-ok-delay",false);
         if(!runtime.subset("ims-authentication").isEmpty()){
             final Configuration imsAuthentication = runtime.subset("ims-authentication");
@@ -1001,7 +1010,9 @@ public void execute(Object message) throws Exception {
             } else {
                 invite = ((SipFactoryExt)factory).createRequestWithCallID(application, "INVITE", from, to, callId);
             }
-            invite.pushRoute(uri);
+            if(!useSbc) {
+                invite.pushRoute(uri);
+            }
 
             if(userAgent!=null){
                 invite.setHeader("User-Agent", userAgent);
@@ -2185,6 +2196,8 @@ private void onSipServletResponse(SipServletResponse message, ActorRef self, Act
                         uri.setLrParam(true);
                         challengeRequest.pushRoute(uri);
                     }
+                    //FIXME:should check for the Ims pushed Route?
+                    B2BUAHelper.addHeadersToMessage(challengeRequest, extensionHeaders, factory);
                     challengeRequest.send();
                 }
                 break;
diff --git a/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/CallManager.java b/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/CallManager.java
@@ -203,6 +203,7 @@ public final class CallManager extends RestcommUntypedActor {
 
     //Control whether Restcomm will patch Request-URI and SDP for B2BUA calls
     private boolean patchForNatB2BUASessions;
+    private boolean useSbc;
 
     //List of extensions for CallManager
     List<RestcommExtensionGeneric> extensions;
@@ -317,6 +318,13 @@ public CallManager(final Configuration configuration, final ServletContext conte
         allowFallbackToPrimary = outboundProxyConfig.getBoolean("allow-fallback-to-primary", false);
 
         patchForNatB2BUASessions = runtime.getBoolean("patch-for-nat-b2bua-sessions", true);
+        useSbc = runtime.getBoolean("use-sbc", false);
+        if(useSbc) {
+            if (logger.isDebugEnabled()) {
+                logger.debug("CallManager: use-sbc is true, overriding patch-for-nat-b2bua-sessions to false");
+            }
+            patchForNatB2BUASessions = false;
+        }
 
         //Monitoring Service
         this.monitoring = (ActorRef) context.getAttribute(MonitoringService.class.getName());
@@ -503,7 +511,7 @@ private void invite(final Object message) throws IOException, NumberParseExcepti
         final SipURI fromUri = (SipURI) request.getFrom().getURI();
         final String fromUser = fromUri.getUser();
         final SipURI toUri = (SipURI) request.getTo().getURI();
-        final String toUser = CallControlHelper.getUserSipId(request, useTo);
+        String toUser = CallControlHelper.getUserSipId(request, useTo);
         final String ruri = ((SipURI) request.getRequestURI()).getHost();
         final String toHost = toUri.getHost();
         final String toHostIpAddress = DNSUtils.getByName(toHost).getHostAddress();
@@ -687,6 +695,13 @@ public void run() {
                 String errMsg = "A Restcomm Client is trying to call a Number/DID that is not registered with Restcomm";
                 sendNotification(client.getAccountSid(), errMsg, 11002, "info", true);
 
+                if(useSbc) {
+                    toUser = toUser+"@"+ruri;
+                    if (logger.isDebugEnabled()) {
+                        logger.debug("CallManager: use-sbc is true, overriding webrtc toUser to " + toUser);
+                    }
+                }
+
                 ExtensionController ec = ExtensionController.getInstance();
                 IExtensionCreateCallRequest er = new CreateCall(fromUser, toUser, "", "", false, 0, CreateCallType.PSTN, client.getAccountSid(), null, null, null, null);
                 ExtensionResponse extRes = ec.executePreOutboundAction(er, this.extensions);
@@ -2006,6 +2021,12 @@ private void outboundToClient(final CreateCall request, final ActorRef sender, f
                     logger.warning(errMsg);
                     sender.tell(new CallManagerResponse<ActorRef>(new NullPointerException(errMsg), request), self());
                 } else {
+                    if(useSbc) {
+                        // To avoid using SDP with encryption enabled between RC and the SBC
+                        // we need to disable webRTC as it will be handled on the last mile
+                        // ie between SBC and Client and SBC will be responsible for that not RC
+                        webRTC = false;
+                    }
                     calls.add(createOutbound(request, from, to, webRTC));
                 }
             }
diff --git a/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/ua/UserAgentManager.java b/restcomm/restcomm.telephony/src/main/java/org/restcomm/connect/telephony/ua/UserAgentManager.java
diff --git a/restcomm/restcomm.testsuite/src/test/java/org/restcomm/connect/testsuite/telephony/DialActionOrganizationSBCTest.java b/restcomm/restcomm.testsuite/src/test/java/org/restcomm/connect/testsuite/telephony/DialActionOrganizationSBCTest.java
diff --git a/restcomm/restcomm.testsuite/src/test/java/org/restcomm/connect/testsuite/telephony/ua/UserAgentManagerWithSBCTest.java b/restcomm/restcomm.testsuite/src/test/java/org/restcomm/connect/testsuite/telephony/ua/UserAgentManagerWithSBCTest.java
diff --git a/restcomm/restcomm.testsuite/src/test/resources/restcomm_UserAgentManagerWithSBCTest.xml b/restcomm/restcomm.testsuite/src/test/resources/restcomm_UserAgentManagerWithSBCTest.xml
diff --git a/restcomm/restcomm.testsuite/src/test/resources/restcomm_sbc.xml b/restcomm/restcomm.testsuite/src/test/resources/restcomm_sbc.xml

Original file line number	Diff line number	Diff line change
`@@ -687,6 +687,10 @@ otherRestCommConf(){`
`687`	`687`	`echo "CACHE_NO_WAV $CACHE_NO_WAV"`
`688`	`688`	`sed -i "s\|<cache-no-wav>.*</cache-no-wav>\|<cache-no-wav>${CACHE_NO_WAV}</cache-no-wav>\|" $FILE`
`689`	`689`
	`690`	`+ #Configure USESBC`
	`691`	`+ echo "USESBC: $RCUSESBC"`
	`692`	`+ sed -i "s\|<use-sbc>.*</use-sbc>\|<use-sbc>${RCUSESBC}</use-sbc>\|" $FILE`
	`693`	`+`
`690`	`694`	`echo "End Rest RestComm configuration"`
`691`	`695`	`}`
`692`	`696`