Version 0.5.5 released!

[jshcodes]

FalconPy v0.5.5

This update provides code quality updates, moves all remaining service classes to the new code pattern supporting parameter dictionary abstraction, and introduces a new code pattern in several service classes that is easier to use.

This update also contains a bug fix for timeout parameter handling when using Legacy authentication.

• Enhancement
• Bug fixes
• Updated unit tests

Unit test coverage

Name                                                             Stmts   Miss  Cover
------------------------------------------------------------------------------------
src/falconpy/__init__.py                                            14      0   100%
src/falconpy/_endpoint/__init__.py                                  97      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/_event_streams.py                             1      0   100%
src/falconpy/_endpoint/_falcon_complete_dashboard.py                 1      0   100%
src/falconpy/_endpoint/_falconx_sandbox.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/_ml_exclusions.py                             1      0   100%
src/falconpy/_endpoint/_mssp.py                                      1      0   100%
src/falconpy/_endpoint/_oauth2.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/_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/_response_policies.py                         1      0   100%
src/falconpy/_endpoint/_sample_uploads.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_vulnerabilities.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                       16      0   100%
src/falconpy/_endpoint/deprecated/_custom_ioa.py                     1      0   100%
src/falconpy/_endpoint/deprecated/_firewall_management.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/_real_time_response.py             1      0   100%
src/falconpy/_endpoint/deprecated/_real_time_response_admin.py       1      0   100%
src/falconpy/_result.py                                              8      0   100%
src/falconpy/_service_class.py                                      58      0   100%
src/falconpy/_util.py                                              153      0   100%
src/falconpy/_version.py                                            10      0   100%
src/falconpy/api_complete.py                                        89      0   100%
src/falconpy/cloud_connect_aws.py                                   74      0   100%
src/falconpy/cspm_registration.py                                  150      0   100%
src/falconpy/custom_ioa.py                                         161      0   100%
src/falconpy/d4c_registration.py                                    70      0   100%
src/falconpy/detects.py                                             37      0   100%
src/falconpy/device_control_policies.py                             87      0   100%
src/falconpy/event_streams.py                                       20      0   100%
src/falconpy/falcon_complete_dashboard.py                          109      0   100%
src/falconpy/falconx_sandbox.py                                    102      0   100%
src/falconpy/firewall_management.py                                 67      0   100%
src/falconpy/firewall_policies.py                                   89      0   100%
src/falconpy/host_group.py                                          79      0   100%
src/falconpy/hosts.py                                               70      0   100%
src/falconpy/identity_protection.py                                 11      0   100%
src/falconpy/incidents.py                                           49      0   100%
src/falconpy/installation_tokens.py                                 66      0   100%
src/falconpy/intel.py                                               45      0   100%
src/falconpy/ioa_exclusions.py                                      42      0   100%
src/falconpy/ioc.py                                                 54      0   100%
src/falconpy/iocs.py                                                76      0   100%
src/falconpy/kubernetes_protection.py                               74      0   100%
src/falconpy/malquery.py                                            70      0   100%
src/falconpy/ml_exclusions.py                                       42      0   100%
src/falconpy/mssp.py                                               189      0   100%
src/falconpy/oauth2.py                                              38      0   100%
src/falconpy/overwatch_dashboard.py                                 42      0   100%
src/falconpy/prevention_policy.py                                   82      0   100%
src/falconpy/quick_scan.py                                          14      0   100%
src/falconpy/real_time_response.py                                  60      0   100%
src/falconpy/real_time_response_admin.py                            42      0   100%
src/falconpy/recon.py                                              149      0   100%
src/falconpy/response_policies.py                                   82      0   100%
src/falconpy/sample_uploads.py                                      31      0   100%
src/falconpy/sensor_download.py                                     48      0   100%
src/falconpy/sensor_update_policy.py                               132      0   100%
src/falconpy/sensor_visibility_exclusions.py                        42      0   100%
src/falconpy/spotlight_vulnerabilities.py                           28      0   100%
src/falconpy/user_management.py                                     36      0   100%
src/falconpy/zero_trust_assessment.py                               12      0   100%
------------------------------------------------------------------------------------
TOTAL                                                             3163      0   100%

Bandit analysis

[main]	INFO	running on Python 3.9.2
Run started:2021-08-02 04:46:22.824426

Test results:
	No issues identified.

Code scanned:
	Total lines of code: 21718
	Total lines skipped (#nosec): 0

Run metrics:
	Total issues (by severity):
		Undefined: 0.0
		Low: 0.0
		Medium: 0.0
		High: 0.0
	Total issues (by confidence):
		Undefined: 0.0
		Low: 0.0
		Medium: 0.0
		High: 0.0
Files skipped (0):

Added features and functionality

• Refactored Custom IOA Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Custom IOA Service Class to the new pattern #217. custom_ioa.py
• Refactored Device Control Policies Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Device Control Policies Service Class to the new pattern #224. device_control_policies.py
• Refactored Firewall Policies Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Firewall Policies Service Class to the new pattern #227. firewall_policies.py
• Refactored Firewall Management Service Class to match the most recent pattern, closes [ ENH ] Refactor the Firewall Management Service Class to the most recent pattern #232. firewall_management.py
• Refactored Falcon X Sandbox Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Falcon X Sandbox Service Class to the new pattern #226. falconx_sandbox.py
• Refactored Hosts Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Hosts Service Class to the new pattern #218. hosts.py
• Refactored Host Group Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Host Group Service Class to the new pattern #223. host_group.py
• Refactored Intel Service Class to match the most recent pattern, closes [ ENH ] Refactor the Intel Service Class to the most recent pattern #231. intel.py
• Refactored OAuth2 class to reflect new functionality and linting patterns, closes [ ENH ] Refactor the OAuth2 Service class to the new pattern #233. oauth2.py
• Refactored Quick Scan Service Class to match the most recent pattern, closes [ ENH ] Refactor the Quick Scan Service Class to the new pattern #219. quick_scan.py
• Refactored Real Time Response Service Class to match the most recent pattern, closes [ ENH ] Refactor the Real Time Response Service Class to the most recent pattern #230. real_time_response.py
• Refactored Real Time Response Admin Service Class to match the most recent pattern, closes [ ENH ] Refactor the Real Time Response Admin Service Class to the most recent pattern #229. real_time_response_admin.py
• Refactored Sensor Updated Policy Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Sensor Update Policy Service Class to the new pattern #222. sensor_update_policy.py
• Refactored Sensor Downloads Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Sensor Downloads Service Class to the new pattern #221. sensor_downloads.py
• Refactored Sample Uploads Service Class to the new pattern to provide for new parameter handling functionality, closes [ ENH ] Refactor the Sample Uploads Service Class to the new pattern #220. sample_uploads.py
• Refactored User Management Service Class to match the most recent pattern, closes [ ENH ] Refactor the User Management Service Class to the most recent pattern #228. user_management.py

Issues resolved

• Bug fix: Resolved issue with the timeout parameter not being passed to the OAuth2 class when legacy authentication was being used. Closes [ BUG ] Legacy authentication does not support timeout handling #225.

Other

• Enabled Pylint stopping the build on linting failures within package source.
• Unit test updates to expand code coverage for new code paths.
• This update provides part of the functionality requested in [ ENH ] Provide the ability to globally disable payload and parameter validation #115.

Installation

You can install this new release by installing the package via the Python Package Index.

$ python3 -m pip install crowdstrike-falconpy

or

pip3 install crowdstrike-falconpy

Upgrading

You can upgrade to this new release by installing the update via the Python Package Index.

$ python3 -m pip install crowdstrike-falconpy --upgrade

or

pip3 install crowdstrike-falconpy --upgrade

---

This discussion was created from the release Version 0.5.5.