crowdstrike-falconpy-tools 0.0.28

CrowdStrike FalconPy Tools

FalconPy Tools

A collection of tools for interacting with the CrowdStrike Falcon API.

Basic usage example

The following example demonstrates using the Hosts Toolbox to retrieve a host AID, and then using the RTR Toolbox to initiate a session and execute ifconfig.

import os
from falconpytools.hosts import HostsToolbox, Host
from falconpytools.rtr import RTRToolbox, SingleTarget

# Open the RTR toolbox
rtr = RTRToolbox(os.environ["FALCON_CLIENT_ID"],
                 os.environ["FALCON_CLIENT_SECRET"],
                 verbose=True
                 )
# Open the Hosts toolbox
hosts = HostsToolbox(auth_object=rtr.api.rtr.auth_object,
                     verbose=True
                     )
# Lookup the AID for our search string
target_aid = hosts.host.find_host_aid(hostname="SEARCH-STRING")
# Retrieve the hostname
hostname = hosts.host.get_host(target_aid)[0]["hostname"]
# RTR Single Target helper
target = rtr.single_target
# Initialize a RTR session
target_session = target.connect_to_host(target_aid)
# Execute a RTR command
command_result = target.execute_command("ifconfig", target_session)
# Disconnect from the RTR session
target.disconnect_from_host(target_session)
# Output the results
print(command_result)

Installation

python3 -m pip install crowdstrike-falconpy-tools

Upgrading

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

Removal

python3 -m pip uninstall crowdstrike-falconpy-tools