Skip to main content

A Python script to crawl and extract (regular or onion) webpages through TOR network.

Project description

TorCrawl.py Logo

TorCrawl.py is a Python script designed for anonymous web scraping via the Tor network.

It combines ease of use with the robust privacy features of Tor, allowing for secure and untraceable data collection. Ideal for both novice and experienced programmers, this tool is essential for responsible data gathering in the digital age.

Release Last Commit Python Quality Gate Status license

What makes it simple and easy to use?

If you are a terminal maniac you know that things have to be simple and clear. Passing the output into other tools is necessary and accuracy is the key.

With a single argument, you can read an .onion webpage or a regular one, through TOR Network and by using pipes you can pass the output at any other tool you prefer.

$ torcrawl -u http://www.github.com/ | grep 'google-analytics'
    <meta-name="google-analytics" content="UA-XXXXXX- "> 

If you want to crawl the links of a webpage use the -c and BAM you got on a file all the inside links. You can even use -d to crawl them and so on. You can also use the argument -p to wait some seconds before the next crawl.

$ torcrawl -v -u http://www.github.com/ -c -d 2 -p 2
# TOR is ready!
# URL: http://www.github.com/
# Your IP: XXX.XXX.XXX.XXX
# Crawler started from http://www.github.com/ with 2 depth crawl and 2 second(s) delay:
# Step 1 completed with: 11 results
# Step 2 completed with: 112 results
# File created on /path/to/project/links.txt

[!TIP]
Crawling is not illegal, but violating copyright is. It’s always best to double-check a website’s T&C before start crawling them. Some websites set up what’s called robots.txt to tell crawlers not to visit those pages.
This crawler will allow you to go around this, but we always recommend respecting robots.txt.


Installation

Easy Installation:

  • from PyPi:
    pip install torcrawl
  • with homebrew:
    Coming soon...

Manual Installation:

  1. Clone this repository:
    git clone https://github.com/MikeMeliz/TorCrawl.py.git
  2. Install dependencies:
    pip install -r requirements.txt
  3. Install and Start TOR Service:
    1. Debian/Ubuntu:
      apt-get install tor
      service tor start
    2. Windows: Download tor.exe, and:
      tor.exe --service install
      tor.exe --service start
    3. MacOS:
      brew install tor
      brew services start tor
    4. For different distros, visit:
      TOR Setup Documentation

Arguments

arg Long Description
General:
-h --help Help message
-v --verbose Show more information about the progress
-u --url *.onion URL of Webpage to crawl or extract
-w --without Without using TOR Network
-rua --random-ua Enable random user-agent rotation for requests
-rpr --random-proxy Enable random proxy rotation from res/proxies.txt (requires -w flag, one proxy per line, format: host:port)
-px --proxy IP address for SOCKS5 proxy (Default: 127.0.0.1 for using TOR)
-pr --proxyport Port for SOCKS5 proxy (Default: 9050)
-f --folder The directory which will contain the generated files
-V --version Show version and exit
Extract:
-e --extract Extract page's code to terminal or file (Default: Terminal)
-i --input filename Input file with URL(s) (separated by line)
-o --output [filename] Output page(s) to file(s) (for one page)
-y --yara Perform yara keyword search:
h = search entire html object,
t = search only text
Crawl:
-c --crawl Crawl website (Default output on website/links.txt)
-d --depth Set depth of crawler's travel (Default: 1)
-p --pause Seconds of pause between requests (Default: 0)
-j --json Export crawl findings to JSON in addition to txt outputs
-x --xml Export crawl findings to XML in addition to txt outputs
-DB --database Export crawl findings and link graph to SQLite database
-vis --visualization Generate HTML visualization from SQLite database (requires -DB)
-l --log Log file with visited URLs and their response code

Usage & Examples

As Extractor:

To just extract a single webpage to terminal:

$ python torcrawl.py -u http://www.github.com
<!DOCTYPE html>
...
</html>

Extract into a file (github.htm) without the use of TOR:

$ python torcrawl.py -w -u http://www.github.com -o github.htm
## File created on /script/path/github.htm

Extract to terminal and find only the line with google-analytics:

$ python torcrawl.py -u http://www.github.com | grep 'google-analytics'
    <meta name="google-analytics" content="UA-*******-*">

Extract to file and find only the line with google-analytics using yara:

$ python torcrawl.py -v -w -u https://github.com -e -y 0
...

Note: update res/keyword.yar to search for other keywords. Use -y 0 for raw html searching and -y 1 for text search only.

Extract a set of webpages (imported from file) to terminal:

$ python torcrawl.py -i links.txt
...

As Crawler:

Crawl the links of the webpage without the use of TOR, also show verbose output (really helpful):

$ python torcrawl.py -v -w -u http://www.github.com/ -c
## URL: http://www.github.com/
## Your IP: *.*.*.*
## Crawler Started from http://www.github.com/ with step 1 and wait 0
## Step 1 completed with: 11 results
## File created on /script/path/links.txt

Crawl the webpage with depth 2 (2 clicks) and 5 seconds waiting before crawl the next page:

$ python torcrawl.py -v -u http://www.github.com/ -c -d 2 -p 5
## TOR is ready!
## URL: http://www.github.com/
## Your IP: *.*.*.*
## Crawler Started from http://www.github.com with step 2 and wait 5
## Step 1 completed with: 11 results
## Step 2 completed with: 112 results
## File created on /script/path/links.txt

As Both:

You can crawl a page and also extract the webpages into a folder with a single command:

$ python torcrawl.py -v -u http://www.github.com/ -c -d 2 -p 5 -e
## TOR is ready!
## URL: http://www.github.com/
## Your IP: *.*.*.*
## Crawler Started from http://www.github.com with step 1 and wait 5
## Step 1 completed with: 11 results
## File created on /script/path/FolderName/index.htm
## File created on /script/path/FolderName/projects.html
## ...

Note: The default (and only for now) file for crawler's links is the links.txt document. Also, to extract right after the crawl you have to give -e argument

Following the same logic; you can parse all these pages to grep (for example) and search for specific text:

$ python torcrawl.py -u http://www.github.com/ -c -e | grep '</html>'
</html>
</html>
...

As Both + Keyword Search:

You can crawl a page, perform a keyword search and extract the webpages that match the findings into a folder with a single command:

$ python torcrawl.py -v -u http://www.github.com/ -c -d 2 -p 5 -e -y h
## TOR is ready!
## URL: http://www.github.com/
## Your IP: *.*.*.*
## Crawler Started from http://www.github.com with step 1 and wait 5
## Step 1 completed with: 11 results
## File created on /script/path/FolderName/index.htm
## File created on /script/path/FolderName/projects.html
## ...

Note: Update res/keyword.yar to search for other keywords. Use -y h for raw html searching and -y t for text search only.

Demo

TorCrawl-Demo

Contribution

Feel free to contribute on this project! Just fork it, make any change on your fork and add a pull request on current branch!

:shipit: Any advice, help or questions will be appreciated! :shipit:

License

“GPL” stands for “General Public License”. Using the GNU GPL will require that all the released improved versions be free software (More info).

Changelog

v1.35:
    * Introduced visualization (with PyVis)
    * Ability to export in .JSON and .XML
    * Export into SQLite3 with links between URLs
v1.34:
    * Readiness for PyPi and Homebrew
    * Added --version argument
v1.33:
    * Added User-Agent rotation
    * Implemented Proxy rotation
    * Introduced dependabot
v1.32:
    * Removed 1 second default pause between requests
    * Several improvements on results
    * Improved logs
v1.31:
    * Fixed Input Link NoneType Error
    * Fixed name mismatch  
v1.3:
    * Make yara search optional
v1.21:
    * Fixed typos of delay (-d)
    * Fixed TyperError and IndexError 
v1.2:
    * Migrated to Python3
    * Option to generate log file (-l)
    * PEP8 Fixes
    * Fix double folder generation (http:// domain.com)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torcrawl-1.35.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

torcrawl-1.35-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

Details for the file torcrawl-1.35.tar.gz.

File metadata

  • Download URL: torcrawl-1.35.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for torcrawl-1.35.tar.gz
Algorithm Hash digest
SHA256 0e02db0ae9ecef74d7ec91f7798315730007287d1f18755e714c30fae0728aa5
MD5 3cacf864f9b5c7bf9150a86577b3cf04
BLAKE2b-256 9830d564ffff7f8eae284e1c662853840a21a836026fd6ddec092fc1dc34503f

See more details on using hashes here.

Provenance

The following attestation bundles were made for torcrawl-1.35.tar.gz:

Publisher: publish.yml on MikeMeliz/TorCrawl.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file torcrawl-1.35-py3-none-any.whl.

File metadata

  • Download URL: torcrawl-1.35-py3-none-any.whl
  • Upload date:
  • Size: 44.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for torcrawl-1.35-py3-none-any.whl
Algorithm Hash digest
SHA256 93ed606da6523780ab4bc4ce9a447d49143e84548a5a1d2304546cbbc198b350
MD5 8c2caab927fca5e762bb44d132721990
BLAKE2b-256 31ef8fa5b18e27fc68b0320eaf61bfb07c14c676c2cbed97e5bfcda8b16c0e8d

See more details on using hashes here.

Provenance

The following attestation bundles were made for torcrawl-1.35-py3-none-any.whl:

Publisher: publish.yml on MikeMeliz/TorCrawl.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page