{"id":19052348,"url":"https://github.com/oppsec/pinkerton","last_synced_at":"2025-03-31T06:08:11.543Z","repository":{"id":37580430,"uuid":"502180027","full_name":"oppsec/Pinkerton","owner":"oppsec","description":"🕵️ JavaScript file crawler and secret finder tool developed with Python ","archived":false,"fork":false,"pushed_at":"2024-01-18T19:08:54.000Z","size":1089,"stargazers_count":286,"open_issues_count":0,"forks_count":43,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-24T04:11:24.002Z","etag":null,"topics":["crawl","crawler","hacktoberfest","javascript","pentest","python","python3","redteam","secrets"],"latest_commit_sha":null,"homepage":"https://pinkerton.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oppsec.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-10T21:01:51.000Z","updated_at":"2025-02-26T09:25:34.000Z","dependencies_parsed_at":"2024-01-18T19:54:18.144Z","dependency_job_id":null,"html_url":"https://github.com/oppsec/Pinkerton","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oppsec%2FPinkerton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oppsec%2FPinkerton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oppsec%2FPinkerton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oppsec%2FPinkerton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oppsec","download_url":"https://codeload.github.com/oppsec/Pinkerton/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246423731,"owners_count":20774820,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crawl","crawler","hacktoberfest","javascript","pentest","python","python3","redteam","secrets"],"created_at":"2024-11-08T23:21:59.731Z","updated_at":"2025-03-31T06:08:11.526Z","avatar_url":"https://github.com/oppsec.png","language":"Python","readme":"# 🕵️ Pinkerton\n\u003e Investigating JavaScripts files since 1850\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://i.imgur.com/GvPspEa.png\" width=920\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/oppsec/Pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/oppsec/Pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/oppsec/pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/forks/oppsec/Pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/v/release/oppsec/pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/languages/code-size/oppsec/Pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n    \u003cimg src=\"https://img.shields.io/librariesio/github/oppsec/pinkerton?color=yellow\u0026logo=github\u0026style=for-the-badge\"\u003e\n\u003c/p\u003e\n\n___\n\n\u003cbr\u003e\n\n\u003cp\u003e ️🕵️ \u003cb\u003ePinkerton\u003c/b\u003e is an JavaScript file crawler and secret finder tool developed in Python  \u003c/p\u003e\n\n\u003cbr\u003e\n\n## ⚡ Installing / Getting started\n\n\u003cp\u003e A quick guide of how to install and use Pinkerton. \u003c/p\u003e\n\n```\n1. Clone the repository with: git clone https://github.com/oppsec/pinkerton.git\n2. Install the libraries with: pip3 install -r requirements.txt\n3. Run Pinkerton with: python3 main.py -u https://example.com\n\n3.1 (Optional)\nIf 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:\n- pip3 install -r requirements.txt --break-system-packages\n```\n\n\u003cbr\u003e\n\n### 🐳 Docker\n\nIf you want to use pinkerton in a Docker container, follow this commands:\n\n```\n1. Clone the repository - git clone https://github.com/oppsec/pinkerton.git\n2. Build the image - sudo docker build -t pinkerton:latest .\n3. Run container - sudo docker run pinkerton:latest\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n### ⚙️ Pre-requisites\n\n- [Python 3](https://www.python.org/downloads/) installed on your machine.\n- Install the libraries with `pip3 install -r requirements.txt`\n\n\u003cbr\u003e\u003cbr\u003e\n\n### ⚫ BlackArch\n\n```\npacman -Syu pinkerton\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n## 🎥 Demo\n\n[![asciicast](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI.svg)](https://asciinema.org/a/SDDtLFRPcauGY1Z5WFLcsc0dI)\n\n\u003cbr\u003e\u003cbr\u003e\n\n## ✨ Features\n\n- Works with ProxyChains\n- Fast scan\n- Low RAM and CPU usage\n- Open-Source\n- Python ❤️\n\n\u003cbr\u003e\u003cbr\u003e\n\n## 📚 To-Do\n\n- [x] Add more secrets regex pattern\n- [ ] Improve JavaScript file extract function\n- [ ] Improve pattern match system\n- [ ] Add pass list file method\n\n\u003cbr\u003e\u003cbr\u003e\n\n## 🔨 Contributing\n\nA quick guide of how to contribute with the project.\n\n```\n1. Create a fork from Pinkerton repository\n2. Clone the repository with git clone https://github.com/your/pinkerton.git\n3. Type cd pinkerton/\n4. Create a branch and make your changes\n5. Commit and make a git push\n6. Open a pull request\n```\n\n\u003cbr\u003e\u003cbr\u003e\n\n## 🙏 Credits\n\n- [m4ll0k (SecretFinder creator)](https://github.com/m4ll0k) for the regex patterns\n- [h33lit (Jubaer Alnazi)](https://github.com/h33tlit) for the regex patterns\n- [zricethezav (GitLeaks creator)](https://github.com/zricethezav/gitleaks) for the regex patterns\n\n\u003cbr\u003e\u003cbr\u003e\n\n## ⚠️ Warning\n\n- The developer is not responsible for any malicious use of this tool.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foppsec%2Fpinkerton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foppsec%2Fpinkerton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foppsec%2Fpinkerton/lists"}