From: Mike Stepanek (mstepane) <mstepane@cisco.com>
Date: Tue, 26 Feb 2019 18:11:43 +0000 (-0500)
Subject: Merge pull request #1514 in SNORT/snort3 from ~SMINUT/snort3:appid_client_detection... 
X-Git-Tag: 3.0.0-251~37
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=301d62f365a6e0c451b00336228229d207149526;p=thirdparty%2Fsnort3.git

Merge pull request #1514 in SNORT/snort3 from ~SMINUT/snort3:appid_client_detection to master

Squashed commit of the following:

commit a152575f7f8d071989fd2724601d0be77f27a989
Author: Silviu Minut <sminut@cisco.com>
Date:   Thu Feb 14 10:37:49 2019 -0500

    appid: fix client discovery to only check on the first data packet.

    appid: return void in ClientDiscovery::exec_client_detectors() and set client_disco_state to FINISHED in all cases except when the client validate returns APPID_INPROCESS.

    appid: fix comment in client_discovery.cc.
---

diff --git a/src/network_inspectors/appid/client_plugins/client_discovery.cc b/src/network_inspectors/appid/client_plugins/client_discovery.cc
index fc0ba3f9f..5f99e73d5 100644
--- a/src/network_inspectors/appid/client_plugins/client_discovery.cc
+++ b/src/network_inspectors/appid/client_plugins/client_discovery.cc
@@ -305,7 +305,10 @@ int ClientDiscovery::get_detector_candidates_list(AppIdSession& asd, Packet* p,
     return APPID_SESSION_SUCCESS;
 }
 
-int ClientDiscovery::exec_client_detectors(AppIdSession& asd, Packet* p,
+// This function sets the client discovery state to APPID_DISCO_STATE_FINISHED
+// on anything the client candidates return (including e.g. APPID_ENULL, etc.),
+// except on APPID_INPROCESS, in which case the discovery state remains unchanged.
+void ClientDiscovery::exec_client_detectors(AppIdSession& asd, Packet* p,
     AppidSessionDirection direction, AppidChangeBits& change_bits)
 {
     int ret = APPID_INPROCESS;
@@ -332,7 +335,6 @@ int ClientDiscovery::exec_client_detectors(AppIdSession& asd, Packet* p,
 
             if (result == APPID_SUCCESS)
             {
-                ret = APPID_SUCCESS;
                 asd.client_detector = kv->second;
                 asd.client_candidates.clear();
                 break;
@@ -342,10 +344,19 @@ int ClientDiscovery::exec_client_detectors(AppIdSession& asd, Packet* p,
             else
                 ++kv;
         }
-        // FIXIT-M - Set client as detected/finished when all candidates fails/empty, US#348064
+
+        // At this point, candidates that have survived must have returned
+        // either APPID_SUCCESS or APPID_INPROCESS. The others got removed
+        // from the candidates list. If the list is empty, say we're done.
+        if (asd.client_candidates.empty())
+        {
+            ret = APPID_SUCCESS;
+            asd.set_client_detected();
+        }
     }
 
-    return ret;
+    if (ret != APPID_INPROCESS)
+        asd.client_disco_state = APPID_DISCO_STATE_FINISHED;
 }
 
 bool ClientDiscovery::do_client_discovery(AppIdSession& asd, Packet* p,
@@ -411,26 +422,16 @@ bool ClientDiscovery::do_client_discovery(AppIdSession& asd, Packet* p,
 
     if ( asd.client_disco_state == APPID_DISCO_STATE_DIRECT )
     {
-        int ret = APPID_INPROCESS;
         if ( direction == APP_ID_FROM_INITIATOR )
         {
             /* get out if we've already tried to validate a client app */
             if (!asd.is_client_detected() )
-                ret = exec_client_detectors(asd, p, direction, change_bits);
+                exec_client_detectors(asd, p, direction, change_bits);
         }
         else if ( asd.service_disco_state != APPID_DISCO_STATE_STATEFUL
             && asd.get_session_flags(APPID_SESSION_CLIENT_GETS_SERVER_PACKETS) )
         {
-            ret = exec_client_detectors(asd, p, direction, change_bits);
-        }
-
-        switch (ret)
-        {
-        case APPID_INPROCESS:
-            break;
-        default:
-            asd.client_disco_state = APPID_DISCO_STATE_FINISHED;
-            break;
+            exec_client_detectors(asd, p, direction, change_bits);
         }
     }
     else if ( asd.client_disco_state == APPID_DISCO_STATE_STATEFUL )
@@ -439,22 +440,15 @@ bool ClientDiscovery::do_client_discovery(AppIdSession& asd, Packet* p,
         isTpAppidDiscoveryDone = true;
         if ( !asd.client_candidates.empty() )
         {
-            int ret = 0;
             if ( direction == APP_ID_FROM_INITIATOR )
             {
                 /* get out if we've already tried to validate a client app */
                 if (!asd.is_client_detected())
-                    ret = exec_client_detectors(asd, p, direction, change_bits);
+                    exec_client_detectors(asd, p, direction, change_bits);
             }
             else if ( asd.service_disco_state != APPID_DISCO_STATE_STATEFUL
                 && asd.get_session_flags(APPID_SESSION_CLIENT_GETS_SERVER_PACKETS) )
-                ret = exec_client_detectors(asd, p, direction, change_bits);
-
-            if ( ret < 0 )
-            {
-                asd.set_client_detected();
-                asd.client_disco_state = APPID_DISCO_STATE_FINISHED;
-            }
+                exec_client_detectors(asd, p, direction, change_bits);
         }
         else
         {
@@ -472,4 +466,3 @@ bool ClientDiscovery::do_client_discovery(AppIdSession& asd, Packet* p,
 
     return isTpAppidDiscoveryDone;
 }
-
diff --git a/src/network_inspectors/appid/client_plugins/client_discovery.h b/src/network_inspectors/appid/client_plugins/client_discovery.h
index d16979804..7b59f79af 100644
--- a/src/network_inspectors/appid/client_plugins/client_discovery.h
+++ b/src/network_inspectors/appid/client_plugins/client_discovery.h
@@ -56,7 +56,7 @@ public:
 private:
     ClientDiscovery(AppIdInspector& ins);
     void initialize() override;
-    int exec_client_detectors(AppIdSession&, snort::Packet*,
+    void exec_client_detectors(AppIdSession&, snort::Packet*,
         AppidSessionDirection direction, AppidChangeBits& change_bits);
     ClientAppMatch* find_detector_candidates(const snort::Packet* pkt, IpProtocol);
     void create_detector_candidates_list(AppIdSession&, snort::Packet*);