Workaround for setting BASE_URL in versions 0.4.0 - 0.5.5

[jshcodes]

Please note: This post discusses an issue in a previous version of FalconPy. This issue is not present in the most recent versions of FalconPy, or the Uber Class. If you are not using version 0.4.0 - 0.5.5, or if you are using the Uber Class, you can safely ignore this discussion post.

Hi Everyone!

A bug was identified in August that impacted versions 0.4.0 - 0.5.5 regarding specifying environment configuration values for Service Classes. (Full bug detail below.) We've had a few developers run into this issue in scenarios where upgrading to the latest FalconPy version is more problematic. This discussion post is intended to provide documentation for a programmatic workaround for this issue.

The recommended fix for developers experiencing this issue would be to upgrade to the latest FalconPy version.

Workaround overview

When you instantiate a Service Class, a copy of the OAuth2 object is created as an attribute of the newly created object. Our bug improperly sets configuration values in _service_class.py which do not get propagated to this child object. We can work around this issue by creating an instance of the authentication class, and then using it to authenticate to each Service Class we want to use. (Object Authentication)

Not working in version 0.4 - 0.5.5

Trying to pass a custom base URL to a service class in this old version fails.

from falconpy.hosts import Hosts

falcon = Hosts(creds={"client_id": "CLIENT_ID_HERE",
                      "client_secret": "CLIENT_SECRET_HERE"},
               base_url="https://api.us-2.crowdstrike.com"
               )

falcon.QueryDevicesByFilter()

Resolution

This solution will work in versions 0.4 - 0.5.5 as the customization values are set on the authentication object and then passed to subsequent Service Class.

from falconpy.oauth2 import OAuth2
from falconpy.hosts import Hosts

auth = OAuth2(creds={"client_id": "CLIENT_ID_HERE",
                     "client_secret": "CLIENT_SECRET_HERE"},
              base_url="https://api.us-2.crowdstrike.com"
              )

falcon = Hosts(auth_object=auth)

falcon.QueryDevicesByFilter()

This solution also applies to the proxy, ssl_verify and timeout keywords used when creating an instance of a Service Class.

If you have any questions regarding this workaround, please post a reply to this discussion or open an issue.

---

Original bug detail

Describe the bug
The base class of all service classes, _service_class.py does not respect values passed for the BASE_URL, PROXY or SSL_VERIFY attributes when creating an instance of the auth_object for credential authentication.

To Reproduce
Create an instance of any service class, and change it's base_url to US-2 or disable SSL verification with ssl_verify=False.

Expected behavior
The service class is instantiated with an auth_object that respects the passed attribute values.

Environment (please complete the following information):

• OS: All supported
• Python: All supported
• FalconPy: <=0.5.5