Metadata-Version: 2.1
Name: crowdstrike-falconpy-tools
Version: 0.0.12
Summary: CrowdStrike FalconPy Tools
Home-page: https://github.com/CrowdStrike/falconpy-tools
Author: CrowdStrike
Author-email: falconpy@crowdstrike.com
Maintainer: Joshua Hiller
Maintainer-email: falconpy@crowdstrike.com
License: UNKNOWN
Project-URL: Source, https://github.com/CrowdStrike/falconpy-tools/tree/main/src/falconpytools
Project-URL: Tracker, https://github.com/CrowdStrike/falconpy-tools/issues
Description: ![CrowdStrike Falcon](https://raw.githubusercontent.com/CrowdStrike/falconpy/main/docs/asset/cs-logo.png) [![Twitter URL](https://img.shields.io/twitter/url?label=Follow%20%40CrowdStrike&style=social&url=https%3A%2F%2Ftwitter.com%2FCrowdStrike)](https://twitter.com/CrowdStrike)<br/>
        
        # FalconPy Tools
        [![Pylint](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/pylint.yml/badge.svg)](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/pylint.yml)
        [![Flake8](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/flake8.yml/badge.svg)](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/flake8.yml)
        [![Bandit](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/bandit.yml/badge.svg)](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/bandit.yml)
        [![CodeQL](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/codeql.yml/badge.svg)](https://github.com/CrowdStrike/falconpy-tools/actions/workflows/codeql.yml)
        ![Maintained](https://img.shields.io/maintenance/yes/2021)
        
        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`.
        ```python
        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
                             )
        # Host helper
        host = Host(api=hosts.api, verbose=hosts.verbose)
        # Lookup the AID for our search string
        target_aid = host.find_host_aid(hostname="SEARCH-STRING")
        hostname = host.get_host(target_aid)[0]["hostname"]
        # RTR Single Target helper
        target = SingleTarget(api=rtr.api, verbose=rtr.verbose)
        # Initialize a RTR session
        target_session = target.connect_to_host(target_aid)
        # Execute a RTR command
        command_result = host.execute_command("ifconfig", target_session)
        # Disconnect from the RTR session
        host.disconnect_from_host(target_session)
        # Output the results
        print(command_result)
        ```
        
        ## Installation
        ```shell
        python3 -m pip install crowdstrike-falconpy-tools
        ```
        
        ## Upgrading
        ```shell
        python3 -m pip install crowdstrike-falconpy-tools --upgrade
        ```
        
        ## Removal
        ```shell
        python3 -m pip uninstall crowdstrike-falconpy-tools
        ```
Keywords: crowdstrike,falcon,api,sdk,oauth2,devsecops,tools
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
