Skip to main content

A python API module for ShadowTrackr

Project description

ShadowTrackr API for Python

ShadowTrackr is a service that discovers your online attack surface and displays it in a nice graph. Anything found will be monitored for security issues. You can enable notifications by email or push messages, or just ingest them in your SIEM.

All changes to your hosts, websites, certificates, dns and whois records are logged and searchable. Additionally, you can set specific alerts for keywords or events that you want to monitor, for instance a username appearing in leaked data on pastebin.

The API allows you to integrate ShadowTrackr with your other security tools. There are multiple endpoints, but by far the easiest way to gets started is using serach queries. We support both Splunk SPL and Elastic Search (Lucene) syntax thatyou don't have to learn yet another new query language.

More information:

https://shadowtrackr.com/docs/2-Data-Model

https://shadowtrackr.com/docs/3-Search-and-Queries

Installation::

pip install shadowtrackr

Usage::

from shadowtrackr import ShadowTrackr
from pprint import pprint

# first, setup the api with your API key
# you'll find it at: https://shadowtrackr.com/usr/settings?s=api

st = ShadowTrackr(api_key=API_KEY)

certificate_issuers = st.query("index=certificates by issuer earliest=-10d")
pprint(certificate_issuers)

problem_hosts = st.query("index=hosts problem=yes earliest=-1m")
pprint(problem_hosts)

hosts_with_rdp_open = st.query("index=hosts ports=3389")
pprint(hosts_with_rdp_open)

all_spf_records = st.query("index=dns rrtype=txt rrdata=\"*spf*\"")
pprint(all_spf_records)

websites_on_nginx = st.query("index=websites https_server=*nginx*")
pprint(websites_on_nginx)

good_certificates = st.query("index=certificates grade=A earliest=-1m")
pprint(good_certificates)

all_whois_records = st.query("index=whois")
pprint(all_whois_records)

If you need to use a proxy, you can set it like this:

st.set_proxy("10.0.0.1:8080")

You can find the complete API documentation at https://shadowtrackr.com/docs/5-API

If you have any questions or requests, please send them here: https://shadowtrackr.com/support

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

shadowtrackr-5.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

shadowtrackr-5.2-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file shadowtrackr-5.2.tar.gz.

File metadata

  • Download URL: shadowtrackr-5.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for shadowtrackr-5.2.tar.gz
Algorithm Hash digest
SHA256 9ca445bb5ffa3bf6243a5afe023871961cd26967320fb5cd234bc05c3ba331ee
MD5 632ed9d6a3ab9fdd07e55be60282f09b
BLAKE2b-256 bf2373267a4062e590a7f55f0bcfcbf9e1d43d2db0dd70ec951dce15d980885d

See more details on using hashes here.

File details

Details for the file shadowtrackr-5.2-py3-none-any.whl.

File metadata

  • Download URL: shadowtrackr-5.2-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for shadowtrackr-5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 82764b5b8423ca6d3db613e16c331b84b9474dce3ccd7072e8a167d537be6703
MD5 0a2e2f8f027780b7982275d86c41c3be
BLAKE2b-256 609852e2f0cabfc8aa91c6880090fa76c8de8bac521dd9fd1f1371d83f56e805

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