Skip to content
This repository has been archived by the owner on Nov 25, 2022. It is now read-only.

Commit

Permalink
First Release
Browse files Browse the repository at this point in the history
  • Loading branch information
tarunKoyalwar committed Feb 4, 2022
0 parents commit 913aa09
Show file tree
Hide file tree
Showing 44 changed files with 4,950 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2022, Tarun Koyalwar
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
138 changes: 138 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<h1 align="center">
<img src="assets/Icon.png" alt="Sandman" width="200px"></a>
<br>
</h1>

<p align="center">
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-BSD-_red.svg"></a>
<a href="https://goreportcard.com/badge/github.com/tarunKoyalwar/sandman"><img src="https://goreportcard.com/badge/github.com/tarunKoyalwar/sandman"></a>
<a href="https://github.com/tarunKoyalwar/sandman/releases"><img src="https://img.shields.io/github/release/tarunKoyalwar/sandman"></a>
<a href="https://twitter.com/KoyalwarTarun"><img src="https://img.shields.io/twitter/follow/KoyalwarTarun.svg?logo=twitter"></a>

<p align="center">
<a href="#screenshots">Screenshots</a>
<a href="#features">Features</a> •
<a href="#installation-instructions">Installation</a> •
<a href="#usage">Usage</a> •
<a href="#upcoming">Features</a> •
<a href="#-notes">Notes</a> •
</p>

# Sandman
A Target Tracking , NoteTaking , CheckLists and Data Management GUI App for Bug Hunter's and Pentesters. It is designed to Track Progress , Store and Retrieve tools data , CheckLists per domain and much more (future releases). It is designed while keeping in mind the ease and requirements while working on a program.It also has an integrated web server which can be used to get and post data to its respective pages.

This Cross Platform Native App is Powered By
- [Fyne](https://github.com/fyne-io/fyne)
- MongoDB
- gorilla/mux

To Know More About the Functionalities , Usage and Structure Do refer the project wiki.

This App Also has an awesome cmd client app [Matthew](https://github.com/tarunKoyalwar/matthew) to store and retrieve data to UI App. It can be
seamlessly integrated with your bash scripts / tools . It is similar to Linux Command `tee`

```sh
asserfinder abc.com | matthew web -s abc.com -t assetfinder --post
```

This will continuously post tool output to its appropriate destination in checklist in chunks .We can also get data from UI App (Ex : all-urls ,all-subs etc). To know more visit Matthew




# Screenshots

<h1 align="center">
<img src="screenshots/activesubs.png" alt="Active Subdomains" width="500px"></a>
<br>
</h1>

<h1 align="center">
<img src="screenshots/orgchecklist.png" alt="Active Subdomains" width="700px"></a>
<br>
</h1>

<h1 align="center">
<img src="screenshots/webchecklist.png" alt="Active Subdomains" width="700px"></a>
<br>
</h1>

For More Refer to screenshots/

# Features

- CheckList For Each Domain With Progress Tracking.
- Integrated HTTP Server to Store and Retrieve Data.
- Consists of Multiple Pages (In Scope, All Subs , Active Urls etc).
- Cred Page For Storing Credentials.
- Store and Retrieve Tool Output of Each CheckList Item for each domain and project.
- Personal Notes / Findings for each Project.
- Pagination For Storing Large Content.

Refer [Upcoming](#upcoming) for Planned and Upcoming Content.

# Installation Instructions

Download Binaries From Releases

## Build From Source

- Install Go
- Make Sure $GOPATH/bin is added to PATH env Variable

```sh
go install github.com/tarunKoyalwar/sandman@latest
```

Windows and Mac Users. If you face any problems while building visit [fyne](https://github.com/fyne-io/fyne) .


# Usage

Open App Using Terminal To View App Logs

```sh
sandman
```

When Installed From Releases . Open App Using Application Menu.


# Upcoming

This is First Release Lot of Planned Content Has Not been Implemented Yet. The Most Important of them Include Following.


- [ ] Editable MarkDown Support
- [ ] Automation
- [ ] Script Engine
- [ ] Checkpoints
- [ ] Multiprocessing
- [ ] Scheduling
- [ ] Regex , Pre and Post Processing
- [ ] Resource Control
- [ ] [Notify](https://github.com/projectdiscovery/notify) Support
- [ ] Browser Extensions
- [ ] Android App ( UI redesing Left )
- [ ] IOS App
- [ ] Docker + Fyne Terminal


## UI Development

This Project Only Intends to Use Fyne For UI. Since Fyne Is Not A Full Framework Yet . Multimedia Support , Drag and Drop and Other Advanced UI Features Cannot be Implemented Yet.

New UI Features Wil Follow within a Month or Two of Fyne Release.

As For the Theme and Styling Fyne is Currently Focusing on Core Components. To Style any components we have to create Custom Widgets Which Takes Lot of Time .So I don't Intend to Change Any Styling unless it is essential .


If Anyone is Familiar With Fyne and want to contribute DM me on twitter or Create a issue.


# Acknowledgement

Logo Obtained From
<a href="https://www.vecteezy.com/free-vector/letter-s-logo">Letter S Logo Vectors by Vecteezy</a>

Thanks Fyne Team For Awesome Framework.
Binary file added assets/Icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions assets/font_gen.go

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions assets/logo.go

Large diffs are not rendered by default.

123 changes: 123 additions & 0 deletions assets/theme_gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 913aa09

Please sign in to comment.