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
1 maintainer
Metadata
1 maintainer
Release files for crowdstrike-falconpy-tools 0.0.28
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| crowdstrike-falconpy-tools-0.0.28.tar.gz | 8.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| crowdstrike_falconpy_tools-0.0.28-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.2 kB
Release files / crowdstrike-falconpy-tools-0.0.28.tar.gz
| Download URL | crowdstrike-falconpy-tools-0.0.28.tar.gz |
|---|---|
| Size | 8.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
822edc24b33243c745dd7c118a4bbb0933de6943732abd2b334ccef1afdd4d15
|
|
BLAKE2b-256 checksum How to use checksums |
57433c87e14c40764eddce603ee80d8a01d25099467cca68d91403d402b09f09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Release files / crowdstrike_falconpy_tools-0.0.28-py3-none-any.whl
| Download URL | crowdstrike_falconpy_tools-0.0.28-py3-none-any.whl |
|---|---|
| Size | 12.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3fb8ea3716309db2a27e0db06677c8d8c033f75fdc8f5fe294f28296da7b6fe5
|
|
BLAKE2b-256 checksum How to use checksums |
cd5ec05a50435a73c0c0eb2b28552c8428a2b6afb34e66ba9b425749cdbb9913
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6
|
Security for crowdstrike-falconpy-tools 0.0.28
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
