Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Environment and Context authentication support, default example profiles and global example settings #222

Merged
merged 7 commits into from
Nov 1, 2024

Conversation

jshcodes
Copy link
Member

@jshcodes jshcodes commented Nov 1, 2024

Add Environment and Context authentication support, default example profiles and global example settings

This pull request implements the following:

  • Adds the ability to define a default example profile in config.yml.
  • Adds the ability to define global example settings, as opposed to per profile example settings. Per profile settings override global settings.
  • Adds support for the FalconPy Environment and Context Authentication mechanisms.
  • Resolves a filter bug within the queue_command example.
  • Resolves a filter bug within the download_event_log example.
  • Resolves a bug related to archive extraction within the RTR module (get_file.py).
  • Enhancement
  • Bug fixes

Bandit analysis

[main]	INFO	running on Python 3.13.0

Run started:2024-11-01 13:59:33.369779

Test results:
	No issues identified.

Code scanned:
	Total lines of code: 5551
	Total lines skipped (#nosec): 1

Run metrics:
	Total issues (by severity):
		Undefined: 0
		Low: 0
		Medium: 0
		High: 0
	Total issues (by confidence):
		Undefined: 0
		Low: 0
		Medium: 0
		High: 0
Files skipped (0):

Added features and functionality

  • Added: Environment and Context Authentication support.

    • client.py
    • examples/common/example.py
  • Added: Command output display added to the queue_command example.

    • examples/rtr/queue_command.py
  • Added: Example global settings.

    • examples/common/example.py
  • Added: Default example profiles.

    • examples/common/example.py

Issues resolved

  • Fixed: Resolved bug with archive extraction within the RTR module.

    • modules/rtr/get_file.py
  • Fixed: Resolved Falcon Filter dialect issue within the queue_command example.

    • examples/rtr/queue_command.py
  • Fixed: Resolved Falcon Filter dialect issue within the download_event_log example.

    • examples/rtr/download_event_log.py

Other

  • Updated: Added additional detail regarding global settings and environment authentication to examples profile configuration documentation.
    • examples/config.example.yml
  • List any other details here
  • Documentation regarding your changes can also be listed here

@jshcodes jshcodes added bug 🐛 Something isn't working enhancement 🌟 New feature or request labels Nov 1, 2024
@jshcodes jshcodes self-assigned this Nov 1, 2024
Copy link
Member

@ChristopherHammond13 ChristopherHammond13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good except for one complex code block that would be good to simplify. Thank you for your help fixing these examples!

examples/common/example.py Outdated Show resolved Hide resolved
@ChristopherHammond13 ChristopherHammond13 merged commit 5a246f5 into CrowdStrike:main Nov 1, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something isn't working enhancement 🌟 New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants