Amazon S3 bucket finder.
Project description
s3recon
Amazon S3 bucket finder and crawler.
Installation
NOTE: s3recon requires python version >=3.6
$ pip install s3recon
Usage
usage: s3recon [-h] [-o file] [-d] [-p] [-t seconds] [-v] [-c num] word_list [word_list ...]
positional arguments:
word_list read words from one or more <word-list> files
optional arguments:
-h, --help show this help message and exit
-o file, --output file write output to <file>
-d, --db write output to database
-p, --public only include 'public' buckets in the output
-t seconds, --timeout seconds http request timeout in <seconds> (default: 30)
-v, --version show program's version number and exit
-c num, --concurrency num maximum <num> of concurrent requests (default: # of lcpus)
Example 1: Output to a json file
1. Download a word-list.
The SecLists repository has a multitude of word-lists to choose from. For this example, let's download the sample word-list included in this repository.
$ curl -sSfL -o "word-list.txt" "https://raw.githubusercontent.com/clarketm/s3recon/master/data/words.txt"
2. Run s3recon
.
Execute s3recon
using the word-list.txt
file and output the public
S3 buckets to a json file named results.json
.
$ s3recon "word-list.txt" -o "results.json" --public
- PRIVATE https://s3.sa-east-1.amazonaws.com/test-lyft
- PRIVATE https://s3.ap-south-1.amazonaws.com/test.amazon
+ PUBLIC https://walmart-dev.s3.us-east-1.amazonaws.com
- PRIVATE https://s3.ap-southeast-1.amazonaws.com/apple-prod
- PRIVATE https://walmart.s3.ap-southeast-1.amazonaws.com
...
3. Inspect the results.
Check the results.json
output file to view the S3 buckets you have discovered!
$ cat "results.json"
{
"public": {
"total": 12,
"hits": [
"https://walmart-dev.s3.us-east-1.amazonaws.com",
"https://apple-production.s3.ap-southeast-1.amazonaws.com",
...
]
}
}
Note: to include
private
buckets in the results omit the-p, --public
flag from the command.
4. Crawl the results.
Enumerate the static files located in each bucket and record the findings.
Coming soon!
Example 2: Output to a MongoDB database
1. Download a word-list.
The SecLists repository has a multitude of word-lists to choose from. For this example, let's download the sample word-list included in this repository.
$ curl -sSfL -o "word-list.txt" "https://raw.githubusercontent.com/clarketm/s3recon/master/data/words.txt"
2. Start an instance of MongoDB
$ docker run --name "mongo" -p 27017:27017 -v "mongodb_data:/data/db" -v "mongodb_config:/data/configdb" -d mongo
3. Run s3recon
.
Execute s3recon
using the word-list.txt
file and output to MongoDB instance.
$ s3recon "word-list.txt" --db
- PRIVATE https://s3.sa-east-1.amazonaws.com/test-lyft
- PRIVATE https://s3.ap-south-1.amazonaws.com/test.amazon
+ PUBLIC https://walmart-dev.s3.us-east-1.amazonaws.com
- PRIVATE https://s3.ap-southeast-1.amazonaws.com/apple-prod
- PRIVATE https://walmart.s3.ap-southeast-1.amazonaws.com
...
3. Inspect the results.
Check the MongoDB database: s3recon
collection: hits
to view the S3 buckets you have discovered!
$ mongo "s3recon" --quiet --eval 'db.hits.find({}, {"url": 1, "access": 1, "_id": 0}).limit(5)'
{ "url" : "https://s3.us-east-2.amazonaws.com/apple", "access" : "private" }
{ "url" : "https://s3.us-west-1.amazonaws.com/microsoft-dev", "access" : "private" }
{ "url" : "https://s3.us-west-1.amazonaws.com/dev-microsoft", "access" : "private" }
{ "url" : "https://s3.us-east-2.amazonaws.com/amazon", "access" : "private" }
{ "url" : "https://s3.us-east-1.amazonaws.com/dev-amazon", "access" : "private" }
4. Crawl the results.
Enumerate the static files located in each bucket and record the findings.
Coming soon!
FAQ
Q: How do I configure this utility?
A:
s3recon
can be configure using a yaml configuration file located in either the current working directory (e.g. ./s3recon.yml
) or your home diretory (e.g. ~/s3recon.yml
).
The following is the list of configurable values:
# s3recon.yml
database: { host: "0.0.0.0", ... }
separators: ["-", "_", "."]
environments: ["", "backup", "backups", ...]
regions: ["ap-northeast-1", "ap-northeast-2", ...]
To see the full list of configurable values (and their defaults) please refer to the s3recon.yml file in this repository.
Q: How do I customize the AWS regions used in the recon?
A:
The AWS regions can be altered by setting the regions
array in your s3recon.yml
configuration file.
# s3recon.yml
regions: [ "us-west-2", ...]
Q: How do I customize the environment values used in the recon?
A:
The environments are modifiers permuted with each item of the word-list (and the separator) to construct the bucket value in request.
The value can be altered by setting the environments
array in your s3recon.yml
configuration file.
For example, to only search lines from the word-list verbatim (i.e. without modification) you can set this value to an empty array.
# s3recon.yml
environments: []
Q: How do I customize the MongoDB host and port?
A:
The database host and port can be configured by altering the database
map in your s3recon.yml
configuration file.
For example, host
and port
can be set directly inside the database
map
# s3recon.yml
database: {
host: "0.0.0.0",
port: 27017
}
Q: How do I use a database other than MongoDB?
A:
Sorry, at the moment only MongoDB is supported.
Going Forward
- Create
crawl
command to crawl public/private buckets found infind
stage. - Separate out
find
andcrawl
as subcommands. - Store discovered buckets in a NoSQL database.
Disclaimer
This tools is distributed for educational and security purposes. I take no responsibility and assume no liability for the manner in which this tool is used.
License
MIT © Travis Clarke
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file s3recon-1.4.0.tar.gz
.
File metadata
- Download URL: s3recon-1.4.0.tar.gz
- Upload date:
- Size: 11.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 289d9d0232c9720b330a1d7a330852ec8b752e79fedc398b78c3a277b070953e |
|
MD5 | 9fc9bba43cb71e6f4faffe6b64582189 |
|
BLAKE2b-256 | 2b9e1c5bfe3a8d579c5c133c3293857d4b80698d8189873d97d662b02ec4d797 |
File details
Details for the file s3recon-1.4.0-py3-none-any.whl
.
File metadata
- Download URL: s3recon-1.4.0-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52549558ff7cbab6ea744adac39291cb589b2ce6e567e63546b6d984f098b46e |
|
MD5 | 2a1106ddbb2fa0eee56c4275416d5831 |
|
BLAKE2b-256 | e180b54790a463ff6fca30360017ac8c72f80c3a2f6542c7bbd1d2cafc105217 |