-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
127 changed files
with
5,530 additions
and
4,103 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -159,6 +159,7 @@ vendor | |
*.deb | ||
.vagrant* | ||
*.box | ||
paradrop-agent | ||
|
||
# macOS Specific | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,63 +1,106 @@ | ||
<p align="center"> | ||
<img width="214" height="42" src="./ui/static/assets/logo-red.png"> | ||
<img width="214" height="42" src="./ui/static/assets/logo-red.png" alt="paradrop"> | ||
</p> | ||
|
||
<h3 align="center">Simple, Easy Infrastructure Scanning</h3> | ||
<h2 align="center">Cybersecurity Asset Management</h2> | ||
|
||
--- | ||
[![Demo][demo_url_img]][demo_url] | ||
[![Admin Docs][admin_doc_img]][admin_doc_url] | ||
[![API Docs][api_doc_img]][api_doc_url] | ||
[![License][repo_license_img]][repo_license_url] | ||
|
||
## Provision Elasticsearch and Kibana Docker Containers With Seed Data | ||
paradrop is an open source, cybersecurity asset management tool that collects operating system information, including configurations, security settings, resource metrics, and installed and running software. The paradrop UI provides accessible, searchable, and filterable views on the data the paradrop agent collects from supported platforms. Our end goal is to build an easily customizable solution that provides methods to automate United States Government challenges around System Security Plans (SSP), Authorization to Operate (ATO), and Software Bill of Materials (SBOMs). | ||
|
||
From your local terminal in the paradrop directory: | ||
## ⚡️ Quick start | ||
|
||
```sh | ||
cd elk | ||
sudo ./seed.sh | ||
> 🐳 **Docker Compose** Method | ||
> First install NodeJS 18.x, Make, cURL and Docker | ||
```bash | ||
make local | ||
``` | ||
|
||
## Access Elasticsearch and Kibana | ||
> 🖥️ **Vagrant** Method | ||
Kibana - open your browser to <http://localhost:5601/> | ||
```bash | ||
vagrant up | ||
``` | ||
|
||
Username: `admin` | ||
Go to https://localhost:8443/ui/ | ||
|
||
Password: `dtYe2cKY2YtyBEJ49a` | ||
## 📖 Docs | ||
|
||
The same username and password is used to access Elasticsearch. | ||
**Main Docs**: https://demo.paradrop.io/docs | ||
|
||
Example GET request: | ||
**Swagger API Docs**: https://demo.paradrop.io/apidocs/ | ||
|
||
```sh | ||
curl -k -u 'admin:dtYe2cKY2YtyBEJ49a' -H 'Content-Type: application/json' 'https://localhost:9200/' | ||
``` | ||
## ⚙️ Development | ||
|
||
## Lint Code | ||
### `Opensearch` | ||
Elasticsearch compatible database also works | ||
|
||
From your local terminal in the paradrop directory: | ||
> 🔔 Requires cURL, Make and Docker | ||
```sh | ||
./lint.sh | ||
```bash | ||
make elk | ||
``` | ||
|
||
## Build API Docker Container | ||
### `api` | ||
Python Flask API | ||
|
||
From your local terminal in the paradrop directory: | ||
> 🔔 Requires Python >=3.10. | ||
```sh | ||
sudo ./start.sh | ||
```bash | ||
make api | ||
``` | ||
|
||
## Build UI Docker Container | ||
### `ui` | ||
Bootstrap 5 & CoreUI Static HTML/CSS/JS | ||
|
||
> 🔔 Requires Python 3.x or serve static assets from build UI directory. | ||
```bash | ||
make ui | ||
``` | ||
|
||
From your local terminal in the paradrop directory: | ||
### `agent` | ||
Golang Agent (Windows/Linux/Darwin/amd64/arm64 supported) | ||
> 🔔 Requires Go >=1.22 | ||
```sh | ||
cd ui | ||
sudo ./start.sh | ||
```bash | ||
cd agent | ||
make | ||
``` | ||
|
||
## Default Username and Password In paradrop_users Index | ||
|
||
Username/Email: `admin@paradrop.io` | ||
## 🚧 Project Status | ||
|
||
The paradrop tool is early in development, and we're still building more documentation to help you deploy across different architectures, accelerate iterating on changes, and enhance security controls this year. | ||
|
||
We hope you star this project, engage with us, and check back when you can for further updates coming soon. | ||
|
||
|
||
## ⚠️ License | ||
|
||
[`paradrop`][repo_url] is free and open source software licensed under | ||
the [GNU General Public License v3.0][repo_license_url] | ||
|
||
|
||
<!-- Links --> | ||
[admin_doc_url]: https://demo.paradrop.io/docs | ||
|
||
[repo_license_url]: https://github.com/Metrostar/paradrop/blob/main/COPYING | ||
|
||
[repo_url]: https://github.com/MetroStar/paradrop | ||
|
||
[repo_license_img]: https://img.shields.io/badge/license-GPLv3-purple?style=for-the-badge&logo=none | ||
|
||
[admin_doc_img]: https://img.shields.io/badge/admin_docs-click_here-blue?style=for-the-badge&logo=none | ||
|
||
[api_doc_img]: https://img.shields.io/badge/api_docs-click_here-pink?style=for-the-badge&logo=none | ||
|
||
[api_doc_url]: https://demo.paradrop.io/apidocs/ | ||
|
||
[demo_url]: https://demo.paradrop.io/ui/login/ | ||
|
||
Password: `Paradrop789!` | ||
[demo_url_img]: https://img.shields.io/badge/demo-click_here-red?style=for-the-badge&logo=none |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.