Skip to main content

Website crawling and application mapping for the Klyrek ecosystem

Project description

klyrek-crawler

Breadth-first crawler that maps a target's pages, forms, and script references into a klyrek_core.models.ScanResult. Every fetch goes through a KlyrekHTTPClient (klyrek-http), so scope enforcement and rate limiting are inherited automatically — the crawler additionally skips enqueuing out-of-scope links so it doesn't spend its page budget chasing hosts it isn't authorized to touch.

from klyrek_core.config import KlyrekConfig
from klyrek_core.models import Target
from klyrek_core.scope import AuthorizationScope
from klyrek_http.client import KlyrekHTTPClient
from klyrek_crawler.crawler import Crawler

scope = AuthorizationScope(authorized_hosts=["target.com", "*.target.com"])
target = Target(base_url="https://target.com/", hosts=["target.com"])

with KlyrekHTTPClient(scope, config=KlyrekConfig(rate_limit_per_host=2)) as client:
    crawler = Crawler(client, max_pages=200, max_depth=3)
    result = crawler.crawl(target)

print(len(result.endpoints), "endpoints discovered")

Endpoints are tagged by how they were found: source="crawler" for pages, "crawler-form" for form actions (with field names captured as params), and "crawler-script" for referenced JavaScript files (the raw material klyrek-js consumes).

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

klyrek_crawler-0.1.0.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

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

klyrek_crawler-0.1.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file klyrek_crawler-0.1.0.tar.gz.

File metadata

  • Download URL: klyrek_crawler-0.1.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for klyrek_crawler-0.1.0.tar.gz
Algorithm Hash digest
SHA256 aca22ca1cc6362fc1ec678382582cfea5f8479ff32ea2f4921678d8f8f0c1a6c
MD5 f9d81d250dc3c7edebd34f50029f1eaa
BLAKE2b-256 dec8fe55165610af08eb9467760f14284fadd72858950c13c06d1b7e53b32646

See more details on using hashes here.

File details

Details for the file klyrek_crawler-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: klyrek_crawler-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.2

File hashes

Hashes for klyrek_crawler-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed2c9c9fd955ef126af5500b11640a4d283c98936de8a6707e8bef6a18217af6
MD5 837a970a572d06f40341ec9a56648365
BLAKE2b-256 1fbb9e37465bdc152588ad75aa526945f9c156f0460328cdd574b08260fd992a

See more details on using hashes here.

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