def test_full_search(self, mocked_perform_search, mocked_get_session, mocked_update_session): # # First verify that if there is no CSRF token, the full_search # function will call get_csrf_token to get one # mocked_cookies = Mock() # Use this to mock the member variables mocked_session = Mock(cookies=mocked_cookies) mocked_get_session.return_value = mocked_session client = QRadarAdvisorClient(qradar_host=QRADAR_HOST, advisor_app_id=QRADAR_APP_ID, qradar_token=QRADAR_TOKEN, cafile=QRADAR_VERIFY, log=logging) # # when a QRadarAdvisorClient is instantiated, its http_info shall # has no csrf token # assert not client.http_info.xsrf_token try: mocked_session.get.return_value = _generate_response({}, 400) client.full_search("Does not matter") assert False except CsrfTokenError: # # because the CSRF token is None, full_search has to call get_csrf_token # to get it. Since we returned 400 above, the full_search call # shall throw this exception # assert True # # Now put a CSRF token # client.http_info.xsrf_token = CSRF_TOKEN ret_cookies = {"XSRF-TOKEN": CSRF_TOKEN} mocked_cookies.get_dict.return_value = ret_cookies # # This time full_search will call the full search endpoint # stix_json = {"type": "bundles"} mocked_perform_search.return_value = stix_json search_value = "user:jsmith" ret = client.full_search(search_value) mocked_perform_search.assert_called_with(search_value) assert ret == stix_json
def do_command(self): client = QRadarAdvisorClient(qradar_host=self.system_host, qradar_token=self.system_token, advisor_app_id=self.opts_dict["app_id"], cafile=False, log=logging) search_value = self.opts_dict["search"] try: search_id = int(search_value) # # It is a serach id. # For example: -i 1102 -s 2 # resp = client.full_search_by_id(search_id) except ValueError as e: # # It is not a search_id. Try the full search from start # For example: -i 1102 -s user:jsmith # resp = client.full_search(self.opts_dict["search"]) print(str(resp))
def _qradar_advisor_full_search_function(self, event, *args, **kwargs): """Function: Perform a QRadar Advisor full search on an indicator. The indicator is given as the qradar_advisor_search_value of the input. Another input is qradar_advisor_result_stage. This can be "stage1", "stage2", or "stage3". The return from QRadar Advisor is a report in stix format. Then this function calls util funtions from lib to 1. extract observables from objects 2. generate a html representation of the stix objects 3. generate a summary All of the above 3 will be returned to Resilient server, together with the raw stix """ try: # Get the function parameters: qradar_advisor_search_value = kwargs.get( "qradar_advisor_search_value") # text qradar_advisor_result_stage = self.get_select_param( kwargs.get("qradar_advisor_result_stage") ) # select, values: "stage1", "stage2", "stage3" log = logging.getLogger(__name__) log.info("qradar_advisor_search_value: %s", qradar_advisor_search_value) log.info("qradar_advisor_result_stage: %s", qradar_advisor_result_stage) qradar_verify_cert = True if "verify_cert" in self.options and self.options[ "verify_cert"] == "false": qradar_verify_cert = False yield StatusMessage("starting...") # Warn the user yield StatusMessage( "Watson Search with Local Context could take up to 15 minutes..." ) stix_json = None client = QRadarAdvisorClient( qradar_host=self.options["qradar_host"], qradar_token=self.options["qradar_advisor_token"], advisor_app_id=self.options["qradar_advisor_app_id"], cafile=qradar_verify_cert, log=log) full_search_timeout = self.options.get("full_search_timeout", 1200) full_search_period = self.options.get("full_search_period", 5) log.debug("Using timeout: {}".format(str(full_search_timeout))) log.debug("Using period: {}".format(str(full_search_period))) client.full_search_timeout = int(full_search_timeout) client.full_search_period = int(full_search_period) client.set_full_search_stage(qradar_advisor_result_stage) stix_json = client.full_search(qradar_advisor_search_value) # # extract list of observables from this stix bundle # observables = stix_utils.get_observables(stix_json=stix_json, log=log) # # generate a folder-tree like structure in html for this stix bundle # html_str = stix_tree.get_html(stix_json, log) yield StatusMessage("Returning {} observables".format( str(len(observables)))) # # no insights # summary = "Watson Search with Local Context of indicator {} returns {} observables.".format( qradar_advisor_search_value, str(len(observables))) if len(observables) == 1: summary = "Watson Search with Local Context of indicator {} returns {} observable.".format( qradar_advisor_search_value, str(len(observables))) results = { "observables": observables, "note": html_str, "summary": summary, "stix": stix_json } # Produce a FunctionResult with the results yield FunctionResult(results) except Exception as e: log.error(e.message) yield FunctionError(e.message)