New bleeding edge build (v0.8.0) now available!

[jshcodes]

FalconPy v0.8.0

This update provides query string parameter abstraction for the Uber class, allowing you to specify query string parameters using keywords instead of passing a parameters payload.

Example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("RTR_ListAllSessions",
                          offset="string",
                          limit=integer,
                          sort="string",
                          filter="string"
                          )

print(response)

This update also includes docstring formatting fixes and implements a new docstring style validation workflow.

• Enhancement
• Major Feature update
• Updated unit tests
• Documentation

Planned release date

This update is planned to release to the production index on 11.04.2021.

Unit test coverage

Name                                                             Stmts   Miss  Cover
------------------------------------------------------------------------------------
src/falconpy/__init__.py                                            59      0   100%
src/falconpy/_base_url.py                                            6      0   100%
src/falconpy/_endpoint/__init__.py                                 109      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/_falcon_container.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/_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_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                       20      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/_endpoint/deprecated/_report_executions.py              1      0   100%
src/falconpy/_endpoint/deprecated/_scheduled_reports.py              1      0   100%
src/falconpy/_payload/__init__.py                                   22      0   100%
src/falconpy/_payload/_cloud_connect_aws.py                         22      0   100%
src/falconpy/_payload/_cspm_registration.py                         31      0   100%
src/falconpy/_payload/_d4c_registration.py                          10      0   100%
src/falconpy/_payload/_detects.py                                   10      0   100%
src/falconpy/_payload/_device_control_policy.py                     13      0   100%
src/falconpy/_payload/_falconx.py                                   22      0   100%
src/falconpy/_payload/_firewall.py                                  56      0   100%
src/falconpy/_payload/_generic.py                                   62      0   100%
src/falconpy/_payload/_host_group.py                                30      0   100%
src/falconpy/_payload/_ioa.py                                       40      0   100%
src/falconpy/_payload/_ioc.py                                       51      0   100%
src/falconpy/_payload/_malquery.py                                  50      0   100%
src/falconpy/_payload/_mssp.py                                      10      0   100%
src/falconpy/_payload/_prevention_policy.py                         19      0   100%
src/falconpy/_payload/_real_time_response.py                        50      0   100%
src/falconpy/_payload/_recon.py                                     69      0   100%
src/falconpy/_payload/_response_policy.py                           19      0   100%
src/falconpy/_payload/_sensor_update_policy.py                      24      0   100%
src/falconpy/_result.py                                              8      0   100%
src/falconpy/_service_class.py                                      58      0   100%
src/falconpy/_util.py                                              166      0   100%
src/falconpy/_version.py                                            10      0   100%
src/falconpy/api_complete.py                                        92      0   100%
src/falconpy/cloud_connect_aws.py                                   47      0   100%
src/falconpy/cspm_registration.py                                  106      0   100%
src/falconpy/custom_ioa.py                                          85      0   100%
src/falconpy/d4c_registration.py                                    47      0   100%
src/falconpy/detects.py                                             28      0   100%
src/falconpy/device_control_policies.py                             66      0   100%
src/falconpy/event_streams.py                                       19      0   100%
src/falconpy/falcon_complete_dashboard.py                           76      0   100%
src/falconpy/falcon_container.py                                     7      0   100%
src/falconpy/falconx_sandbox.py                                     67      0   100%
src/falconpy/firewall_management.py                                 81      0   100%
src/falconpy/firewall_policies.py                                   68      0   100%
src/falconpy/host_group.py                                          58      0   100%
src/falconpy/hosts.py                                               65      0   100%
src/falconpy/identity_protection.py                                 12      0   100%
src/falconpy/incidents.py                                           37      0   100%
src/falconpy/installation_tokens.py                                 37      0   100%
src/falconpy/intel.py                                               63      0   100%
src/falconpy/ioa_exclusions.py                                      32      0   100%
src/falconpy/ioc.py                                                 49      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/ml_exclusions.py                                       34      0   100%
src/falconpy/mssp.py                                               130      0   100%
src/falconpy/oauth2.py                                              49      0   100%
src/falconpy/overwatch_dashboard.py                                 30      0   100%
src/falconpy/prevention_policy.py                                   59      0   100%
src/falconpy/quarantine.py                                          45      0   100%
src/falconpy/quick_scan.py                                          26      0   100%
src/falconpy/real_time_response.py                                 114      0   100%
src/falconpy/real_time_response_admin.py                            64      0   100%
src/falconpy/recon.py                                               97      0   100%
src/falconpy/report_executions.py                                   16      0   100%
src/falconpy/response_policies.py                                   58      0   100%
src/falconpy/sample_uploads.py                                      24      0   100%
src/falconpy/scheduled_reports.py                                   12      0   100%
src/falconpy/sensor_download.py                                     32      0   100%
src/falconpy/sensor_update_policy.py                                99      0   100%
src/falconpy/sensor_visibility_exclusions.py                        32      0   100%
src/falconpy/spotlight_vulnerabilities.py                           25      0   100%
src/falconpy/user_management.py                                     69      0   100%
src/falconpy/zero_trust_assessment.py                               12      0   100%
------------------------------------------------------------------------------------
TOTAL                                                             3405      0   100%

Bandit analysis

[main]	INFO	running on Python 3.8.10
Run started:2021-10-31 22:54:42.930680

Test results:
	No issues identified.

Code scanned:
	Total lines of code: 32012
	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

• Added: Parameter abstraction for the Uber Class.
  • Provides: Query string parameter payload abstraction for calls made using the Uber class.
  • api_complete.py
  • _util.py
• Added: PEP-8 friendly app_id keyword for the appId parameter used by methods within the EventStreams Service Class.
  • event_streams.py

Issues resolved

• Fixed: Aggregate payload datatype mismatches in Recon Service Class methods.
  • recon.py
• Fixed: Missing payload parameter in recon rule payload handler.
  • _payload/_recon.py
• Fixed: Minor formatting issues within docstrings in all package files.

Other

• Added: Docstring syntax validation workflow leveraging pydocstyle.
• Removed: Deprecated calc_url_from_args method
  • _util.py
• Removed: Deprecated parse_id_list method
  • _util.py

Installation

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

python3 -m pip install -i https://test.pypi.org/simple/ crowdstrike-falconpy

or

pip3 install -i https://test.pypi.org/simple/ crowdstrike-falconpy

Upgrading

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

python3 -m pip install -i https://test.pypi.org/simple/ crowdstrike-falconpy --upgrade

or

pip3 install -i https://test.pypi.org/simple/ crowdstrike-falconpy --upgrade

[jshcodes]

A patch for issue #409 has been merged to main as part of the v0.8.0 codebase. This fix is not available as part of the bleeding-edge version but will be available in the production v0.8.0 package.