What is SpiderFoot?
SpiderFoot is a reconnaissance tool that automatically queries over 100 public data sources (OSINT) to gather intelligence on IP addresses, domain names, e-mail addresses, names and more. You simply specify the target you want to investigate, pick which modules to enable and then SpiderFoot will collect data to build up an understanding of all the entities and how they relate to each other.
What is OSINT?
OSINT (Open Source Intelligence) is data available in the public domain which might reveal interesting information about your target. This includes DNS, Whois, Web pages, passive DNS, spam blacklists, file meta data, threat intelligence lists as well as services like SHODAN, HaveIBeenPwned? and more. Click here to see the full list of data sources SpiderFoot utilises.
What can I do with SpiderFoot?
The data returned from a SpiderFoot scan will reveal a lot of information about your target, providing insight into possible data leaks, vulnerabilities or other sensitive information that can be leveraged during a penetration test, red team exercise or for threat intelligence. Try it out against your own network to see what you might have exposed!
SpiderFoot HX builds upon the open source version’s module base to offer enhanced functionality all aspects of SpiderFoot, including performance, usability, data visualisation, security and more.
In addition to the data collection capabilities of the open source version, SpiderFoot HX takes things a step further with the following features:
- No installation or setup needed at all. Once you register, everything is ready to go. No Python dependencies to install, no virtual machines to spin up or ensuring you have enough compute/memory/disk to run a large scan.
- Investigations. Sometimes, you don’t want full automation of your scan and want to step through the data collection process step-by-step, module-by-module. Investigations provide you with a visual way to take full control of the scanning process.
- Multi-target scanning. In cases where you have multiple entities (domais, e-mail addresses, etc.) related to the same target, you can supply them all as targets of the one scan. This enables SpiderFoot to better identify relationships and find relevant information.
- Scans are faster. Thanks to the completely overhauled backend architecture of SpiderFoot HX, scans run up to 10x faster than the open source version. This means you get the data you need, faster.
- OSINT monitoring. Run scans automatically on a daily, weekly or monthly basis at a time of your choice and have all changes between scans automatically tracked and alerted on.
- Email notifications. Receive email notifications when SpiderFoot scans finish, or when scheduled scans identify changes between scan runs.
- Slack integration. Prefer your notifications over Slack? No problem; input your Slack hook URL and you’ll see notifications in Slack for scan completions and/or change notifications from scheduled scans.
- Import scan targets. When scanning many targets, it might be easier to load them in via CSV, or as exported from Hunchly.
- More modules. SpiderFoot HX adds additional modules for UDP port scanning, identification of languages used in content and screenshotting of certain content like social media profiles, dark web sites and security-sensitive webpages such as those that accept credentials.
- Correlations. During and after a scan completes, the SpiderFoot HX correlation engine is looking for certain conditions that should be immediately investigated. This includes anomalies but also open cloud storage buckets, hostnames only found from certain sources and more.
- Reporting & Visualisations. Slice and dice your scan results by data type, data family, module, module category and data source. Look at each data point in-depth to see how it was discovered, its relationships and more.
- Team collaboration. Got a team working on OSINT and threat intelligence? With SpiderFoot HX, you can have multiple users with role-based access control, collaborating on scans and investigations.
- Annotations. Add notes to scan results and pull them out with the API for rich integrations with internal SIEM tools, investigative platforms and ticketing systems.
- Security. Two-factor authentication (2FA), role-based access control and a fully locked down cloud infrastructure mean you don’t need to deal with the security of your OSINT platform and investigations.
- Anonymous. SpiderFoot HX has TOR integration out of the box and provides no way for a scanned entity to know that it’s you doing the scanning.
- Custom Scan Profiles. Got a particular combination of modules you like to use for your scans but don’t like having to define them each time? With SpiderFoot HX, you can define scan profiles and re-use them for future scans.
- SpiderFoot HX API. The SpiderFoot HX API is a fully documented RESTful API that supports virtually all UI functions so you can orchestrate the platform and extract data programmatically.
Aside from this document, you’ll be able to get help with SpiderFoot from a number of places:
- CLI tutorials on asciinema.org/~spiderfoot
- Ask a question in the #spiderfoot room on the osint.team RocketChat
- Raising an issue in the Github repo
- Emailing email@example.com
If you would like to side-step having to install anything to get SpiderFoot running on Linux, follow the instructions here to run SpiderFoot in a Docker container.
SpiderFoot is written in Python (2.7, with support for 3.x in development), so to run on Linux/Solaris/FreeBSD/etc. you need Python 2.7 installed, in addition to the various module dependencies. To install the dependencies using PIP, run the following:
$ pip install -r requirements.txt
On some Linux distributions, you might get an error about M2Crypto, so you must install it using APT instead and re-try with pip:
$ apt-get install python-m2crypto $ pip install -r requirements.txt
If you’re using SpiderFoot 2.12 for Windows, you’ll have a compiled executable (.EXE) file and so all dependencies are packaged with it. No third party tools/libraries need to be installed, not even Python.
After version 2.12 however, SpiderFoot no longer ships with a .EXE file for running on Windows due to the stale nature of py2exe and inability to build some dependencies properly anymore on Windows.
Fortunately, with Python for Windows you can follow the below instructions to get SpiderFoot dependencies installed on Windows easily:
- Install Python for Windows
- Install PIP by downloading this file and running it with Python simply by doing:
- Run pip as you would have for Linux by doing:
pip install -r requirements.txt
- (Optional if you want to run from the repository and not a packaged release) Install git
Installing on MacOS X is facilitated by using the Homebrew package manager to install Python 2.7, pip and then installing SpiderFoot dependencies as you would on Linux:
- First, make sure you have Homebrew installed. Try running
brewand if that doesn’t work, install it.
- Install Python 2.7 with
brew install python@2and this will also install pip
- With pip you can now install the SpiderFoot dependencies as you would on Linux with
pip install -r requirements.txt
- (Optional if you want to run from the repository and not a packaged release) Install git with
brew install git
SpiderFoot can be installed using
git (this is the recommended approach as you’ll always have the latest version by simply doing a
git pull), or by downloading a tarball of a release. The approach is the same regardless of platform:
$ git clone https://github.com/smicallef/spiderfoot.git $ cd spiderfoot ~/spiderfoot$
As a package
$ wget https://github.com/smicallef/spiderfoot/archive/v2.12.0-final.tar.gz $ tar zxvf v2.12.0-final.tar.gz $ cd spiderfoot ~/spiderfoot$
A note about older versions and dependencies
If you’re using SpiderFoot 2.12 on Linux or an older cloned version from the Github repository, some pre-requisites need to be installed:
$ pip install -r requirements.txt
On some distros, instead of M2Crypto, you must install it using APT instead:
$ apt-get install python-m2crypto
Other modules such as PyPDF2, SOCKS and more are included in the 2.12 package, so you don’t need to install them separately.
To run SpiderFoot, simply execute
sf.py from the directory you extracted/pulled SpiderFoot into:
~/spiderfoot$ python sf.py
Once executed, a web-server will be started, which by default will listen on 127.0.0.1:5001. You can then use the web-browser of your choice by browsing to https://127.0.0.1:5001. Or, since version 2.10 you can use the CLI, which by default will connect to the server locally, on 127.0.0.1:5001:
~/spiderfoot$ python sfcli.py
If you wish to make SpiderFoot accessible from another system, for example running it on a server and controlling it remotely, then you can specify an external IP for SpiderFoot to bind to, or use 0.0.0.0 so that it binds to all addresses, including 127.0.0.1:
~/spiderfoot$ python sf.py 0.0.0.0:5001
Then to use the CLI in such a case, from a remote system where the
sfcli.py file has been copied to, you would run:
$ python sfcli.py -u https://<remote ip>:5001
python ./sfcli.py --help to better understand how to use the CLI.
If port 5001 is used by another application on your system, you can change the port:
~/spiderfoot$ python sf.py 127.0.0.1:9999
Once started, you will see something similar to this, which means you are ready to go. If you instead see an error message about missing modules, please go back and ensure you’ve installed all the pre-requisites.
~/spiderfoot$ python ./sf.py 0.0.0.0:5001 Attempting to verify database and update if necessary... Starting web server at https://0.0.0.0:5001 ... ************************************************************* Use SpiderFoot by starting your web browser of choice and browse to https://<IP of this host>:5001 ************************************************************* [08/Jul/2019:14:40:53] ENGINE Listening for SIGHUP. [08/Jul/2019:14:40:53] ENGINE Listening for SIGTERM. [08/Jul/2019:14:40:53] ENGINE Listening for SIGUSR1. [08/Jul/2019:14:40:53] ENGINE Bus STARTING [08/Jul/2019:14:40:53] ENGINE Serving on https://0.0.0.0:5001 [08/Jul/2019:14:40:53] ENGINE Bus STARTED
By default, SpiderFoot does not authenticate users connecting to its user-interface or serve over HTTPS, so avoid running it on a server/workstation that can be accessed from untrusted devices, as they will be able to control SpiderFoot remotely and initiate scans from your devices. As of SpiderFoot 2.7, to use authentication and HTTPS, see the Security section below.
With version 2.7, SpiderFoot introduced authentication as well as TLS/SSL support. These are automatic based on the presence of specific files.
SpiderFoot will require basic digest authentication if a file named
passwd exists in the SpiderFoot root directory. The format of the file is simple – just create an entry per account, in the format of:
Once the file is created, restart SpiderFoot.
SpiderFoot will serve HTTPS (and only that) if it detects the existence of a public certificate and key file in SpiderFoot’s root directory. This means whatever port you set SpiderFoot to listen on is the port TLS/SSL will be used. It is not possible for SpiderFoot to serve both HTTP and HTTPS simultaneously on different ports. If you need to do that, an nginx proxy in front of SpiderFoot would be a better solution.
Simply place two files in the SpiderFoot directory –
spiderfoot.crt (RSA public key in PEM format) and
spiderfoot.key (RSA private key in PEM format). Restart SpiderFoot and you will now be serving HTTPS only.
For instructions on generating a self-signed certificate, check out this StackOverflow article.
Many SpiderFoot modules require API keys to function to their fullest extent (or at all), so you will need to go to each service and obtain an API key where you feel that having such a key would add value to your scans. How to obtain those keys goes beyond the scope of this documentation, but generally the pattern looks like:
- Google the name of the service
- Go to their website
- Sign up
- Under your account settings or similar, there’s an API key
- Enter the API key into the SpiderFoot UI under the Settings section for the respective module (and ensure you have enough credits with that service)
The below instructions are for historical purposes only and are no longer maintained:
- Go to https://www.projecthoneypot.org
- Sign up (free) and log in
- Click Services -> HTTP Blacklist
- An API key should be listed
- Copy and paste that key into the Settings -> Honeypot Checker section in SpiderFoot
- Go to https://www.shodanhq.com
- Sign up (free) and log in
- Click ‘Developer Center’
- On the far right your API key should appear in a box
- Copy and paste that key into the Settings -> SHODAN section in SpiderFoot
- Go to https://www.virustotal.com
- Sign up (free) and log in
- Click your username in the far right and select ‘My API Key’
- Copy and paste the key in the grey box into the Settings -> VirusTotal section in SpiderFoot
IBM X-Force Exchange
- Go to https://exchange.xforce.ibmcloud.com/new
- Create an IBM ID (free) and log in
- Go to your account settings
- Click API Access
- Generate the API key and password (you need both)
- Copy and paste the key and password into the Settings -> X-Force section in SpiderFoot
- Go to https://www.malwarepatrol.net
- Create an account (free) and log in
- Click “Open Source” and scroll down to the bottom
- Click the “Free” link in the subscription pricing table
- Click the free block lists link
- You will receive a receipt ID
- Copy and paste the receipt ID into the Settings -> MalwarePatrol section in SpiderFoot
- Go to https://www.botscout.com
- Create an account (free) and log in
- Under Account Info, your API key will be there
- Copy and paste the API key into the Settings -> BotScout section in SpiderFoot
- Go to https://www.cymon.io
- Create an account (free) and log in
- Under “My API Dashboard”, your API key will be there
- Copy and paste the API key into the Settings -> Cymon section in SpiderFoot
- Go to https://www.censys.io
- Create an account (free) and log in
- Click “My Account” (bottom right)
- Copy and paste the API Credentials values into the Settings -> Censys section in SpiderFoot
- Go to https://www.hunter.io
- Create an account (free) and log in
- Click “API” in the top menu-base
- Copy and paste the API key into the Settings -> Hunter.io section in SpiderFoot
- Go to https://otx.alienvault.com/ and sign up
- Log in and click your account on the top right, go to Settings
- Scroll down and copy and paste the OTX Key value into the Settings -> AlienVault OTX section in SpiderFoot
- Go to https://dashboard.clearbit.com/login and sign up
- Log in and click the API link on the left
- Copy and paste the “secret” API key into the Settings -> Clearbit section in SpiderFoot
- Go to https://www.builtwith.com and sign up. You get 50 queries for free before having to pay (it’s totally worth it though)
- Log in and click on the “Domain API” tab. No other API key type will work with SpiderFoot!
- Your API key will appear on the right
- Copy and paste it into the Settings -> BuiltWith section in SpiderFoot
- Go to https://fraudguard.io
- Register with the plan you choose. The free plan is also available
- Click to ‘Create’ an API key, in the form of a username and password
- Copy and paste both into the Settings -> Fraudguard section in SpiderFoot
- Go to https://ipinfo.io
- Click on Pricing and select the plan you choose. They offer a very generous free plan with 1,000 queries per day
- Click Subscribe, enter your details and follow the registration process
- Copy and paste the ‘Access token’ in your Profile to the Settings -> ipinfo.io section in SpiderFoot
- Contact CIRCL.LU and ask for Passive DNS and Passive SSL. They are very responsive and will provide you credentials
- Enter the credentials into the Settings -> CIRCL.LU section in SpiderFoot
- Go to the SecurityTrails pricing page
- Select the plan you want and click Sign-up, complete the sign-up process
- Enter the provided API key into the Settings -> SecurityTrails section in SpiderFoot
- Go to https://fullcontact.com and follow the sign-up process
- Log in to the dashboard and create an API key
- Copy and paste the API key into the Settings -> FullContact.com section in SpiderFoot
- Go to https://riskiq.com and click the “Sign up for the Free Edition” link up top
- Click Register for the Free Edition
- Fill out your details and complete the registration process
- Log in
- Click your account icon in the top right and go to Account Settings
- Go to the “API Access” section and click the “Show” link next to User
- Copy the key and secret into the Settings -> RiskIQ section in SpiderFoot
A free API key has been provided and will be used if you do not have your own. To obtain your own key, you will need to follow the instructions on the citadel.pwwebsite.
One of the main principles behind SpiderFoot is that it’s highly configurable. Every setting is available in the user interface within the Settings section and should be adequately explained there. Just a few key points to note:
- API keys can be imported and exported between SpiderFoot and SpiderFoot HX using the “Import API Keys” and “Export API Keys” functions. The format is also a simple CSV so can also be manipulated outside of SpiderFoot to be loaded in, if you prefer.
- When Debugging is enabled, a lot of logs are generated and can sometimes result in error messages about database locking. This appears to be harmless towards the scan but can mean that logs get dropped.
- It is worth going through the modules you intend to rely upon heavily to ensure they are configured appropriately for your needs, most importantly the DNS-related modules as they tend to have a knock-on impact to many other modules.
Running a Scan
When you run SpiderFoot for the first time, there is no historical data, so you should be presented with a screen like the following:
To initiate a scan, click on the ‘New Scan’ button in the top menu bar. You will then need to define a name for your scan (these are non-unique) and a target (also non-unique):
You can then define how you would like to run the scan – either by use case (the tab selected by default), by data required or by module.
Module-based scanning is for more advanced users who are familiar with the behavior and data provided by different modules, and want more control over the scan:
Beware though, there is no dependency checking when scanning by module, only for scanning by required data. This means that if you select a module that depends on event types only provided by other modules, but those modules are not selected, you will get no results.
From the moment you click ‘Run Scan’, you will be taken to a screen for monitoring your scan in near real time:
That screen is made up of a graph showing a break down of the data obtained so far plus log messages generated by SpiderFoot and its modules.
The bars of the graph are clickable, taking you to the result table for that particular data type.
By clicking on the ‘Browse’ button for a scan, you can browse the data by type:
This data is exportable and searchable. Click the Search box to get a pop-up explaining how to perform searches.
By clicking on one of the data types, you will be presented with the actual data:
The fields displayed are explained as follows:
- Checkbox field: Use this to set/unset fields as false positive. Once at least one is checked, click the orange False Positive button above to set/unset the record.
- Data Element: The data the module was able to obtain about your target.
- Source Data Element: The data the module received as the basis for its data colletion. In the example above, the sfp_portscan_tcp module received an event about an open port, and used that to obtain the banner on that port.
- Source Module: The module that identified this data.
- Identified: When the data was identified by the module.
You can click the black icons to modify how this data is represented. For instance you can get a unique data representation by clicking the Unique Data View icon:
Setting False Positives
Version 2.6.0 introduced the ability to set data records as false positive. As indicated in the previous section, use the checkbox and the orange button to set/unset records as false positive:
Once you have set records as false positive, you will see an indicator next to those records, and have the ability to filter them from view, as shown below:
NOTE: Records can only be set to false positive once a scan has finished running. This is because setting a record to false positive also results in all child data elements being set to false positive. This obviously cannot be done if the scan is still running and can thus lead to an inconsistent state in the back-end. The UI will prevent you from doing so.
The result of a record being set to false positive, aside from the indicator in the data table view and exports, is that such data will not be shown in the node graphs.
Results can be searched either at the whole scan level, or within individual data types. The scope of the search is determined by the screen you are on at the time.
As indicated by the pop-up box when selecting the search field, you can search as follows:
- Exact value: Non-wildcard searching for a specific value. For example, search for 404 within the HTTP Status Code section to see all pages that were not found.
- Pattern matching: Search for simple wildcards to find patterns. For example, search for *:22 within the Open TCP Port section to see all instances of port 22 open.
- Regular expression searches: Encapsulate your string in ‘/’ to search by regular expression. For example, search for ‘/\d+.\d+.\d+.\d+/’ to find anything looking like an IP address in your scan results.
When you have some historical scan data accumulated, you can use the list available on the ‘Scans’ section to manage them:
You can filter the scans shown by altering the Filter drop-down selection. Except for the green refresh icon, all icons on the right will all apply to whichever scans you have checked the checkboxes for.
Refer to this post for more information.
SpiderFoot has all data collection modularised. When a module discovers a piece of data, that data is transmitted to all other modules that are ‘interested’ in that data type for processing. Those modules will then act on that piece of data to identify new data, and in turn generate new events for other modules which may be interested, and so on.
sfp_dnsresolve may identify an IP address associated with your target, notifying all interested modules. One of those interested modules would be the
sfp_ripe module, which will take that IP address and identify the netblock it is a part of, the BGP ASN and so on.
This might be best illustrated by looking at module code. For example, the
sfp_names module looks for TARGET_WEB_CONTENT and EMAILADDR events for identifying human names:
# What events is this module interested in for input # * = be notified about all events. def watchedEvents(self): return ["TARGET_WEB_CONTENT", "EMAILADDR"] # What events this module produces # This is to support the end user in selecting modules based on events # produced. def producedEvents(self): return ["HUMAN_NAME"]
Meanwhile, as each event is generated to a module, it is also recorded in the SpiderFoot database for reporting and viewing in the UI.
The below table is an up-to-date list of all SpiderFoot modules and a short summary of their capabilities.
|sfp_abusech.py||abuse.ch||Check if a host/domain, IP or netblock is malicious according to abuse.ch.|
|sfp_abuseipdb.py||AbuseIPDB||Check if a netblock or IP is malicious according to AbuseIPDB.com.|
|sfp_accounts.py||Accounts||Look for possible associated accounts on nearly 200 websites like Ebay, Slashdot, reddit, etc.|
|sfp_adblock.py||AdBlock Check||Check if linked pages would be blocked by AdBlock Plus.|
|sfp_ahmia.py||Ahmia||Search Tor ‘Ahmia’ search engine for mentions of the target domain.|
|sfp_alienvault.py||AlienVault OTX||Obtain information from AlienVault Open Threat Exchange (OTX)|
|sfp_alienvaultiprep.py||AlienVault IP Reputation||Check if an IP or netblock is malicious according to the AlienVault IP Reputation database.|
|sfp_archiveorg.py||Archive.org||Identifies historic versions of interesting files/pages from the Wayback Machine.|
|sfp_arin.py||ARIN||Queries ARIN registry for contact information.|
|sfp_azureblobstorage.py||Azure Blob Finder||Search for potential Azure blobs associated with the target and attempt to list their contents.|
|sfp_badipscom.py||badips.com||Check if a domain or IP is malicious according to badips.com.|
|sfp_bambenek.py||Bambenek C&C List||Check if a host/domain or IP appears on Bambenek Consulting’s C&C tracker lists.|
|sfp_base64.py||Base64||Identify Base64-encoded strings in any content and URLs, often revealing interesting hidden information.|
|sfp_binaryedge.py||BinaryEdge||Obtain information from BinaryEdge.io’s Internet scanning systems about breaches, vulerabilities, torrents and passive DNS.|
|sfp_bingsearch.py||Bing||Some light Bing scraping to identify sub-domains and links.|
|sfp_bingsharedip.py||Bing (Shared IPs)||Search Bing for hosts sharing the same IP.|
|sfp_binstring.py||Binary String Extractor||Attempt to identify strings in binary content.|
|sfp_bitcoin.py||Bitcoin Finder||Identify bitcoin addresses in scraped webpages.|
|sfp_blockchain.py||Blockchain||Queries blockchain.info to find the balance of identified bitcoin wallet addresses.|
|sfp_blocklistde.py||blocklist.de||Check if a netblock or IP is malicious according to blocklist.de.|
|sfp_botscout.py||BotScout||Searches botscout.com’s database of spam-bot IPs and e-mail addresses.|
|sfp_builtwith.py||BuiltWith||Query BuiltWith.com’s Domain API for information about your target’s web technology stack, e-mail addresses and more.|
|sfp_callername.py||CallerName||Lookup US phone number location and reputation information.|
|sfp_censys.py||Censys||Obtain information from Censys.io|
|sfp_cinsscore.py||CINS Army List||Check if a netblock or IP is malicious according to cinsscore.com’s Army List.|
|sfp_circllu.py||CIRCL.LU||Obtain information from CIRCL.LU’s Passive DNS and Passive SSL databases.|
|sfp_citadel.py||Citadel Engine||Searches Leak-Lookup.com’s database of breaches.|
|sfp_cleanbrowsing.py||Cleanbrowsing.org||Check if a host would be blocked by Cleanbrowsing.org DNS|
|sfp_cleantalk.py||CleanTalk Spam List||Check if an IP is on CleanTalk.org’s spam IP list.|
|sfp_clearbit.py||Clearbit||Check for names, addresses, domains and more based on lookups of e-mail addresses on clearbit.com.|
|sfp_coinblocker.py||CoinBlocker Lists||Check if a host/domain or IP appears on CoinBlocker lists.|
|sfp_commoncrawl.py||CommonCrawl||Searches for URLs found through CommonCrawl.org.|
|sfp_comodo.py||Comodo||Check if a host would be blocked by Comodo DNS|
|sfp_company.py||Company Names||Identify company names in any obtained data.|
|sfp_cookie.py||Cookies||Extract Cookies from HTTP headers.|
|sfp_crossref.py||Cross-Reference||Identify whether other domains are associated (‘Affiliates’) of the target.|
|sfp_crt.py||Certificate Transparency||Gather hostnames from historical certificates in crt.sh.|
|sfp_cryptoioc.py||CryptoIOC.ch||Check if an IP is participating in malicious cryptocurrency mining.|
|sfp_customfeed.py||Custom Threat Feed||Check if a host/domain, netblock, ASN or IP is malicious according to your custom feed.|
|sfp_cybercrimetracker.py||cybercrime-tracker.net||Check if a host/domain or IP is malicious according to cybercrime-tracker.net.|
|sfp_darksearch.py||Darksearch||Search the Darksearch.io Tor search engine for mentions of the target domain.|
|sfp_digitaloceanspace.py||Digital Ocean Space Finder||Search for potential Digital Ocean Spaces associated with the target and attempt to list their contents.|
|sfp_dnsbrute.py||DNS Brute-force||Attempts to identify hostnames through brute-forcing common names and iterations.|
|sfp_dnscommonsrv.py||DNS Common SRV||Attempts to identify hostnames through common SRV.|
|sfp_dnsneighbor.py||DNS Look-aside||Attempt to reverse-resolve the IP addresses next to your target to see if they are related.|
|sfp_dnsraw.py||DNS Raw Records||Retrieves raw DNS records such as MX, TXT and others.|
|sfp_dnsresolve.py||DNS Resolver||Resolves Hosts and IP Addresses identified, also extracted from raw content.|
|sfp_dnszonexfer.py||DNS Zone Transfer||Attempts to perform a full DNS zone transfer.|
|sfp_dronebl.py||DroneBL||Query the DroneBL database for open relays, open proxies, vulnerable servers, etc.|
|sfp_duckduckgo.py||DuckDuckGo||Query DuckDuckGo’s API for descriptive information about your target.|
|sfp_email.py||Identify e-mail addresses in any obtained data.|
|sfp_emailformat.py||EmailFormat||Look up e-mail addresses on email-format.com.|
|sfp_errors.py||Errors||Identify common error messages in content like SQL errors, etc.|
|sfp_ethereum.py||Ethereum Finder||Identify ethereum addresses in scraped webpages.|
|sfp_filemeta.py||File Metadata||Extracts meta data from documents and images.|
|sfp_flickr.py||Flickr||Look up e-mail addresses on Flickr.|
|sfp_fortinet.py||Fortiguard.com||Check if an IP is malicious according to Fortiguard.com.|
|sfp_fraudguard.py||Fraudguard||Obtain threat information from Fraudguard.io|
|sfp_fullcontact.py||FullContact||Gather domain and e-mail information from fullcontact.com.|
|sfp_github.py||Github||Identify associated public code repositories on Github.|
|sfp_googlemaps.py||Google Maps||Identifies potential physical addresses and latitude/longitude coordinates.|
|sfp_googlesearch.py||Some light Google scraping to identify sub-domains and links.|
|sfp_googlesearchdomain.py||Google Search, by domain||Some light Google scraping to identify sub-domains and links within site|
|sfp_gravatar.py||Gravatar||Retrieve user information from Gravatar API.|
|sfp_greynoise.py||Greynoise||Obtain information from Greynoise.io’s Enterprise API.|
|sfp_h1nobbdde.py||HackerOne (Unofficial)||Check external vulnerability scanning/reporting service h1.nobbd.de to see if the target is listed.|
|sfp_hackertarget.py||HackerTarget.com||Search HackerTarget.com for hosts sharing the same IP.|
|sfp_haveibeenpwned.py||HaveIBeenPwned||Check Have I Been Pwned? for hacked e-mail addresses identified.|
|sfp_honeypot.py||Honeypot Checker||Query the projecthoneypot.org database for entries.|
|sfp_hosting.py||Hosting Providers||Find out if any IP addresses identified fall within known 3rd party hosting ranges, e.g. Amazon, Azure, etc.|
|sfp_hostsfilenet.py||hosts-file.net Malicious Hosts||Check if a host/domain is malicious according to hosts-file.net Malicious Hosts.|
|sfp_hunter.py||Hunter.io||Check for e-mail addresses and names on hunter.io.|
|sfp_iknowwhatyoudownload.py||Iknowwhatyoudownload.com||Check iknowwhatyoudownload.com for IP addresses that have been using BitTorrent.|
|sfp_intelx.py||IntelligenceX||Obtain information from IntelligenceX about identified IP addresses, domains, e-mail addresses and phone numbers.|
|sfp_intfiles.py||Interesting Files||Identifies potential files of interest, e.g. office documents, zip files.|
|sfp_ipinfo.py||IPInfo.io||Identifies the physical location of IP addresses identified using ipinfo.io.|
|sfp_ipstack.py||ipstack||Identifies the physical location of IP addresses identified using ipstack.com.|
|sfp_isc.py||Internet Storm Center||Check if an IP is malicious according to SANS ISC.|
|sfp_junkfiles.py||Junk Files||Looks for old/temporary and other similar files.|
|sfp_malc0de.py||malc0de.com||Check if a netblock or IP is malicious according to malc0de.com.|
|sfp_malwaredomainlist.py||malwaredomainlist.com||Check if a host/domain, IP or netblock is malicious according to malwaredomainlist.com.|
|sfp_malwaredomains.py||malwaredomains.com||Check if a host/domain is malicious according to malwaredomains.com.|
|sfp_malwarepatrol.py||MalwarePatrol||Searches malwarepatrol.net’s database of malicious URLs/IPs.|
|sfp_mnemonic.py||Mnemonic PassiveDNS||Obtain Passive DNS information from PassiveDNS.mnemonic.no.|
|sfp_multiproxy.py||multiproxy.org Open Proxies||Check if an IP is an open proxy according to multiproxy.org’ open proxy list.|
|sfp_myspace.py||MySpace||Gather username and location from MySpace.com profiles.|
|sfp_names.py||Name Extractor||Attempt to identify human names in fetched content.|
|sfp_neutrinoapi.py||NeutrinoAPI||Search NeutrinoAPI for IP address info and check IP reputation.|
|sfp_norton.py||Norton ConnectSafe||Check if a host would be blocked by Norton ConnectSafe DNS|
|sfp_nothink.py||Nothink.org||Check if a host/domain, netblock or IP is malicious according to Nothink.org.|
|sfp_numinfo.py||numinfo||Lookup phone number information from numinfo.net.|
|sfp_numpi.py||numpi||Lookup USA/Canada phone number location and carrier information from numpi.com.|
|sfp_numverify.py||numverify||Lookup phone number location and carrier information from numverify.com.|
|sfp_onioncity.py||Onion.link||Search Tor ‘Onion City’ search engine for mentions of the target domain.|
|sfp_onionsearchengine.py||Onionsearchengine.com||Search Tor onionsearchengine.com for mentions of the target domain.|
|sfp_openbugbounty.py||Open Bug Bounty||Check external vulnerability scanning/reporting service openbugbounty.org to see if the target is listed.|
|sfp_opencorporates.py||OpenCorporates||Look up company information from OpenCorporates.|
|sfp_opendns.py||OpenDNS||Check if a host would be blocked by OpenDNS DNS|
|sfp_openphish.py||OpenPhish||Check if a host/domain is malicious according to OpenPhish.com.|
|sfp_openstreetmap.py||OpenStreetMap||Retrieves latitude/longitude coordinates for physical addresses from OpenStreetMap API.|
|sfp_pageinfo.py||Page Info||Obtain information about web pages (do they take passwords, do they contain forms, etc.)|
|sfp_pastebin.py||PasteBin||PasteBin scraping (via Google) to identify related content.|
|sfp_peegeepee.py||PeeGeePee||Look up e-mail addresses and domains on PeeGeePee.com.|
|sfp_pgp.py||PGP Key Look-up||Look up e-mail addresses in PGP public key servers.|
|sfp_phishtank.py||PhishTank||Check if a host/domain is malicious according to PhishTank.|
|sfp_phone.py||Phone Numbers||Identify phone numbers in scraped webpages.|
|sfp_portscan_tcp.py||Port Scanner – TCP||Scans for commonly open TCP ports on Internet-facing systems.|
|sfp_psbdmp.py||Psbdmp.com||Check psbdmp.cc (PasteBin Dump) for potentially hacked e-mails and domains.|
|sfp_pulsedive.py||Pulsedive||Obtain information from Pulsedive’s API.|
|sfp_quad9.py||Quad9||Check if a host would be blocked by Quad9|
|sfp_ripe.py||RIPE||Queries the RIPE registry (includes ARIN data) to identify netblocks and other info.|
|sfp_riskiq.py||RiskIQ||Obtain information from RiskIQ’s (formerly PassiveTotal) Passive DNS and Passive SSL databases.|
|sfp_robtex.py||Robtex||Search Robtex.com for hosts sharing the same IP.|
|sfp_s3bucket.py||Amazon S3 Bucket Finder||Search for potential Amazon S3 buckets associated with the target and attempt to list their contents.|
|sfp_securitytrails.py||SecurityTrails||Obtain Passive DNS and other information from SecurityTrails|
|sfp_shodan.py||SHODAN||Obtain information from SHODAN about identified IP addresses.|
|sfp_similar.py||Similar Domains||Search various sources to identify similar looking domain names, for instance squatted domains.|
|sfp_skymem.py||Skymem||Look up e-mail addresses on Skymem.|
|sfp_slideshare.py||SlideShare||Gather name and location from SlideShare profiles.|
|sfp_social.py||Social Networks||Identify presence on social media networks such as LinkedIn, Twitter and others.|
|sfp_socialprofiles.py||Social Media Profiles||Tries to discover the social media profiles for human names identified.|
|sfp_sorbs.py||SORBS||Query the SORBS database for open relays, open proxies, vulnerable servers, etc.|
|sfp_spamcop.py||SpamCop||Query various spamcop databases for open relays, open proxies, vulnerable servers, etc.|
|sfp_spamhaus.py||Spamhaus||Query the Spamhaus databases for open relays, open proxies, vulnerable servers, etc.|
|sfp_spider.py||Spider||Spidering of web-pages to extract content for searching.|
|sfp_spyonweb.py||SpyOnWeb||Search SpyOnWeb for hosts sharing the same IP address, Google Analytics code, or Google Adsense code.|
|sfp_sslcert.py||SSL Certificates||Gather information about SSL certificates used by the target’s HTTPS sites.|
|sfp_ssltools.py||SSL Tools||Gather information about SSL certificates from SSLTools.com.|
|sfp_strangeheaders.py||Strange Headers||Obtain non-standard HTTP headers returned by web servers.|
|sfp_sublist3r.py||Sublist3r||Obtain information from Sublist3r’s database of hostnames.|
|sfp_talosintel.py||Talos Intelligence||Check if a netblock or IP is malicious according to talosintelligence.com.|
|sfp_threatcrowd.py||ThreatCrowd||Obtain information from ThreatCrowd about identified IP addresses, domains and e-mail addresses.|
|sfp_threatexpert.py||ThreatExpert.com||Check if a host/domain or IP is malicious according to ThreatExpert.com.|
|sfp_threatminer.py||ThreatMiner||Obtain information from ThreatMiner’s database for passive DNS and threat intelligence.|
|sfp_tldsearch.py||TLD Search||Search all Internet TLDs for domains with the same name as the target (this can be very slow.)|
|sfp_tool_cmseek.py||Tool – CMSeeK||Identify what Content Management System (CMS) might be used.|
|sfp_tool_dnstwist.py||Tool – DNSTwist||Identify bit-squatting, typo and other similar domains to the target using a local DNSTwist installation.|
|sfp_torch.py||TORCH||Search Tor ‘TORCH’ search engine for mentions of the target domain.|
|sfp_torexits.py||TOR Exit Nodes||Check if an IP or netblock appears on the torproject.org exit node list.|
|sfp_torserver.py||TOR Servers||Check if an IP or netblock appears on the blutmagie.de TOR server list.|
|sfp_totalhash.py||TotalHash.com||Check if a host/domain or IP is malicious according to TotalHash.com.|
|sfp_twitter.py||Gather name and location from Twitter profiles.|
|sfp_uceprotect.py||UCEPROTECT||Query the UCEPROTECT databases for open relays, open proxies, vulnerable servers, etc.|
|sfp_viewdns.py||ViewDNS.info||Reverse Whois lookups using ViewDNS.info.|
|sfp_virustotal.py||VirusTotal||Obtain information from VirusTotal about identified IP addresses.|
|sfp_voipbl.py||VoIPBL OpenPBX IPs||Check if an IP or netblock is an open PBX according to VoIPBL OpenPBX IPs.|
|sfp_vxvault.py||VXVault.net||Check if a domain or IP is malicious according to VXVault.net.|
|sfp_watchguard.py||Watchguard||Check if an IP is malicious according to Watchguard’s reputationauthority.org.|
|sfp_webanalytics.py||Web Analytics||Identify web analytics IDs in scraped webpages.|
|sfp_webframework.py||Web Framework||Identify the usage of popular web frameworks like jQuery, YUI and others.|
|sfp_webserver.py||Web Server||Obtain web server banners to identify versions of web servers being used.|
|sfp_whatcms.py||WhatCMS||Check web technology using WhatCMS.org API.|
|sfp_whois.py||Whois||Perform a WHOIS look-up on domain names and owned netblocks.|
|sfp_whoisology.py||Whoisology||Reverse Whois lookups using Whoisology.com.|
|sfp_whoxy.py||Whoxy||Reverse Whois lookups using Whoxy.com.|
|sfp_wigle.py||Wigle.net||Query wigle.net to identify nearby WiFi access points.|
|sfp_wikileaks.py||Wikileaks||Search Wikileaks for mentions of domain names and e-mail addresses.|
|sfp_wikipediaedits.py||Wikipedia Edits||Identify edits to Wikipedia articles made from a given IP address or username.|
|sfp_xforce.py||XForce Exchange||Obtain information from IBM X-Force Exchange|
|sfp_yandexdns.py||Yandex DNS||Check if a host would be blocked by Yandex DNS|
|sfp_zoneh.py||Zone-H Defacement Check||Check if a hostname/domain appears on the zone-h.org ‘special defacements’ RSS feed.|
As mentioned above, SpiderFoot works on an “event-driven” module, whereby each module generates events about data elements which other modules listen to and consume.
The data elements are one of the following types:
- entities like IP addresses, Internet names (hostnames, sub-domains, domains),
- sub-entities like port numbers, URLs and software installed,
- descriptors of those entities (malicious, physical location information, …) or
- data which is mostly unstructured data (web page content, port banners, raw DNS records, …)
Here are all the available data elements built into SpiderFoot:
|Element ID||Element Name||Element Data Type|
|ROOT||Internal SpiderFoot Root event||INTERNAL|
|ACCOUNT_EXTERNAL_OWNED||Account on External Site||ENTITY|
|ACCOUNT_EXTERNAL_OWNED_COMPROMISED||Hacked Account on External Site||DESCRIPTOR|
|ACCOUNT_EXTERNAL_USER_SHARED_COMPROMISED||Hacked User Account on External Site||DESCRIPTOR|
|AFFILIATE_EMAILADDR||Affiliate – Email Address||ENTITY|
|AFFILIATE_INTERNET_NAME||Affiliate – Internet Name||ENTITY|
|AFFILIATE_IPADDR||Affiliate – IP Address||ENTITY|
|AFFILIATE_WEB_CONTENT||Affiliate – Web Content||DATA|
|AFFILIATE_DOMAIN||Affiliate – Domain Name||ENTITY|
|AFFILIATE_COMPANY_NAME||Affiliate – Company Name||ENTITY|
|AFFILIATE_DOMAIN_WHOIS||Affiliate – Domain Whois||DATA|
|AFFILIATE_DESCRIPTION_CATEGORY||Affiliate Description – Category||DESCRIPTOR|
|AFFILIATE_DESCRIPTION_ABSTRACT||Affiliate Description – Abstract||DESCRIPTOR|
|APPSTORE_ENTRY||App Store Entry||ENTITY|
|CLOUD_STORAGE_BUCKET||Cloud Storage Bucket||ENTITY|
|CLOUD_STORAGE_BUCKET_OPEN||Cloud Storage Bucket Open||DESCRIPTOR|
|BGP_AS_OWNER||BGP AS Ownership||ENTITY|
|BGP_AS_MEMBER||BGP AS Membership||ENTITY|
|BGP_AS_PEER||BGP AS Peer||ENTITY|
|BLACKLISTED_IPADDR||Blacklisted IP Address||DESCRIPTOR|
|BLACKLISTED_AFFILIATE_IPADDR||Blacklisted Affiliate IP Address||DESCRIPTOR|
|BLACKLISTED_SUBNET||Blacklisted IP on Same Subnet||DESCRIPTOR|
|BLACKLISTED_NETBLOCK||Blacklisted IP on Owned Netblock||DESCRIPTOR|
|CO_HOSTED_SITE_DOMAIN||Co-Hosted Site – Domain Name||ENTITY|
|CO_HOSTED_SITE_DOMAIN_WHOIS||Co-Hosted Site – Domain Whois||DATA|
|DARKNET_MENTION_URL||Darknet Mention URL||DESCRIPTOR|
|DARKNET_MENTION_CONTENT||Darknet Mention Web Content||DATA|
|DATE_HUMAN_DOB||Date of Birth||ENTITY|
|DEFACED_IPADDR||Defaced IP Address||DESCRIPTOR|
|DEFACED_COHOST||Defaced Co-Hosted Site||DESCRIPTOR|
|DEFACED_AFFILIATE_IPADDR||Defaced Affiliate IP Address||DESCRIPTOR|
|DESCRIPTION_CATEGORY||Description – Category||DESCRIPTOR|
|DESCRIPTION_ABSTRACT||Description – Abstract||DESCRIPTOR|
|DNS_TEXT||DNS TXT Record||DATA|
|DNS_SRV||DNS SRV Record||DATA|
|DNS_SPF||DNS SPF Record||DATA|
|DOMAIN_NAME_PARENT||Domain Name (Parent)||ENTITY|
|EMAILADDR_COMPROMISED||Hacked Email Address||DESCRIPTOR|
|HTTP_CODE||HTTP Status Code||DATA|
|INTERESTING_FILE_HISTORIC||Historic Interesting File||DESCRIPTOR|
|INTERNET_NAME_UNRESOLVED||Internet Name – Unresolved||ENTITY|
|LINKED_URL_INTERNAL||Linked URL – Internal||SUBENTITY|
|LINKED_URL_EXTERNAL||Linked URL – External||SUBENTITY|
|MALICIOUS_IPADDR||Malicious IP Address||DESCRIPTOR|
|MALICIOUS_COHOST||Malicious Co-Hosted Site||DESCRIPTOR|
|MALICIOUS_EMAILADDR||Malicious E-mail Address||DESCRIPTOR|
|MALICIOUS_INTERNET_NAME||Malicious Internet Name||DESCRIPTOR|
|MALICIOUS_AFFILIATE_IPADDR||Malicious Affiliate IP Address||DESCRIPTOR|
|MALICIOUS_NETBLOCK||Malicious IP on Owned Netblock||DESCRIPTOR|
|MALICIOUS_PHONE_NUMBER||Malicious Phone Number||DESCRIPTOR|
|MALICIOUS_SUBNET||Malicious IP on Same Subnet||DESCRIPTOR|
|LEAKSITE_URL||Leak Site URL||ENTITY|
|LEAKSITE_CONTENT||Leak Site Content||DATA|
|PGP_KEY||PGP Public Key||DATA|
|PROVIDER_DNS||Name Server (DNS NS Records)||ENTITY|
|PROVIDER_MAIL||Email Gateway (DNS MX Records)||ENTITY|
|PUBLIC_CODE_REPO||Public Code Repository||ENTITY|
|RAW_RIR_DATA||Raw Data from RIRs/APIs||DATA|
|RAW_DNS_RECORDS||Raw DNS Records||DATA|
|RAW_FILE_META_DATA||Raw File Meta Data||DATA|
|SEARCH_ENGINE_WEB_CONTENT||Search Engines Web Content||DATA|
|SOCIAL_MEDIA||Social Media Presence||ENTITY|
|SIMILARDOMAIN_WHOIS||Similar Domain – Whois||DATA|
|SSL_CERTIFICATE_RAW||SSL Certificate – Raw Data||DATA|
|SSL_CERTIFICATE_ISSUED||SSL Certificate – Issued to||ENTITY|
|SSL_CERTIFICATE_ISSUER||SSL Certificate – Issued by||ENTITY|
|SSL_CERTIFICATE_MISMATCH||SSL Certificate Host Mismatch||DESCRIPTOR|
|SSL_CERTIFICATE_EXPIRED||SSL Certificate Expired||DESCRIPTOR|
|SSL_CERTIFICATE_EXPIRING||SSL Certificate Expiring||DESCRIPTOR|
|TARGET_WEB_CONTENT_TYPE||Web Content Type||DESCRIPTOR|
|TCP_PORT_OPEN||Open TCP Port||SUBENTITY|
|TCP_PORT_OPEN_BANNER||Open TCP Port Banner||DATA|
|UDP_PORT_OPEN||Open UDP Port||SUBENTITY|
|UDP_PORT_OPEN_INFO||Open UDP Port Information||DATA|
|URL_ADBLOCKED_EXTERNAL||URL (AdBlocked External)||DESCRIPTOR|
|URL_ADBLOCKED_INTERNAL||URL (AdBlocked Internal)||DESCRIPTOR|
|URL_FLASH||URL (Uses Flash)||DESCRIPTOR|
|URL_WEB_FRAMEWORK||URL (Uses a Web Framework)||DESCRIPTOR|
|URL_JAVA_APPLET||URL (Uses Java Applet)||DESCRIPTOR|
|URL_STATIC||URL (Purely Static)||DESCRIPTOR|
|URL_PASSWORD||URL (Accepts Passwords)||DESCRIPTOR|
|URL_UPLOAD||URL (Accepts Uploads)||DESCRIPTOR|
|URL_FORM_HISTORIC||Historic URL (Form)||DESCRIPTOR|
|URL_FLASH_HISTORIC||Historic URL (Uses Flash)||DESCRIPTOR|
|URL_WEB_FRAMEWORK_HISTORIC||Historic URL (Uses a Web Framework)||DESCRIPTOR|
|URL_JAVA_APPLET_HISTORIC||Historic URL (Uses Java Applet)||DESCRIPTOR|
|URL_STATIC_HISTORIC||Historic URL (Purely Static)||DESCRIPTOR|
|URL_PASSWORD_HISTORIC||Historic URL (Accepts Passwords)||DESCRIPTOR|
|URL_UPLOAD_HISTORIC||Historic URL (Accepts Uploads)||DESCRIPTOR|
|VULNERABILITY||Vulnerability in Public Domain||DESCRIPTOR|
|WEBSERVER_STRANGEHEADER||Non-Standard HTTP Header||DATA|
|WIFI_ACCESS_POINT||WiFi Access Point Nearby||ENTITY|
|WIKIPEDIA_PAGE_EDIT||Wikipedia Page Edit||DESCRIPTOR|
Writing a Module
To write a SpiderFoot module, start by looking at the
sfp_template.py file which is a skeleton module that does nothing. Use the following steps as your guide:
- Create a copy of
sfp_template.pyto whatever your module will be named. Try and make this something descriptive, i.e. not something like
sfp_mymodule.pybut instead something like
sfp_imageanalyser.pyif you were creating a module to analyse image content.
- Replace XXX in the new module with the name of your module and update the descriptive information in the header and comment within the module.
- The comment for the class (check in
sfp_template.py) is used by SpiderFoot in the UI to correctly categorise modules, so make it something meaningful. Look at other modules for examples.
- Set the events in
producedEvents()accordingly, based on the data element table in the previous section. If you are producing a new data element not pre-existing in SpiderFoot, you must create this in the database:
~/spiderfoot$ sqlite3 spiderfoot.db sqlite> INSERT INTO tbl_event_types (event, event_descr, event_raw) VALUES ('NEW_DATA_ELEMENT_TYPE_NAME_HERE', 'Description of your New Data Element Here', 0, 'DESCRIPTOR or DATA or ENTITY or SUBENTITY');`
- Put the logic for the module in
handleEvent(). Each call to
handleEvent()is provided a
SpiderFootEventobject. The most important values within this object are:
eventType: The data element ID (
data: The actual data, e.g. the IP address or web server banner, etc.
module: The name of the module that produced the event (
- When it is time to generate your event, create an instance of
e = SpiderFootEvent("IP_ADDRESS", ipaddr, self.__name__, event)
- Note: the
eventpassed as the last variable is the event that your module received. This is what builds a relationship between data elements in the SpiderFoot database.
- Notify all modules that may be interested in the event:
All SpiderFoot data is stored in a SQLite database (
spiderfoot.db in your SpiderFoot installation folder) which can be used outside of SpiderFoot for analysis of your data.
The schema is quite simple and can be viewed in the GitHub repo.
The below queries might provide some further clues:
# Total number of scans in the SpiderFoot database sqlite> select count(*) from tbl_scan_instance; 10
# Obtain the ID for a particular scan sqlite> select guid from tbl_scan_instance where seed_target = 'binarypool.com'; b459e339523b8d06235bd06087ae6c6017aaf4ed68dccea0b65a1999a17e460a