FalconPy v1.2.6
This update adds a new Service Class, ODS (On Demand Scan) that contains fifteen new API operations.
An additional 32 API operations are added to the FirewallManagement (9), MSSP (5), Hosts (1), InstallationTokens (1), Intel (2), Recon (7) and SampleUploads (7) Service Classes.
Python 3.11 is now fully supported.
- Enhancement
- Updated unit tests
Unit test coverage
Name Stmts Miss Cover
------------------------------------------------------------------------------------
src/falconpy/__init__.py 71 0 100%
src/falconpy/_base_url.py 7 0 100%
src/falconpy/_container_base_url.py 6 0 100%
src/falconpy/_endpoint/__init__.py 131 0 100%
src/falconpy/_endpoint/_alerts.py 1 0 100%
src/falconpy/_endpoint/_cloud_connect_aws.py 1 0 100%
src/falconpy/_endpoint/_cspm_registration.py 1 0 100%
src/falconpy/_endpoint/_custom_ioa.py 1 0 100%
src/falconpy/_endpoint/_d4c_registration.py 1 0 100%
src/falconpy/_endpoint/_detects.py 1 0 100%
src/falconpy/_endpoint/_device_control_policies.py 1 0 100%
src/falconpy/_endpoint/_discover.py 1 0 100%
src/falconpy/_endpoint/_event_streams.py 1 0 100%
src/falconpy/_endpoint/_falcon_complete_dashboard.py 1 0 100%
src/falconpy/_endpoint/_falcon_container.py 1 0 100%
src/falconpy/_endpoint/_falconx_sandbox.py 1 0 100%
src/falconpy/_endpoint/_filevantage.py 1 0 100%
src/falconpy/_endpoint/_firewall_management.py 1 0 100%
src/falconpy/_endpoint/_firewall_policies.py 1 0 100%
src/falconpy/_endpoint/_host_group.py 1 0 100%
src/falconpy/_endpoint/_hosts.py 1 0 100%
src/falconpy/_endpoint/_identity_protection.py 1 0 100%
src/falconpy/_endpoint/_incidents.py 1 0 100%
src/falconpy/_endpoint/_installation_tokens.py 1 0 100%
src/falconpy/_endpoint/_intel.py 1 0 100%
src/falconpy/_endpoint/_ioa_exclusions.py 1 0 100%
src/falconpy/_endpoint/_ioc.py 1 0 100%
src/falconpy/_endpoint/_iocs.py 1 0 100%
src/falconpy/_endpoint/_kubernetes_protection.py 1 0 100%
src/falconpy/_endpoint/_malquery.py 1 0 100%
src/falconpy/_endpoint/_message_center.py 1 0 100%
src/falconpy/_endpoint/_ml_exclusions.py 1 0 100%
src/falconpy/_endpoint/_mobile_enrollment.py 1 0 100%
src/falconpy/_endpoint/_mssp.py 1 0 100%
src/falconpy/_endpoint/_oauth2.py 1 0 100%
src/falconpy/_endpoint/_ods.py 1 0 100%
src/falconpy/_endpoint/_overwatch_dashboard.py 1 0 100%
src/falconpy/_endpoint/_prevention_policies.py 1 0 100%
src/falconpy/_endpoint/_quarantine.py 1 0 100%
src/falconpy/_endpoint/_quick_scan.py 1 0 100%
src/falconpy/_endpoint/_real_time_response.py 1 0 100%
src/falconpy/_endpoint/_real_time_response_admin.py 1 0 100%
src/falconpy/_endpoint/_recon.py 1 0 100%
src/falconpy/_endpoint/_report_executions.py 1 0 100%
src/falconpy/_endpoint/_response_policies.py 1 0 100%
src/falconpy/_endpoint/_sample_uploads.py 1 0 100%
src/falconpy/_endpoint/_scheduled_reports.py 1 0 100%
src/falconpy/_endpoint/_sensor_download.py 1 0 100%
src/falconpy/_endpoint/_sensor_update_policies.py 1 0 100%
src/falconpy/_endpoint/_sensor_visibility_exclusions.py 1 0 100%
src/falconpy/_endpoint/_spotlight_evaluation_logic.py 1 0 100%
src/falconpy/_endpoint/_spotlight_vulnerabilities.py 1 0 100%
src/falconpy/_endpoint/_tailored_intelligence.py 1 0 100%
src/falconpy/_endpoint/_user_management.py 1 0 100%
src/falconpy/_endpoint/_zero_trust_assessment.py 1 0 100%
src/falconpy/_endpoint/deprecated/__init__.py 26 0 100%
src/falconpy/_endpoint/deprecated/_custom_ioa.py 1 0 100%
src/falconpy/_endpoint/deprecated/_discover.py 1 0 100%
src/falconpy/_endpoint/deprecated/_firewall_management.py 1 0 100%
src/falconpy/_endpoint/deprecated/_hosts.py 1 0 100%
src/falconpy/_endpoint/deprecated/_identity_protection.py 1 0 100%
src/falconpy/_endpoint/deprecated/_installation_tokens.py 1 0 100%
src/falconpy/_endpoint/deprecated/_ioc.py 1 0 100%
src/falconpy/_endpoint/deprecated/_iocs.py 1 0 100%
src/falconpy/_endpoint/deprecated/_ods.py 1 0 100%
src/falconpy/_endpoint/deprecated/_real_time_response.py 1 0 100%
src/falconpy/_endpoint/deprecated/_real_time_response_admin.py 1 0 100%
src/falconpy/_endpoint/deprecated/_report_executions.py 1 0 100%
src/falconpy/_endpoint/deprecated/_scheduled_reports.py 1 0 100%
src/falconpy/_payload/__init__.py 26 0 100%
src/falconpy/_payload/_alerts.py 11 0 100%
src/falconpy/_payload/_cloud_connect_aws.py 22 0 100%
src/falconpy/_payload/_container.py 7 0 100%
src/falconpy/_payload/_cspm_registration.py 40 0 100%
src/falconpy/_payload/_d4c_registration.py 22 0 100%
src/falconpy/_payload/_detects.py 13 0 100%
src/falconpy/_payload/_device_control_policy.py 13 0 100%
src/falconpy/_payload/_falconx.py 25 0 100%
src/falconpy/_payload/_firewall.py 128 0 100%
src/falconpy/_payload/_generic.py 84 0 100%
src/falconpy/_payload/_host_group.py 30 0 100%
src/falconpy/_payload/_incidents.py 15 0 100%
src/falconpy/_payload/_ioa.py 29 0 100%
src/falconpy/_payload/_ioc.py 50 0 100%
src/falconpy/_payload/_malquery.py 56 0 100%
src/falconpy/_payload/_message_center.py 22 0 100%
src/falconpy/_payload/_mssp.py 15 0 100%
src/falconpy/_payload/_ods.py 26 0 100%
src/falconpy/_payload/_prevention_policy.py 19 0 100%
src/falconpy/_payload/_real_time_response.py 27 0 100%
src/falconpy/_payload/_recon.py 82 0 100%
src/falconpy/_payload/_reports.py 18 0 100%
src/falconpy/_payload/_response_policy.py 19 0 100%
src/falconpy/_payload/_sample_uploads.py 9 0 100%
src/falconpy/_payload/_sensor_update_policy.py 24 0 100%
src/falconpy/_result.py 17 0 100%
src/falconpy/_service_class.py 72 0 100%
src/falconpy/_token_fail_reason.py 4 0 100%
src/falconpy/_uber_default_preference.py 3 0 100%
src/falconpy/_util.py 226 0 100%
src/falconpy/_version.py 10 0 100%
src/falconpy/alerts.py 31 0 100%
src/falconpy/api_complete.py 154 0 100%
src/falconpy/cloud_connect_aws.py 47 0 100%
src/falconpy/cspm_registration.py 122 0 100%
src/falconpy/custom_ioa.py 85 0 100%
src/falconpy/d4c_registration.py 79 0 100%
src/falconpy/detects.py 31 0 100%
src/falconpy/device_control_policies.py 68 0 100%
src/falconpy/discover.py 22 0 100%
src/falconpy/event_streams.py 19 0 100%
src/falconpy/falcon_complete_dashboard.py 76 0 100%
src/falconpy/falcon_container.py 27 0 100%
src/falconpy/falconx_sandbox.py 67 0 100%
src/falconpy/filevantage.py 13 0 100%
src/falconpy/firewall_management.py 137 0 100%
src/falconpy/firewall_policies.py 70 0 100%
src/falconpy/host_group.py 60 0 100%
src/falconpy/hosts.py 105 0 100%
src/falconpy/identity_protection.py 13 0 100%
src/falconpy/incidents.py 40 0 100%
src/falconpy/installation_tokens.py 42 0 100%
src/falconpy/intel.py 73 0 100%
src/falconpy/ioa_exclusions.py 32 0 100%
src/falconpy/ioc.py 81 0 100%
src/falconpy/iocs.py 39 0 100%
src/falconpy/kubernetes_protection.py 49 0 100%
src/falconpy/malquery.py 49 0 100%
src/falconpy/message_center.py 74 0 100%
src/falconpy/ml_exclusions.py 34 0 100%
src/falconpy/mobile_enrollment.py 17 0 100%
src/falconpy/mssp.py 163 0 100%
src/falconpy/oauth2.py 69 0 100%
src/falconpy/ods.py 67 0 100%
src/falconpy/overwatch_dashboard.py 30 0 100%
src/falconpy/prevention_policy.py 61 0 100%
src/falconpy/quarantine.py 45 0 100%
src/falconpy/quick_scan.py 26 0 100%
src/falconpy/real_time_response.py 126 0 100%
src/falconpy/real_time_response_admin.py 74 0 100%
src/falconpy/recon.py 127 0 100%
src/falconpy/report_executions.py 23 0 100%
src/falconpy/response_policies.py 60 0 100%
src/falconpy/sample_uploads.py 66 0 100%
src/falconpy/scheduled_reports.py 19 0 100%
src/falconpy/sensor_download.py 32 0 100%
src/falconpy/sensor_update_policy.py 109 0 100%
src/falconpy/sensor_visibility_exclusions.py 32 0 100%
src/falconpy/spotlight_evaluation_logic.py 22 0 100%
src/falconpy/spotlight_vulnerabilities.py 30 0 100%
src/falconpy/tailored_intelligence.py 40 0 100%
src/falconpy/user_management.py 137 0 100%
src/falconpy/zero_trust_assessment.py 12 0 100%
------------------------------------------------------------------------------------
TOTAL 4595 0 100%Bandit analysis
[main] INFO running on Python 3.9.9
Run started:2022-12-09 03:48:48.722722
Test results:
No issues identified.
Code scanned:
Total lines of code: 43351
Total lines skipped (#nosec): 0
Run metrics:
Total issues (by severity):
Undefined: 0
Low: 0
Medium: 0
High: 0
Total issues (by confidence):
Undefined: 0
Low: 0
Medium: 0
High: 0
Files skipped (0):Added features and functionality
-
Added: Nine new operations added to the FirewallManagement Service Class. (
get_network_location_details,update_network_locations_metadata,update_network_locations_precedence,get_network_locations,create_network_locations,update_network_locations,upsert_network_locations,delete_network_locations,query_network_locations)firewall_management.py_endpoint/_firewall_management.py
Adds two new payload handlers.
_payload/_firewall.py
Unit testing expanded to complete code coverage.
tests/test_firewall_management.py
-
Added: Five new operations added to the Flight Control (MSSP) Service Class. (
getChildrenV2,getCIDGroupMembersByV2,getCIDGroupByIdV2,getUserGroupMembersByIDV2,getUserGroupsByIDV2)mssp.py_endpoint/_mssp.py
Unit testing expanded to complete code coverage.
tests/test_mssp.py
-
Added: One new operation added to the Hosts Service Class. (
entities_perform_action)hosts.py_endpoint/_hosts.py
One new payload handler was added.
_payload/_generic.py
Unit testing expanded to complete code coverage.
tests/test_hosts.py
-
Added: One new operation added to the InstallationTokens Service Class. (
customer_settings_update)installation_tokens.py_endpoint/_installation_tokens.py
One new payload handler was added.
_payload/_generic.py
Unit testing expanded to complete code coverage.
tests/test_installation_tokens.py
-
Added: Two new operations added to the Intel Service Class. (
GetVulnerabilities,QueryVulnerabilities)intel.py_endpoint/_intel.py
Unit testing expanded to complete code coverage.
tests/test_intel.py
-
Added: New ODS Service Class (On Demand Scan) with fifteen new operations. (
aggregate_scans,aggregate_scheduled_scans,get_malicious_files_by_id,cancel_scans,get_scan_host_metadata_by_ids,scans_report,get_scans_by_scan_ids,scans_report,get_scheduled_scans_by_scan_ids,schedule_scan,delete_scheduled_scans,query_malicious_files,query_scan_host_metadata,query_scans,query_scheduled_scans)__init__.pyods.py_endpoint/__init__.py_endpoint/_ods.py_endpoint/deprecated/__init__.py_endpoint/deprecated/_ods.py
Two new payload handlers were added.
_payload/_ods.py
New unit testing implemented to confirm functionality and complete code coverage.
tests/test_ods.py
-
Added: Seven new operations added to the Recon Service Class. (
AggregateNotificationsExposedDataRecordsV1,GetFileContentForExportJobsV1,GetExportJobsV1,CreateExportJobsV1,DeleteExportJobsV1,GetNotificationsExposedDataRecordsV1,QueryNotificationsExposedDataRecordsV1)recon.py_endpoint/_recon.py
One new payload handler was added.
_payload/_recon.py
Unit testing expanded to complete code coverage.
tests/test_recon.py
-
Added: Seven new operations added to the SampleUploads Service Class. (
ArchiveListV1,ArchiveGetV1,ArchiveDeleteV1,ArchiveUploadV2,ExtractionListV1,ExtractionGetV1,ExtractionCreateV1)sample_uploads.py_endpoint/_sample_uploads.py
One new payload handler was added.
_payload/_sample_uploads.py
Unit testing expanded to complete code coverage.
tests/test_sample_uploads.pytests/testfile.zip
Other
- Changed: Due to updates in the latest Ubuntu version used in GitHub actions, unit testing for Python 3.6 has been split off to a stand alone workflow.
- Added: Python 3.11 support.
setup.py