Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oppsec/pinkerton
🕵️ Pinkerton is an JavaScript file crawler and secret finder tool developed in Python
https://github.com/oppsec/pinkerton
crawl crawler hacktoberfest javascript pentest python python3 redteam secrets
Last synced: 6 days ago
JSON representation
🕵️ Pinkerton is an JavaScript file crawler and secret finder tool developed in Python
- Host: GitHub
- URL: https://github.com/oppsec/pinkerton
- Owner: oppsec
- License: mit
- Created: 2022-06-10T21:01:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-18T19:08:54.000Z (10 months ago)
- Last Synced: 2024-01-19T20:14:08.885Z (10 months ago)
- Topics: crawl, crawler, hacktoberfest, javascript, pentest, python, python3, redteam, secrets
- Language: Python
- Homepage: https://pinkerton.com
- Size: 1.04 MB
- Stars: 272
- Watchers: 4
- Forks: 45
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🕵️ Pinkerton
> Investigating JavaScripts files since 1850
___
️🕵️ Pinkerton is an JavaScript file crawler and secret finder tool developed in Python
## ⚡ Installing / Getting started
A quick guide of how to install and use Pinkerton.
```
1. Clone the repository with: git clone https://github.com/oppsec/pinkerton.git
2. Install the libraries with: pip3 install -r requirements.txt
3. Run Pinkerton with: python3 main.py -u https://example.com
3.1 (Optional)
If you're using Python 3.11+ + Arch (as me) you're probably getting errors when trying to install the libs from requirements.txt, to fix this, use:
- pip3 install -r requirements.txt --break-system-packages
```
### 🐳 Docker
If you want to use pinkerton in a Docker container, follow this commands:
```
1. Clone the repository - git clone https://github.com/oppsec/pinkerton.git
2. Build the image - sudo docker build -t pinkerton:latest .
3. Run container - sudo docker run pinkerton:latest
```
### ⚙️ Pre-requisites
- [Python 3](https://www.python.org/downloads/) installed on your machine.
- Install the libraries with `pip3 install -r requirements.txt`
### ⚫ BlackArch
```
pacman -Syu pinkerton
```
## 🎥 Demo
[](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI)
## ✨ Features
- Works with ProxyChains
- Fast scan
- Low RAM and CPU usage
- Open-Source
- Python ❤️
## 📚 To-Do
- [x] Add more secrets regex pattern
- [ ] Improve JavaScript file extract function
- [ ] Improve pattern match system
- [ ] Add pass list file method
## 🔨 Contributing
A quick guide of how to contribute with the project.
```
1. Create a fork from Pinkerton repository
2. Clone the repository with git clone https://github.com/your/pinkerton.git
3. Type cd pinkerton/
4. Create a branch and make your changes
5. Commit and make a git push
6. Open a pull request
```
## 🙏 Credits
- [m4ll0k (SecretFinder creator)](https://github.com/m4ll0k) for the regex patterns
- [h33lit (Jubaer Alnazi)](https://github.com/h33tlit) for the regex patterns
- [zricethezav (GitLeaks creator)](https://github.com/zricethezav/gitleaks) for the regex patterns
## ⚠️ Warning
- The developer is not responsible for any malicious use of this tool.