Skip to content

Commit

Permalink
chore: Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
enenumxela committed May 26, 2021
0 parents commit 30491ae
Show file tree
Hide file tree
Showing 13 changed files with 559 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
custom: ['https://www.buymeacoffee.com/enenumxela']
26 changes: 26 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: build

on:
push:
branches:
- main

jobs:
build:
name: build
runs-on: ubuntu-latest
steps:
-
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14

-
name: Check out code
uses: actions/checkout@v2

-
name: Build
run: go build -v .
working-directory: cmd/sigs3scann3r/
42 changes: 42 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@

name: release

on:
create:
tags:
- v*

jobs:
release:
name: release
runs-on: ubuntu-latest
steps:
-
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14

-
name: "Check out code"
uses: actions/checkout@v2
with:
fetch-depth: 0

-
name: Get dependencies
run: |
go get -v -t -d ./...
if [ -f Gopkg.toml ]; then
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
dep ensure
fi
-
name: "Create release on GitHub"
uses: goreleaser/goreleaser-action@v2
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
args: "release --rm-dist"
version: latest
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Excutables

cmd/sigs3scann3r/sigs3scann3r

# Notes

notes.txt
24 changes: 24 additions & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
builds:
-
binary: sigs3scann3r
main: cmd/sigs3scann3r/main.go
goos:
- linux
- windows
- darwin
goarch:
- amd64
- 386
- arm
- arm64

archives:
-
id: tgz
format: tar.gz
replacements:
darwin: macOS
format_overrides:
-
goos: windows
format: zip
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2020 Signed Security

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# sigs3scann3r

[![release](https://img.shields.io/github/release/signedsecurity/sigs3scann3r?style=flat&color=0040ff)](https://github.com/signedsecurity/sigs3scann3r/releases) ![maintenance](https://img.shields.io/badge/maintained%3F-yes-0040ff.svg) [![open issues](https://img.shields.io/github/issues-raw/signedsecurity/sigs3scann3r.svg?style=flat&color=0040ff)](https://github.com/signedsecurity/sigs3scann3r/issues?q=is:issue+is:open) [![closed issues](https://img.shields.io/github/issues-closed-raw/signedsecurity/sigs3scann3r.svg?style=flat&color=0040ff)](https://github.com/signedsecurity/sigs3scann3r/issues?q=is:issue+is:closed) [![license](https://img.shields.io/badge/license-MIT-gray.svg?colorB=0040FF)](https://github.com/signedsecurity/sigs3scann3r/blob/master/LICENSE) [![twitter](https://img.shields.io/badge/twitter-@signedsecurity-0040ff.svg)](https://twitter.com/signedsecurity)

sigs3scann3r is tool to scan AWS S3 bucket permissions and dump bucket contents where applicable.

## Resources

* [Usage](#usage)
* [Installation](#installation)
* [From Binary](#from-binary)
* [From source](#from-source)
* [From github](#from-github)
* [Contribution](#contribution)

## Usage

To display help message for sigs3scann3r use the `-h` flag:

```
$ sigs3scann3r -h
_ _____ _____
___(_) __ _ ___|___ / ___ ___ __ _ _ __ _ __ |___ / _ __
/ __| |/ _` / __| |_ \/ __|/ __/ _` | '_ \| '_ \ |_ \| '__|
\__ \ | (_| \__ \___) \__ \ (_| (_| | | | | | | |___) | |
|___/_|\__, |___/____/|___/\___\__,_|_| |_|_| |_|____/|_| v1.1.1
|___/
USAGE:
sigs3scann3r [OPTIONS]
OPTIONS:
-dump dump found open buckets locally (default: false)
-iL input buckets list (use `iL -` to read from stdin)
-nC no color mode (default: false)
-o buckets dump directory (default: ./buckets)
-v verbose mode
```

sigs3scann3r takes buckets in the format:
* name - e.g. `flaws.cloud`
* path style - e.g `https://s3.amazonaws.com/flaws.cloud`
* virtual hosted style - e.g `flaws.cloud.s3.amazonaws.com`

## Installation

#### From Binary

You can download the pre-built binary for your platform from this repository's [releases](https://github.com/signedsecurity/sigs3scann3r/releases/) page, extract, then move it to your `$PATH`and you're ready to go.

#### From Source

sigs3scann3r requires **go1.14+** to install successfully. Run the following command to get the repo

```bash
▶ GO111MODULE=on go get -u -v github.com/signedsecurity/sigs3scann3r/cmd/sigs3scann3r
```

#### From Github

```bash
▶ git clone https://github.com/signedsecurity/sigs3scann3r.git
cd sigs3scann3r/cmd/sigs3scann3r/
▶ go build .
▶ mv sigs3scann3r /usr/local/bin/
▶ sigs3scann3r -h
```

## Contribution

[Issues](https://github.com/signedsecurity/sigs3scann3r/issues) and [Pull Requests](https://github.com/signedsecurity/sigs3scann3r/pulls) are welcome!

0 comments on commit 30491ae

Please sign in to comment.