The disclose.io security.txt scraper (diosts
) takes a list of domains as the input, retrieves and validates the security.txt
if available and outputs it in the disclose.io JSON format.
Prerequisites: a working Golang installation >= 1.13
go get github.com/disclose/diosts/cmd/diosts
cat domains.txt | ~/go/bin/diosts -t <threads> -n <non-compliant-output> 2>diosts.log >securitytxt.json
This will try and scrape the security.txt
from the domains listed in domains.txt
, with <threads>
parallel threads (defaults to 8). Logging (with information on each of the domains in the input) will be written to diosts.log
(because it's output to stderr
) and a JSON array of retrieved security.txt
information in disclose.io format will be written to securitytxt.json
.
The -n
or --non-compliant
flag enables you to output the non-RFC-compliant security.txt files to a separate JSON file for further analysis and processing.
For each input, the following URIs are tried, in order:
https://<domain>/.well-known/security.txt
https://<domain>/security.txt
http://<domain>/.well-known/security.txt
http://<domain>/security.txt
Any non-fatal violations of the security.txt
specification will be logged and tracked in the output.
The tool now fully supports RFC 9116 compliance checking and will report:
- Whether a security.txt file is RFC compliant
- Specific compliance issues found
- Expires date checking (required field per RFC 9116)
- Field validation according to the standard
Note: building is not necessary if you use the installation instructions, Go will take care of this for you.
git clone https://github.com/disclose/diosts
cd diosts
go build ./cmd/diosts
According to the specifications, a redirect should be followed when retrieving security.txt
. However:
When retrieving the file and any resources referenced in the file, researchers should record any redirects since they can lead to a different domain or IP address controlled by an attacker. Further inspections of such redirects is recommended before using the information contained within the file.
At this point, we blindly accept redirects within the same organization (e.g., google.com to www.google.com is accepted). Any other redirect is logged as an error, to be dealt with later.
A security.txt
should contain a Canonical
field with a URL pointing to the canonical version of the security.txt
. We should check if we retrieved the security.txt
from the canonical URL and if not, do so.
Currently, we use the input domain name as program name. This might or might not be correct, especially with redirects and canonical URL entries. To be discussed later.