Skip to content

sam-aldis/securetea

Repository files navigation


SecureTea
OWASP SecureTea

One stop security solution for your device

FeaturesInstallationQuick StartProject LeadersContributorsUser GuideDeveloper Guide

Build Status Codacy Badge PyPI GitHub Telegram Version Tag GitHub issues GitHub pull requests GSOC 2019 Follow Us All Contributors Heroku

The OWASP SecureTea Project provides a one-stop security solution for various devices (personal computers / servers / IoT devices).

Dashboard

Features

Installation

Setup Intro

Before installing, please make sure to install the pre-requisites.

You can install SecureTea from PyPi package manager using the following command:

$ sudo python3 -m pip install securetea

or

You can install SecureTea using the latest repository:

$ git clone https://github.com/OWASP/SecureTea-Project.git
$ cd SecureTea-Project/
$ sudo python3 -m pip install -r requirements.txt
$ sudo python3 setup.py install

Please make sure all dependencies are installed if anyone of the above fails.

For more detailed information, refer to the installation guide.

Quick Start

  1. Start SecureTea in server mode:
    $ sudo SecureTea.py --server-mode

  2. Start SecureTea in system mode:
    $ sudo SecureTea.py --system-mode

  3. Start SecureTea in IoT mode:
    $ sudo SecureTea.py --iot-mode

For more detailed information, refer to the usage guide.

Quick Start Developer

This image contains VSCode server to develop directly within the container

From the ukjp repo:

  1. $ docker pull ukjpco/securetea:dev
  2. $ docker run -d --name securetea -P ukjpco/securetea:dev

From this repo:

  1. $ git pull https://github.com/OWASP/SecureTea-Project/ securetea
  2. $ cd securetea
  3. $ docker build . --tag securetea:latest
  4. $ docker run -d --name securetea -P securetea:latest

Developing in the container

Run $ docker ps to see which port the container is exposing for development its recommended to have a firewall rule blocking external or unauthorized access to this.

Project Leaders

Chat Group Google Summer of Code YouTube

Contributors

Thanks goes to these wonderful people (emoji key):

Abhishek Sharma
Abhishek Sharma

💻 📖
Rejah Rehim
Rejah Rehim

💻 📖
adeyosemanputra
adeyosemanputra

💻 📖
Ananthu S
Ananthu S

💻
Sunny Dhoke
Sunny Dhoke

🐛 📖
MajAK
MajAK

💻
Mishal Shah
Mishal Shah

💻
Samuel Aldis
Samuel Aldis

💻

This project follows the all-contributors specification. Contributions of any kind welcome!