Merge pull request #3 from splunk/bug-fix

lingy1028 · web-flow · commit 2faa1c458a07 · 2025-06-18T17:57:45.000-04:00
Bug fix
diff --git a/globalConfig.json b/globalConfig.json
@@ -2,7 +2,7 @@
     "meta": {
         "name": "ta_cisco_webex_add_on_for_splunk",
         "displayName": "Cisco Webex Add-on for Splunk",
-        "version": "1.0.9",
+        "version": "1.0.10",
         "restRoot": "ta_cisco_webex_add_on_for_splunk",
         "schemaVersion": "0.0.9",
         "supportedThemes": [
diff --git a/package/app.manifest b/package/app.manifest
@@ -5,7 +5,7 @@
     "id": {
       "group": null, 
       "name": "ta_cisco_webex_add_on_for_splunk", 
-      "version": "1.0.9"
+      "version": "1.0.10"
     }, 
     "author": [
       {
diff --git a/package/bin/input_module_webex_meetings.py b/package/bin/input_module_webex_meetings.py
@@ -118,7 +118,7 @@ def collect_events(helper, ew):
         )
 
     # get user list
-    people_params = {"max": 1000}
+    people_params = {}
     users = paging_get_request_to_webex(
         helper,
         base_endpoint,
diff --git a/package/bin/ta_cisco_webex_add_on_for_splunk_rh_oauth.py b/package/bin/ta_cisco_webex_add_on_for_splunk_rh_oauth.py
@@ -1,8 +1,7 @@
-
-import import_declare_test
 """
 This module will be used to get oauth token from auth code
 """
+import import_declare_test
 
 import urllib
 try:
@@ -13,26 +12,24 @@
 import splunk.admin as admin
 from solnlib import log
 from solnlib import conf_manager
+from solnlib.conf_manager import InvalidHostnameError, InvalidPortError
 from solnlib.utils import is_true
 import json
-import requests
 
 
 log.Logs.set_context()
 logger = log.Logs().get_logger('ta_cisco_webex_add_on_for_splunk_rh_oauth2_token')
 
-# Note: Comment L30 to get rid of the following error
-# Python ERROR: AttributeError: module 'socks' has no attribute 'PROXY_TYPE_HTTP_NO_TUNNEL'
-# UI ERROR: 500 Internal Server Error
-
 # Map for available proxy type
 _PROXY_TYPE_MAP = {
     'http': socks.PROXY_TYPE_HTTP,
-    # 'http_no_tunnel': socks.PROXY_TYPE_HTTP_NO_TUNNEL,
     'socks4': socks.PROXY_TYPE_SOCKS4,
     'socks5': socks.PROXY_TYPE_SOCKS5,
 }
 
+if hasattr(socks, 'PROXY_TYPE_HTTP_NO_TUNNEL'):
+    _PROXY_TYPE_MAP['http_no_tunnel'] = socks.PROXY_TYPE_HTTP_NO_TUNNEL
+
 """
 REST Endpoint of getting token by OAuth2 in Splunk Add-on UI Framework. T
 """
@@ -44,14 +41,33 @@ class ta_cisco_webex_add_on_for_splunk_rh_oauth2_token(admin.MConfigHandler):
     This method checks which action is getting called and what parameters are required for the request.
     """
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        session_key = self.getSessionKey()
+        log_level = conf_manager.get_log_level(
+            logger=logger,
+            session_key=session_key,
+            app_name="ta_cisco_webex_add_on_for_splunk",
+            conf_name="ta_cisco_webex_add_on_for_splunk_settings",
+            log_stanza="logging",
+            log_level_field="loglevel"
+        )
+        log.Logs().set_level(log_level)
+
     def setup(self):
         if self.requestedAction == admin.ACTION_EDIT:
             # Add required args in supported args
             for arg in ('url', 'method',
-                        'grant_type', 'code',
-                        'client_id', 'client_secret',
-                        'redirect_uri'):
+                        'grant_type', 'client_id',
+                        'client_secret'):
                 self.supportedArgs.addReqArg(arg)
+
+            for arg in (
+                'scope',  # Optional for client_credentials
+                'code',  # Required for authorization_code
+                'redirect_uri',  # Required for authorization_code
+            ):
+                self.supportedArgs.addOptArg(arg)
         return
 
     """
@@ -69,63 +85,93 @@ def handleEdit(self, confInfo):
             logger.debug("oAUth url %s", url)
             proxy_info = self.getProxyDetails()
 
+            http = Http(proxy_info=proxy_info)
+            method = self.callerArgs.data['method'][0]
+
             # Create payload from the arguments received
+            grant_type = self.callerArgs.data['grant_type'][0]
+
             payload = {
                 'grant_type': self.callerArgs.data['grant_type'][0],
-                'code': self.callerArgs.data['code'][0],
                 'client_id': self.callerArgs.data['client_id'][0],
                 'client_secret': self.callerArgs.data['client_secret'][0],
-                'redirect_uri': self.callerArgs.data['redirect_uri'][0],
             }
-            headers = {"Content-Type": "application/x-www-form-urlencoded", }
 
-            response = requests.request(
-                "POST", url, headers=headers, data=urlencode(payload), proxies=proxy_info, verify=False
-            )
+            if grant_type == "authorization_code":
+                # If grant_type is authorization_code then add code and redirect_uri in payload
+                for param_name in ('code', 'redirect_uri'):
+                    param = self.callerArgs.data.get(param_name, [None])[0]
+
+                    if param is None:
+                        raise ValueError(
+                            "%s is required for authorization_code grant type" % param_name
+                        )
 
-            content = response.json()
+                    payload[param_name] = param
+            elif grant_type == "client_credentials":
+                # If grant_type is client_credentials add scope exists then add it in payload
+                scope = self.callerArgs.data.get('scope', [None])[0]
 
+                if scope:
+                    payload['scope'] = scope
+            else:
+                # Else raise an error
+                logger.error("Invalid grant_type %s", grant_type)
+                raise ValueError(
+                    "Invalid grant_type %s. Supported values are authorization_code and client_credentials" % grant_type
+                )
+
+            headers = {"Content-Type": "application/x-www-form-urlencoded", }
+            # Send http request to get the accesstoken
+            resp, content = http.request(url,
+                                         method=method,
+                                         headers=headers,
+                                         body=urlencode(payload))
+            content = json.loads(content)
             # Check for any errors in response. If no error then add the content values in confInfo
-            if response.status_code == 200:
+            if resp.status == 200:
                 for key, val in content.items():
                     confInfo['token'][key] = val
             else:
                 # Else add the error message in the confinfo
-                confInfo['token']['error'] = content['message']
+                confInfo['token']['error'] = content['error_description']
             logger.info(
-                "Exiting OAuth rest handler after getting access token with response %s", response.status_code)
+                "Exiting OAuth rest handler after getting access token with response %s", resp.status)
         except Exception as exc:
             logger.exception(
-                "Error occurred while getting access token using auth code")
-            raise exc()
+                "Error occurred while getting accesstoken using auth code")
+            raise
 
     """
     This method is to get proxy details stored in settings conf file
     """
 
     def getProxyDetails(self):
-        # Create confmanger object for the app with realm
-        cfm = conf_manager.ConfManager(self.getSessionKey(
-        ), "ta_cisco_webex_add_on_for_splunk", realm="__REST_CREDENTIAL__#ta_cisco_webex_add_on_for_splunk#configs/conf-ta_cisco_webex_add_on_for_splunk_settings")
-        # Get Conf object of apps settings
-        conf = cfm.get_conf('ta_cisco_webex_add_on_for_splunk_settings')
-        # Get proxy stanza from the settings
-        proxy_config = conf.get("proxy", True)
+        proxy_config = None
+
+        try: 
+            proxy_config = conf_manager.get_proxy_dict(
+                logger=logger,
+                session_key=self.getSessionKey(),
+                app_name="ta_cisco_webex_add_on_for_splunk",
+                conf_name="ta_cisco_webex_add_on_for_splunk_settings",
+            )
+
+        # Handle invalid port case
+        except InvalidPortError as e:
+            logger.error(f"Proxy configuration error: {e}")
+
+        # Handle invalid hostname case
+        except InvalidHostnameError as e:
+            logger.error(f"Proxy configuration error: {e}")
+
         if not proxy_config or not is_true(proxy_config.get('proxy_enabled')):
             logger.info('Proxy is not enabled')
             return None
 
         url = proxy_config.get('proxy_url')
         port = proxy_config.get('proxy_port')
 
-        if url or port:
-            if not url:
-                raise ValueError('Proxy "url" must not be empty')
-            if not self.is_valid_port(port):
-                raise ValueError(
-                    'Proxy "port" must be in range [1,65535]: %s' % port
-                )
-
         user = proxy_config.get('proxy_username')
         password = proxy_config.get('proxy_password')
 
@@ -162,11 +208,5 @@ def getProxyDetails(self):
     :type port: ``int``
     """
 
-    def is_valid_port(self, port):
-        try:
-            return 0 < int(port) <= 65535
-        except ValueError:
-            return False
-
 if __name__ == "__main__":
     admin.init(ta_cisco_webex_add_on_for_splunk_rh_oauth2_token, admin.CONTEXT_APP_AND_USER)
diff --git a/package/default/app.conf b/package/default/app.conf
@@ -5,7 +5,7 @@ build = 1
 
 [launcher]
 author = FDSE
-version = 1.0.9
+version = 1.0.10
 description = 
 
 [ui]
@@ -17,7 +17,7 @@ docs_section_override = AddOns:released
 id = ta_cisco_webex_add_on_for_splunk
 
 [id]
-version = 1.0.9
+version = 1.0.10
 
 [triggers]
 reload.ta_cisco_webex_add_on_for_splunk_account = simple
diff --git a/package/default/inputs.conf b/package/default/inputs.conf
@@ -26,3 +26,10 @@ python.version = python3
 sourcetype = cisco:webex:meeting:qualities
 interval = 60
 
+[webex_detailed_call_history]
+index = default
+start_by_shell = false
+python.version = python3
+sourcetype = cisco:webex:call:detailed_history
+interval = 60
+
diff --git a/package/default/props.conf b/package/default/props.conf
@@ -28,6 +28,12 @@ category = Splunk App Add-on Builder
 pulldown_type = 1
 MAX_TIMESTAMP_LOOKAHEAD = 1
 
+[cisco:webex:call:detailed_history]
+SHOULD_LINEMERGE = 0
+category = Splunk App Add-on Builder
+pulldown_type = 1
+MAX_TIMESTAMP_LOOKAHEAD = 1
+
 [source::...ta-cisco-webex-add-on-for-splunk*.log*]
 SHOULD_LINEMERGE = true
 sourcetype = taciscowebexaddonforsplunk:log

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`"id": {`
`6`	`6`	`"group": null,`
`7`	`7`	`"name": "ta_cisco_webex_add_on_for_splunk",`
`8`		`- "version": "1.0.9"`
	`8`	`+ "version": "1.0.10"`
`9`	`9`	`},`
`10`	`10`	`"author": [`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ def collect_events(helper, ew):`
`118`	`118`	`)`
`119`	`119`
`120`	`120`	`# get user list`
`121`		`- people_params = {"max": 1000}`
	`121`	`+ people_params = {}`
`122`	`122`	`users = paging_get_request_to_webex(`
`123`	`123`	`helper,`
`124`	`124`	`base_endpoint,`