Photon README

The project's README from github.com/s0md3v/Photon. As one markdown file: README.md.


Photon
Photon

Incredibly fast crawler designed for OSINT.

pypi

Photon Wiki • How To Use • Compatibility • Photon Library • Contribution • Roadmap

Key Features

Data Extraction

Photon can extract the following data while crawling:

The extracted information is saved in an organized manner or can be exported as json.

save demo

Flexible

Control timeout, delay, add seeds, exclude URLs matching a regex pattern and other cool stuff. The extensive range of options provided by Photon lets you crawl the web exactly the way you want.

Genius

Photon's smart thread management & refined logic gives you top notch performance.

Still, crawling can be resource intensive but Photon has some tricks up it's sleeves. You can fetch URLs archived by archive.org to be used as seeds by using --wayback option.

Plugins

Docker

Photon can be launched using a lightweight Python-Alpine (103 MB) Docker image.

$ git clone https://github.com/s0md3v/Photon.git
$ cd Photon
$ docker build -t photon .
$ docker run -it --name photon photon:latest -u google.com

To view results, you can either head over to the local docker volume, which you can find by running docker inspect photon or by mounting the target loot folder:

$ docker run -it --name photon -v "$PWD:/Photon/google.com" photon:latest -u google.com

Frequent & Seamless Updates

Photon is under heavy development and updates for fixing bugs. optimizing performance & new features are being rolled regularly.

If you would like to see features and issues that are being worked on, you can do that on Development project board.

Updates can be installed & checked for with the --update option. Photon has seamless update capabilities which means you can update Photon without losing any of your saved data. Use Control + Shift + m to toggle the tab key moving focus. Alternatively, use esc then tab to move to the next interactive element on the page. Attach files by dragging & dropping, selecting or pasting them. (https://www.thordata.com/?ls=github&lk=Photon)

demo

Photon Wiki • How To Use • Compatibility • Photon Library • Contribution • Roadmap

Key Features

Data Extraction

Photon can extract the following data while crawling:

The extracted information is saved in an organized manner or can be exported as json.

save demo

Flexible

Control timeout, delay, add seeds, exclude URLs matching a regex pattern and other cool stuff. The extensive range of options provided by Photon lets you crawl the web exactly the way you want.

Genius

Photon's smart thread management & refined logic gives you top notch performance.

Still, crawling can be resource intensive but Photon has some tricks up it's sleeves. You can fetch URLs archived by archive.org to be used as seeds by using --wayback option.

Plugins

Docker

Photon can be launched using a lightweight Python-Alpine (103 MB) Docker image.

$ git clone https://github.com/s0md3v/Photon.git
$ cd Photon
$ docker build -t photon .
$ docker run -it --name photon photon:latest -u google.com

To view results, you can either head over to the local docker volume, which you can find by running docker inspect photon or by mounting the target loot folder:

$ docker run -it --name photon -v "$PWD:/Photon/google.com" photon:latest -u google.com

Frequent & Seamless Updates

Photon is under heavy development and updates for fixing bugs. optimizing performance & new features are being rolled regularly.

If you would like to see features and issues that are being worked on, you can do that on Development project board.

Updates can be installed & checked for with the --update option. Photon has seamless update capabilities which means you can update Photon without losing any of your saved data.

Contribution & License

You can contribute in following ways:

Please read the guidelines before submitting a pull request or issue.

Do you want to have a conversation in private? Hit me up on my twitter, inbox is open :)

Photon is licensed under GPL v3.0 license

Photon (s0md3v/Photon)

Searching Database…

13.3K ·GitHub
What is this?Photon is a fast web crawler built for OSINT (open-source intelligence) gathering, extracting URLs, emails, social media accounts, secret keys, subdomains and more while it crawls a target site.
Is this a library or a command-line tool?It's a Python command-line crawler you run against a target URL, not a library you import into code.
How do I run it?Run it as a Python script pointed at a target, or launch it via the official lightweight Python-Alpine Docker image and check results in the mounted loot folder.
Do I need anything besides Python to use it?Just Python to run the script, or Docker if you prefer the containerized version; no API keys are required for basic crawling.
Is crawling resource-heavy?Yes, Photon relies on smart thread management to stay fast, but the README itself notes that crawling can still be resource intensive on large targets.
What kind of data can Photon pull out while crawling?It extracts in-scope and out-of-scope URLs, URLs with parameters, intel like emails and social media accounts, files (pdf, png, xml etc.), secret/API keys, JavaScript files and their endpoints, custom regex matches, and subdomain/DNS data, saved organized or exportable as JSON.
What are Photon's plugins for?Built-in plugins include wayback (pull archived URLs from archive.org as seeds), dnsdumpster, and an Exporter for saving results.
How do I keep Photon updated?Run it with the --update option, which checks for and installs updates without losing any of your saved crawl data.
Why would I use the --wayback option?It fetches URLs archived by archive.org to use as additional seeds, helping Photon discover pages that may no longer be linked live on the site.
Creator
s0md3v
Size
0.3 MB
Stars
13.3K
Age
8y
Commits · 90 Days