Crowdstrike-falconpy

Added features and functionality
+ Added: MSSP (Falcon Flight Control) Service Class
* getChildren
* getCIDGroupMembersBy
* addCIDGroupMembers
* deleteCIDGroupMembers
* getCIDGroupById
* createCIDGroups
* deleteCIDGroups
* updateCIDGroups
* getRolesByID
* addRole
* deleteRoles
* getUserGroupMembersByID
* addUserGroupMembers
* deleteUserGroupMembers
* getUserGroupsByID
* createUserGroup
* deleteUserGroups
* updateUserGroups
* queryChildren
* queryCIDGroupMembers
* queryCIDGroups
* queryRoles
* queryUserGroupMembers
* queryUserGroups
- Added unit tests (`test_mssp.py`)

+ Added: Zero Trust Assessment Service Class
* getAssessmentV1
- Added unit tests (`test_zero_trust_assessment.py`)

Issues resolved
+ Fixed KeyError when providing invalid credentials to a Service Class using Credential
or Object authentication, Closes [134](https://github.com/CrowdStrike/falconpy/issues/134)

Other
+ Moved _endpoint constant library to a private submodule (No impact to existing usage)
- Added payload parameter information to _endpoint constants
- Adds service collection ID to endpoint lists
- This prepares the package for new functionality planned for future releases
+ Added: `force_default` function - decorator function that forces default values for function arguments (`_util.py`)
- Added: Helper function `get_default`
- Refactored Uber class to leverage this new functionality
* Unit tests refactored to cover new code paths (`test_uber_api_complete.py`)
- Depending upon feedback, this updated pattern will be implemented within Service Classes to reduce overall function complexity
+ Linting
> Developers: These patterns are being tested within the Uber Class for migration over to Service Classes in future versions
- Reduced Uber class method complexity
* Added: Helper function `calc_url_from_args` (`_util.py`)
* Added: Helper function `_create_header_payload` (`api_complete.py`, Requires class internal variables)
- Migrated Uber class variables to snake_case format
- Removed unnecessarily complex lambdas
* New class method: `valid_cred_format`, replaces previous lambda class attribute
* New class method: `token_expired`, replaces previous lambda class attribute
- Reduced overall number of instance attributes
* Unit tests updated (`test_uber_api_complete.py`)
+ Minor unit test update to `test_cspm_registration.py`
+ Added `util/coverage.config`
- Moved unit test coverage reporting over to configuration file for parameter management
+ Documentation updates

---

Added features and functionality
+ Added: Custom Indicators of Attack (IOA) API Service Class (`custom_ioa.py`)
* get_patterns
* get_platformsMixin0
* get_rule_groupsMixin0
* create_rule_groupMixin0
* delete_rule_groupsMixin0
* update_rule_groupMixin0
* get_rule_types
* get_rules_get
* get_rulesMixin0
* create_rule
* delete_rules
* update_rules
* validate
* query_patterns
* query_platformsMixin0
* query_rule_groups_full
* query_rule_groupsMixin0
* query_rule_types
* query_rulesMixin0
- Added unit tests (`test_custom_ioa.py`)

+ Added: Falcon X Quick Scan API Service Class (`quick_scan.py`)
* GetScansAggregates
* GetScans
* ScanSamples
* QuerySubmissionsMixin0
- Added unit tests (`test_quick_scan.py`)

+ Added: Uber class endpoints (`_endpoints.py`)
* Falcon Complete Dashboard API
* Falcon Overwatch Dashboard API
* Falcon Flight Control API

Issues resolved
+ Fixed unidiomatic type check in `_util.py` (_parse_id_list_)
+ Fixed potentially problematic default payload lists and dictionaries (Service Classes and Uber Class)

Other
+ Added CHANGELOG.md
+ Documentation updates to reflect new service class and upcoming API additions
+ Minor comment updates
+ Adjusted GitHub actions to test operating systems as separate workflows
+ Minor GitHub workflow adjustments
+ Unit test updates
- Cloud Connect AWS
- CSPM Registration
- Sensor Download

---

Added features and functionality
+ Added: Sensor Download API Service Class (Contributor: CalebSchwartz)
* GetCombinedSensorInstallersByQuery
* DownloadSensorInstallerById
* GetSensorInstallersEntities
* GetSensorInstallersCCIDByQuery
* GetSensorInstallersByQuery
- Added unit tests

Issues resolved
+ Fixed: action_name parameter default bug. Resolved by setting a default value and overriding this value if action_name is present in the parameters dictionary, Closes 114.

Other
+ Documentation updated to reflect the new Sensor Download Service Class


---

Added features and functionality
+ Added: Sample_Uploads service class (`sample_uploads.py`)
* UploadSampleV3
* GetSampleV3
* DeleteSampleV3
- Added: Sample_Uploads unit tests (`test_sample_uploads.py`)
+ Added: FalconDebug - Interactive Python3 debugger that provides a pre-defined API token.

Issues resolved
+ Fixed: Issue with Uber class command method using the action_name variable instead of file_name variable for actions passing the file_name parameter.
+ Fixed: Issue with `setup.py` passing GitHub emoji text to the package description.
+ Fixed: Issue with Uber class unit testing not deleting uploaded files from Sample_Uploads API. (`test_uber_api_complete.py`)


---

Added features and functionality
+ Added missing method: `hosts.py` - Added UpdateDeviceTags method to Hosts service class. (Contributor: rewgord)
- Unit test added to `test_hosts.py` to test device tagging functionality.
+ API Operation summaries added to the Uber class: `_endpoint.py` - This provides for upcoming functionality that will be announced in future updates.
+ New endpoints added to the Uber class: `_endpoint.py`

> Deprecation Warning: Legacy API operation IDs that made use of the Python reserved characters "." and "-" have been deprecated.
> New operation IDs have been generated for each that now aligns to the method names defined in the equivalent service class.

Issues resolved
+ Added method validation to Uber class calls to the requests library. (HTTP 418 is sent when an invalid method is specified.)

Other
+ Cleaned up `event_streams.py` class file to match new patterns.
+ Updated return type decorators for service_request and perform_request. (`_util.py`)
+ Updated return type decorators for GetArtifacts, GetReports and GetSampleV2. (`falconx_sandbox.py`)
+ Abstracted all remaining common error output code paths to a stand-alone generic method. (`_util.py`)


---

Added features and functionality
+ New service class: cspm_registration.py - Provides the *CSPM_Registration* service class for handling Horizon registration in Azure and AWS.
- Unit test added
+ Added methods: falconx_sandbox.py - Support for the following operations have been added to the *FalconX_Sandbox* service class.
* QuerySampleV1
* DeleteSampleV2
* GetSampleV2
* DeleteReport
* GetReports
- Unit test added

Issues resolved
+ Bug fix: Resolved malformed validator in detects.py - UpdateDetectsByIdsV2
+ Bug fix: Added action_name parameter to operations that require the parameter. Closes 53.
This issue impacted 6 service classes in total:
- device_control_policies.py - *Device_Control_Policies* - performDeviceControlPoliciesAction
- firewall_policies.py - *Firewall_Policies* - performFirewallPoliciesAction
- host_group.py - *Host_Group* - performGroupAction
- hosts.py - *Host* - PerformActionV2
- prevention_policy.py - *Prevention_Policy* - performPreventionPoliciesAction
- sensor_update_policy.py - *Sensor_Update_Policy* - performSensorUpdatePoliciesAction

- This issue also impacted the Uber class, resulting in updates to the command method within the APIHarness class.

- Unit tests modified

> Breaking Change: The action_name parameter does not currently accept unspecified values. This is resolved in the 0.4.4 version of the package.

Other
+ Minor updates to `_endpoints.py` to reflect operation ID corrections for the CSPM registration API.
+ Abstracted common error output code paths to a stand-alone method within `_util.py`.


---