Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikSierra authored Jun 17, 2024
1 parent d1059c4 commit 7a16481
Showing 1 changed file with 54 additions and 6 deletions.
60 changes: 54 additions & 6 deletions FalconTests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,72 @@

These files are used only for testing the functionality of the FalconContainment process. Each .py tests different parts of the process in order to minimize errors during official use.

For all files, install the necessary packages by running the following prompt in your terminal
```
pip install -r requirements.txt
```
### APIconnectionTest.py

This script is designed to test the connection to the Crowdstrike API and to read hosts provided in the computers.txt file.

#### Usage
1. Use the config.yaml file and insert your API credentials and the file path to the computers.txt file. The file should be structured as follows:
api: client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET file_path: computers.txt


2. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
python APIconnectionTest.py


1. Install the necessary packages by running the following prompt in your terminal
pip install -r requirements.txt

### GetMembersTest.py

2. Use the config.yaml file and insert your API credentials and the file path to the computers.txt file. The file should be structured as follows:
This script is used to test retrieval of members of a group in your crowdstrike environment

#### Usage

1. Use the config.yaml file and insert your API credentials and the file path to the computers.txt file. The file should be structured as follows:
api: client_id: YOUR_CLIENT_ID client_secret: YOUR_CLIENT_SECRET file_path: computers.txt

2. Insert your group ID from crowdstrike into the "GROUP_ID" field in the script

3. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
python APIconnectionTest.py
```
python GetMembersTest.py
```

### Gui test.py

This script is used to test a GUI window creation. Use this script as a start if you would like to customize the outputted display for any scripts instead of reading results from the terminal.
#### Usage

1. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
```
python Gui test.py
```

### GroupContainSim.py

This script is used to simulate containment on a group in your Crowdstrike environment. This will not actually interact with your Crowdstrike environment or anything inside

#### Usage

1. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
```
python GroupContainmentSim.py
```


### NoAPIsim.py

This script is used to simulate containment on a list of hosts defined in the computers.txt file. This will not actually interact with your Crowdstrike environment or anything inside

#### Usage

1. Run the script by navigating to the directory where the file is located and running the following prompt in your terminal
```
python NoAPIsim.py
```


*** Please note that this script is for testing purposes only and should not be used for any official API containment within Crowdstrike Falcon or related resources. Use 'Containment.py' for Crowdstrike API containment. Refer to the GitHub repository for instructions.***

For details on the functions within the script, please refer to the comments within the code.

0 comments on commit 7a16481

Please sign in to comment.