Logicytics is a cutting-edge tool designed to meticulously harvest and collect a vast array of Windows system data for forensic analysis. Crafted with Python 🐍, it's an actively developed project that is dedicated to gathering as much sensitive data as possible and packaging it neatly into a ZIP file 📦. This comprehensive guide is here to equip you with everything you need to use Logicytics effectively.
Please consider buying me a coffee or sponsoring me in GitHub sponsor, I am saving for my college funds in MIT, and I need your help! Supporters will be placed in the Credits ❤️
To install and setup Logicytics, follow these steps:
-
Install Python: If you don't have Python installed, you can download it from the official website.
-
Install Dependencies: Logicytics requires Python modules. You can install all the required modules by running the following command in your terminal:
pip install -r requirements.txt -
Run Logicytics: To run Logicytics, simply run the following command in your terminal:
python Logicytics.py -h- This opens a help menu.
-
Python: The project requires Python 3.8 or higher. You can download Python from the official website.
-
Dependencies: The project requires certain Python modules to be installed. You can install all the required modules by running the following command in your terminal:
pip install -r requirements.txt.
-
Administrative Privileges: To be able to run the program using certain features of the project, like registry modification, you must run the program with administrative privileges.
-
System Requirements: The project has been tested on Windows 10 and 11. It will not work on other operating systems.
-
Knowledge of Command Line: The project uses command line options for the user to interact with the program. It is recommended to have a basic understanding of command line options.
-
Optional: Create a
.ignorefile in theCODE/SysInternal_Suitedirectory to not extract the exe binaries from the ZIP file (This is done for the OpenSSF score), if the.ignorefile is not found, it will auto extract the details
-
Install Python 🐍 If you don't have Python installed, you can download it from the official website. Make sure to select the option to "Add Python to PATH" during installation.
-
Install Dependencies 📦 Logicytics requires Python modules. You can install all the required modules by running the following command in your terminal:
pip install -r requirements.txt -
Run Logicytics 🚀 To run Logicytics, simply run the following command in your terminal:
python Logicytics.py -hThis opens a help menu. -
Run the Program 👾 Once you have run the program, you can run the program with the following command:
python Logicytics.py -hReplace the flags with the ones you want to use. You Must use Admin! -
Wait for magic to happen 🧙♀️ Logicytics will now run and gather data according to the flags you used.
-
Enjoy the gathered data 🎉 Once the program has finished running, you can find the gathered data in the "Data" folder.
-
Share the love ❤️ If you like Logicytics, please consider sharing it with others or spreading the word about it.
-
Contribute to the project 👥 If you have an idea or want to contribute to the project, you can submit an issue or PR on the GitHub repository.
After running and successfully collecting data, you may traverse the ACCESS directory as much as you like, Remove add and delete files, it's the safest directory where your backups, hashes, data zips and logs are found.
Also watch this video for a better understanding of Logicytics
Logicytics uses a config.json file to store configurations. The config.json is located in the CODE directory.
The config.json file is a JSON file that contains the following information:
{
"WEBHOOK URL": "",
"ipgeolocation.io API KEY": "",
"DEBUG": true,
"VERSION": "2.0.0",
"CURRENT_FILES": [
"browser_miner.ps1",
"driverquery.py",
"log_miner.py",
"media_backup.py",
"netadapter.ps1"
]
}The config.json file is used to store the webhook URL, the API key for ipgeolocation.io, the DEBUG flag, the VERSION, and the CURRENT_FILES.
CURRENT_FILES is an array of strings that contains the names of the files you have, this is used to later check for corruption or bugs.
Do not modify CURRENT_FILES and VERSION unless you are developing extra add-ons
Mods are special files that are run with the --modded flag.
These files are essentially scripts that are run after the main Logicytics.py script is run
and the verified scripts are run.
They are used to add extra functionality to the script.
They are located in the MODS directory. In order to make a mod,
you need to create a python file with the .py extension or any of the supported extensions .exe .ps1 .bat
in the MODS directory.
These file will be run after the main script is run.
When making a mod, you should avoid acting based on other files directly,
as this can cause conflicts with the data harvesting.
Instead, you should use the Logicytics.py file and other scripts as a reference
for how to add features to the script.
The --modded flag is used to run all files in the MODS directory.
This flag is not needed for other files in the CODE directory to run,
but it is needed for mods to run.
The --modded flag can also be used to run custom scripts.
If you want to run a custom script with the --modded flag,
you can add the script to the MODS directory, and it will be run with the --modded flag.
To check all the mods and how to make your own, you can check the Logicytics.py file and the WIKI.
Also refer to the contributing.md for more info
If you are having issues, here are some troubleshooting tips:
Some errors may not necessarily mean the script is at fault, but other OS related faults like files not existing, or files not being modified, or files not being created.
Some tips are:
- Check if the script is running as admin and not in a VM
- Check if the script has the correct permissions and correct dependencies to run
- Check if the script is not being blocked by a firewall or antivirus or by a VPN or proxy
- Check if the script is not being blocked by any other software or service
If those don't work attempt:
- Try running the script with powershell instead of cmd, or vice versa
- Try running the script in a different directory
- Try running the script in a different computer
- Try running the script with a different python version above 3.8
- Try running the
--debugflag and check the logs
Check out the GitHub wiki for help Check out the python documentation for help Check out the python subreddit for help Check out the python stackexchange for help when developing mods
Dont recreate these as they are already done:
| File Name | About |
|---|---|
| browser_miner.ps1 | Mines all data related to browsers [Would love to be updated] |
| driverquery+sysinfo.py | Gets data from driverquery and sysinfo command |
| log_miner.py | Gets all logs from the windows device |
| media_backup.py | Gets all media of the device in a neat folder |
| netadapter.ps1 | Runs Get-NetAdapter Command with many flags |
| online_ip_scraper.py | Uses https://api.ipify.org to get your IP [May not be of much use] |
| property_scraper.ps1 | Gets all of the windows properties |
| registry.py | Backups the registry |
| sensitive_data_miner.py | Copies all files that can be considered sensitive in a neat folder [Must be worked on - Super Janky] |
| ssh_miner.py | Gets as much ssh private data as possible |
| sys_internal.py | Attempts to use the Sys_Internal Suite from microsoft |
| tasklist.py | Gets all running tasks, PID and info/data |
| tree.bat | Runs and logs the tree.bat command |
| window_feature_miner.ps1 | Logs all the windows features enabled |
| wmic.py | Logs and runs many wmic commands to gain sensitive data and information |
Any file with _ is not counted here
If there is a specific piece of data that you would like to see extracted by Logicytics, please let us know. We are constantly working to improve the project and adding new features.
Other than mods, some prefixed tools are in the EXTRA directory, use the --extra flag to traverse these
special tools
Check out the contributing guidlines file for more info
Logicytics is a powerful tool that can extract a wide variety of data from a Windows system. With its ability to extract data from various sources, Logicytics can be used for a variety of purposes, from forensics to system information gathering. Its ability to extract data from various sources makes it a valuable tool for any Windows system administrator or forensic investigator.
Please remember that extracting data from a system without proper authorization is illegal and unethical. Always obtain proper authorization before extracting any data from a system.
