[WIP] Add missing support for reports

.travis.yml

@@ -15,4 +15,4 @@ install:
   - pip install -r requirements_test.txt
 script:
   - if [[ $TRAVIS_PYTHON_VERSION != 2.6 ]]; then flake8; fi
-  - py.test tests
+  - py.test --vcr-record-mode=none tests

demo/run_demo.py

@@ -677,6 +677,37 @@ def DemonstrateTicketAPI():
             print("      Comment:", repr(event.comment))
 
 
+def DemonstrateReportAPI():
+    print('Report API')
+    print('----------')
+
+    # TODO: show off more of the report API functionality than just a single config save/delete
+    report = nexpose.ReportConfiguration('Python API Client Test Report', 'audit-report', 'raw-xml-v2')
+    report.add_filter('scan', 'last')  # this should use site/group/tag filter(s) instead of scan in real world use
+    report.add_common_vuln_filters()  # adds vuln filters to match UI defaults
+
+    # these imports should be at the top, or perhaps be auto imports in the init file?
+    from nexpose.nexpose_report import Email, Delivery, Frequency, Schedule
+    email = Email(True, send_as='file')
+    email.smtp_relay_server = 'whatever.example.com'
+    email.sender = 'whatever@example.com'
+    email.recipients.append('someone@example.com')
+    delivery = Delivery(True, None, email)
+    report.delivery = delivery
+    schedule = Schedule('weekly', 1, "20171105T164239700")
+    freq = Frequency(False, True, schedule)
+    report.frequency = freq
+    report.timezone = 'America/Los_Angeles'
+
+    print('Saving report configuration...')
+    resp = session.SaveReportConfiguration(report)
+    print('Saved Report ID: {}'.format(resp))
+
+    print('Deleting report configuration with ID {}...'.format(resp))
+    session.DeleteReportConfiguration(resp)
+    print('Done with Report API demo.')
+
+
 def GetNexposeLoginSettings():
     """
     Returns a list with following information: hostname_or_ip, port, username, password.
@@ -720,13 +751,14 @@ def main():
     #DemonstrateVulnerabilityAPI()
     #DemonstrateVulnerabilityExceptionAPI()
     #DemonstrateRoleAPI()
-    DemonstrateSiteAPI()
+    #DemonstrateSiteAPI()
     #DemonstrateEngineAPI()
     #DemonstrateDiscoveryConnectionAPI()
     #DemonstrateScanPI()
     #DemonstrateUserAPI()
     #DemonstrateAssetGroupAPI()
     #DemonstrateTicketAPI()
+    #DemonstrateReportAPI()
 
     #print session.GenerateScanReport(1)
 

nexpose/nexpose.py

@@ -24,7 +24,7 @@
 from .nexpose_engine import EngineStatus, EnginePriority, EngineBase, EngineSummary, EngineConfiguration
 from .nexpose_node import NodeScanStatus, NodeBase, Node
 from .nexpose_privileges import AssetGroupPrivileges, GlobalPrivileges, SitePrivileges
-from .nexpose_report import ReportStatus, ReportTemplate, ReportConfigurationSummary, ReportConfiguration, ReportSummary
+from .nexpose_report import AdhocReportConfiguration, ReportStatus, ReportTemplate, ReportConfigurationSummary, ReportConfiguration, ReportSummary
 from .nexpose_role import RoleScope, RoleSummary, RoleDetails
 from .nexpose_scansummary import VulnerabilityStatus, ScanStatus, ScanSummary, ScanSummaryNodeCounts, ScanSummaryTaskCounts, ScanSummaryVulnerability
 from .nexpose_site import Host, Range, SiteBase, SiteSummary, SiteConfiguration
@@ -284,7 +284,7 @@ def GetSecurityConsoleStatus(self):
         try:
             response = OpenWebRequest(self._URI_root, None, {}, self.timeout)
             return NexposeStatus.GetStatusFromURL(response.geturl())
-        except:
+        except Exception:
             return NexposeStatus.UNKNOWN
 
 
@@ -596,10 +596,15 @@ def RequestReportConfig(self, reportconfiguration_id):
         Retreive the detailed report configuration (definition) of the specified report configuration.
         This function will return a single ReportConfigResponse XML object (API 1.1).
         """
-        return self.ExecuteBasicOnReportConfiguration("ReportConfigRequest", reportconfiguration_id)
+        response = self.ExecuteBasicOnReportConfiguration("ReportConfigRequest", reportconfiguration_id)
+        return get_element(response, 'ReportConfig')
 
-    def RequestReportSave(self):
-        raise NotImplementedError()  # TODO
+    def RequestReportSave(self, report_configuration, generate_now=False):
+        """
+        Save a report configuration and optionally generate a report immediately.
+        This function will return a single ReportSaveResponse XML object (API 1.1).
+        """
+        return self.ExecuteBasicWithElement('ReportSaveRequest', {'generate-now': 1 if generate_now else 0}, report_configuration)
 
     def RequestReportGenerate(self, reportconfiguration_id):
         """
@@ -620,6 +625,13 @@ def RequestReportDelete(self, report_id, reportconfiguration_id=0):
         else:
             return self.ExecuteBasicOnReport("ReportDeleteRequest", report_id)
 
+    def RequestAdhocReport(self, report_config):
+        """
+        Generate a new report using the specified report configuration (definition).
+        This function will return a single ReportGenerateResponse XML object (API 1.1).
+        """
+        return self.ExecuteBasicWithElement('ReportAdhocGenerateRequest', {}, as_xml(report_config))
+
     def RequestReportAdhocGenerate(self, id):
         request = """
 <AdhocReportConfig format="raw-xml-v2" template-id="audit-report">
@@ -629,7 +641,6 @@ def RequestReportAdhocGenerate(self, id):
 </AdhocReportConfig>
 """
         return self.ExecuteBasicWithElement("ReportAdhocGenerateRequest", {}, as_xml(request.format(id)))
-        raise NotImplementedError()  # TODO
 
     #
     # The following functions implement the User Management API:
@@ -1466,7 +1477,7 @@ def GetAssetGroupConfiguration(self, assetgroup_or_id):
             asset_group.description = json_dict.get['description']
             if asset_group.description is None:
                 asset_group.description = asset_group.short_description
-        except:
+        except Exception:
             pass
 
         return asset_group
@@ -1969,7 +1980,7 @@ def GetReportConfigurationDetails(self, report_or_configuration_or_id):
             report_or_configuration_or_id = report_or_configuration_or_id.configuration_id
         response = self.VerifySuccess(self.RequestReportConfig(report_or_configuration_or_id))
         element = get_element(response, 'ReportConfig')
-        return ReportConfigurationSummary.CreateFromXML(element)  # TODO: THIS MUST BE A FULL CONFIGURATION
+        return ReportConfiguration.CreateFromXML(element)  # TODO: THIS MUST BE A FULL CONFIGURATION
 
     def GetReportHistory(self, reportconfiguration_or_id):
         """
@@ -2048,6 +2059,36 @@ def GenerateScanReport(self, scan_or_id):
         body = ''.join(data[4:-1])
         return as_xml(base64.urlsafe_b64decode(body))
 
+    def GenerateAdHocReport(self, adhoc_report_configuration):
+        """
+        Generate adhoc report and return decoded contents.
+        """
+        # TODO: add optional filename param to store the report to disk instead of memory
+        self._RequireInstanceOf(adhoc_report_configuration, AdhocReportConfiguration)
+        data = self.RequestAdhocReport(adhoc_report_configuration.AsXML())
+        data = self.VerifySuccess(data)
+        # TODO: figure out a way to handle this safely/correctly for different formats
+        data = data.tail.replace('\r', '').strip().split('\n')
+        # assert data[1] == 'Content-Type: text/xml; name=report.xml'
+        assert data[2] == 'Content-Transfer-Encoding: base64'
+        assert data[3] == ''
+        assert data[0] == data[-1][:-2]
+        body = ''.join(data[4:-1])
+        return base64.urlsafe_b64decode(body)
+
+    def SaveReportConfiguration(self, report_configuration, generate_now=False):
+        """
+        Save the configuration of a report and return the id of the saved report config.
+        If successful, the id will also have been updated in the provided ReportConfiguration object.
+        To create a new report, specify -1 as id.
+        """
+        self._RequireInstanceOf(report_configuration, ReportConfiguration)
+        response = self.RequestReportSave(report_configuration.AsXML(exclude_id=False), generate_now)
+        self.VerifySuccess(response)
+        report_cfg_id = int(get_attribute(response, 'reportcfg-id'))
+        report_configuration.id = report_cfg_id
+        return report_cfg_id
+
     #
     # The following functions implement the Role Management API:
     # =========================================================