This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org

Difference between revisions of "OWASP SecureTea Project"

From OWASP
Jump to: navigation, search
(Project Resources)
 
(75 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 
| valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |
 
| valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |
==OWASP SecureTea Tool Project ==
 
The OWASP SecureTea Project is a application designed to help Secure a person's laptop or computer with IoT (Internet Of Things) for notify users via [https://twitter.com twitter], whenever anyone accessing his laptop or computer. This application work using the touchpad / mouse / wireless mouse and developed in [https://www.python.org/ python].
 
  
The purpose of this application is to warn the user (on twitter) whenever her laptop accessible. This small application was developed and tested in python in linux machine ([https://tealinuxos.org/ TeaLinuxOS]) likely to be working well in the Raspberry Pi as well.
+
== Maintenance notice ==
  
==Description==
+
This site is no longer maintained: please go to https://www2.owasp.org/www-project-securetea/ for our new website!
The OWASP SecureTea Project that was developed to be used by anyone who is interested in Security IOT (Internet of Things) and still needs further development.
 
  
How it functions:
+
==OWASP SecureTea Tool Project ==
* Keep track of the movement of the mouse / touchpad
+
The OWASP SecureTea Project is an application designed to help secure a person's laptop or computer / server with IoT (Internet Of Things) and notify users (via various communication mechanisms), whenever someone accesses their computer / server. This application uses the touchpad/mouse/wireless mouse to determine activity and is developed in Python and tested on various machines (Linux, Mac & Windows).
* Detect who access the laptop with mouse / touchpad is installed
+
The software is still under development, and will eventually have it's own IDS(Intrusion Detection System) / IPS(Instrusion Prevention System), firewall, anti-virus, intelligent log monitoring capabilities with web defacement detection, and support for much more communication medium.
* Send warning messages on Twitter
 
  
== Objective ==
 
To alert the user via twitter, whenever her laptop had been accessed someone.
 
  
== Pre-requisites ==
+
==User Guide==
I. HARDWARE :
+
https://github.com/OWASP/SecureTea-Project/blob/master/doc/en-US/user_guide.md
* Linux OS / Raspberry Pi - have sudo access on the terminal / console
 
* Mouse / Wireless Mouse / Touchpad congenital laptop
 
* Mobile phones are already installed Twitter application (Optional)
 
II. SOFTWARE :
 
* Python - <nowiki>https://www.python.org/</nowiki> (<code>sudo apt-get install python</code>)
 
* Twitter Python Package - <nowiki>https://pypi.python.org/pypi/twitter</nowiki> (already present in the repo: <code>twitter-1.17.1</code>)
 
* The Twitter account - <nowiki>https://twitter.com</nowiki>
 
* Mobile phones are already installed Twitter application (Optional)
 
  
== Procedure ==
+
==Developer Guide==
# Python must be installed. (If not already installed: <code>sudo apt-get install python</code>)
+
https://github.com/OWASP/SecureTea-Project/blob/master/doc/en-US/dev_guide.md
# Install twitter package of this repo:
+
 
* <code>cd SecureTea / twitter-1.17.1 /</code>
+
==Demo==
* <code>sudo python setup.py build install</code>
+
You can see what SecureTea Project is all about in the following video:
# Visit <nowiki>https://apps.twitter.com</nowiki> and "Create new app" to obtain authentication and token codes.
+
OWASP SecureTea Notify to telegram: {{#ev:youtube|zJegAtJOOc8}}
# Open the "SecureTea.py" with a text editor and edit the following variables:
+
OWASP SecureTea Notify to twilio/sms: {{#ev:youtube|bYuq73KN9E8}}
* API_KEY = 'XXXX'
 
* API_SECRET = 'XXXX'
 
* ACCESS_TOKEN = 'XXXX'
 
* ACCESS_TOKEN_SECRET = 'XXXX'
 
* TWITTER_USERNAME = 'XXXX'
 
# Optionally in "SecureTea.py" You can set debug = <code>1</code> to enable the console log (default: enabled). or <code>set debug = 0</code>without logging in console.
 
# Install Mouse / Wireless Mouse Touchpad if not functioning properly (Linux / Raspberry machine).
 
# Okay, Run program -> <code>sudo python SecureTea.py</code>
 
# Notice his WELCOME_MSG Like this: <code>Welcome to SecureTea .. !! Initializing System @ Mon Mar 20 17:06:28 2017</code>
 
# laptop access by moving the mouse / touchpad to see the cumulative X and Y coordinates on the console. If you have a twitter app installed on your phone, you can get updates on the "message" from your twitter account.
 
# Checks Alert message on the console and on twitter your inbox. <code>Alert (1): Someone has access your laptop when Mon Mar 20 17:04:13 2017</code>
 
  
 
==Licensing==
 
==Licensing==
GNU GPL v3 License
+
OWASP SecureTea Tool is free to use. It is licensed under the MIT license.
 +
| valign="top" style="padding-left:25px;width:200px;" |
  
This program is free software: you can redistribute it and/or modify it under the terms of the [http://www.gnu.org/licenses/agpl-3.0.html link GNU Affero General Public License 3.0] as published by the Free Software Foundation, either version 3 of the License. 
+
== News and Events ==
 +
* [20 Mar 2017] V1.0 Beta Release candidate is available for download. First release for trial period.
 +
* [04 Feb 2018] V1.0 Release Candidate is available for download. This release provides final bug fixes and product stabilization. Any feedback (good or bad) in the next few weeks would be greatly appreciated.
 +
* [25 Jan 2018] Published in ToolsWatch.org, [http://www.toolswatch.org/2018/01/black-hat-arsenal-asia-2018-great-lineup/ Blackhat Arsenal Asia 2018 Great Lineup.]
  
 +
* [22 Mar 2018] [https://www.blackhat.com/asia-18/arsenal/schedule/index.html#owasp-securetea-tool-project-9669 Present at Blackhat Asia Singapore.]
 +
* [10-12 July 2018] [http://2018.twcsa.org/speakers.html#spkr_0711_owasp_04 Present at OWASP AppSec Taiwan 2018]<br>
 +
* [30 Mei 2018]  Present at [https://owaspsendai.connpass.com/event/88720/ OWASP Sendai Chapter Meeting]
 +
* [24 April 2019] V1.1 Stable Release is available for [https://github.com/OWASP/SecureTea-Project/releases/tag/V1.1 download].
 
| valign="top" style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
 
| valign="top" style="padding-left:25px;width:200px;border-right: 1px dotted gray;padding-right:25px;" |
  
 
== Project Resources ==
 
== Project Resources ==
[https://github.com/idbmb/SecureTea/blob/master/README.md Installation Package]
+
[https://github.com/OWASP/SecureTea-Project/blob/master/README.md Installation Package]
  
[https://github.com/idbmb/SecureTea Source Code]
+
[https://github.com/OWASP/SecureTea-Project Source Code]
  
What's New (Revision History)
+
[https://github.com/OWASP/SecureTea-Project/wiki Wiki Home Page]
  
Documentation
+
[https://github.com/OWASP/SecureTea-Project/issues Issue Tracker]<br>
 +
Presentation ([[Media:OWASPSecuretea2017.pdf|Old PDF-2017]])
  
[https://github.com/idbmb/SecureTea/wiki Wiki Home Page]
+
== Project Leader ==
 
+
* [[Ade Yoseman Putra]]
[https://github.com/idbmb/SecureTea/issues Issue Tracker]
+
* [[User:Rejah Rehim.A.A|Rejah Rehim.A.A]]
 +
* [[User:Idbmb|Bambang Rahmadi K.P]]
  
Slide Presentation
+
== Video Creator ==
 +
* [[Sunny Dhoke]]
  
Video (Coming Soon)
+
== Contributors==
 +
* [https://github.com/sananthu Ananthu S]
  
== Project Leader ==
 
Project leader's name
 
  
[[User:Idbmb|Bambang Rahmadi Kurniawan Payu]]
+
== Open Hub ==
 +
https://www.openhub.net/p/734848
  
[[OWASP Jakarta Chapter]]
+
== Related Projects ==
  
== Related Projects ==
+
* [[OWASP Cyber Defense Matrix]]
<span style="color:#ff0000">
 
This is where you can link to other OWASP Projects that are similar to yours.
 
</span>
 
* [[OWASP_Code_Project_Template]]
 
* [[OWASP_Documentation_Project_Template]]
 
  
 
==Classifications==
 
==Classifications==
Line 100: Line 81:
 
   | align="center" valign="top" width="50%" | [[File:Owasp-defenders-small.png|link=Defenders]]
 
   | align="center" valign="top" width="50%" | [[File:Owasp-defenders-small.png|link=Defenders]]
 
   |-
 
   |-
   | colspan="2" align="center" | [[File:Agplv3-155x51.png|link=http://www.gnu.org/licenses/agpl-3.0.html|Affero General Public License 3.0]]
+
   | colspan="2" align="center" |  
 
   |}
 
   |}
 
| valign="top" style="padding-left:25px;width:200px;" |
 
 
== News and Events ==
 
<span style="color:#ff0000">
 
This is where you can provide project updates, links to any events like conference presentations, Project Leader interviews, case studies on successful project implementations, and articles written about your project.
 
</span>
 
* [12 Feb 2013] Support for Spanish is now available with this release.
 
* [11 Jan 2014] The 1.0 stable version has been released! Thanks everyone for your feedback and code fixes that made this happen!
 
* [18 Dec 2013] 1.0 Release Candidate is available for download.  This release provides final bug fixes and product stabilization.  Any feedback (good or bad) in the next few weeks would be greatly appreciated.
 
* [20 Nov 2013] 1.0 Beta 2 Release is available for download. This release offers several bug fixes, a few performance improvements, and addressed all outstanding issues from a security audit of the code.
 
* [30 Sep 2013] 1.0 Beta 1 Release is available for download.  This release offers the first version with all of the functionality for a minimum viable product.   
 
 
 
|}
 
|}
  
 
=FAQs=
 
=FAQs=
  
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->==How can I participate in your project?==
<span style="color:#ff0000">
 
Many projects have "Frequently Asked Questions" documents or pages. However, the point of such a document is not the questions. ''The point of a document like this are the '''answers'''''. The document contains the answers that people would otherwise find themselves giving over and over again. The idea is that rather than laboriously compose and post the same answers repeatedly, people can refer to this page with pre-prepared answers. Use this space to communicate your projects 'Frequent Answers.'
 
</span>
 
 
 
==How can I participate in your project?==
 
 
All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.  
 
All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.  
  
Line 133: Line 96:
 
==Contributors==
 
==Contributors==
  
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->'''Everyone is invited to collaborate on this project.'''
<span style="color:#ff0000">
 
The success of OWASP is due to a community of enthusiasts and contributors that work to make our projects great. This is also true for the success of your project.  
 
Be sure to give credit where credit is due, no matter how small! This should be a brief list of the most amazing people involved in your project.
 
Be sure to provide a link to a complete list of all the amazing people in your project's community as well.
 
</span>
 
 
 
The OWASP Tool Project Template is developed by a worldwide team of volunteers. A live update of project  [https://github.com/OWASP/Security-Principles/graphs/contributors contributors is found here].
 
  
The first contributors to the project were:
+
The OWASP SecureTea Project is extremely grateful for all of our contributors both prior to becoming open source and after. A live update of the project [https://github.com/OWASP/SecureTea-Project/graphs/contributors contributors is found here].
 
 
* [https://www.owasp.org/index.php/User:Clerkendweller Colin Watson] who created the OWASP Cornucopia project that the template was derived from
 
* [https://www.owasp.org/index.php/User:Chuck_Cooper Chuck Cooper] who edited the template to convert it from a documentation project to a Tool Project Template
 
* '''YOUR NAME BELONGS HERE AND YOU SHOULD REMOVE THE PRIOR 3 NAMES'''
 
  
 
= Road Map and Getting Involved =
 
= Road Map and Getting Involved =
  
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
+
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->== Road Map ==
<span style="color:#ff0000">
+
* Gather existing presentations and pull ideas into OWASP.
A project roadmap is the envisioned plan for the project. The purpose of the roadmap is to help others understand where the project is going as well as areas that volunteers may contribute. It gives the community a chance to understand the context and the vision for the goal of the project. Additionally, if a project becomes inactive, or if the project is abandoned, a roadmap can help ensure a project can be adopted and continued under new leadership.
+
* Review IoT and identify security issues handled by these application.
Roadmaps vary in detail from a broad outline to a fully detailed project charter. Generally speaking, projects with detailed roadmaps have tended to develop into successful projects. Some details that leaders may consider placing in the roadmap include: envisioned milestones, planned feature enhancements, essential conditions, project assumptions, development timelines, etc. You are required to have at least 4 milestones for every year the project is active.
+
* Review PYTHON related literature (books, articles, ...)
</span>
+
* Document ways to secure computer/laptop/server.
 
+
* Roadmap Can see more at [https://github.com/OWASP/SecureTea-Project/blob/master/doc/en-US/dev_guide.md Dev Guide] & List Integration [https://github.com/OWASP/SecureTea-Project/blob/master/doc/Integration_list/List_integration.md here]
- Gather existing presentations and pull ideas into OWASP.
 
 
 
- Review IoT and identify security issues handled by these application.
 
 
 
- Review PYTHON related literature (books, articles, ...)
 
 
 
- Document ways to secure computer/laptop.
 
 
 
==Roadmap==
 
As of <strong>November, 2013, the highest priorities for the next 6 months</strong> are:
 
<strong>
 
* Complete the first draft of the Tool Project Template
 
* Get other people to review the Tool Project Template and provide feedback
 
* Incorporate feedback into changes in the Tool Project Template
 
* Finalize the Tool Project template and have it reviewed to be promoted from an Incubator Project to a Lab Project
 
</strong>
 
 
 
Subsequent Releases will add
 
<strong>
 
* Internationalization Support
 
* Additional Unit Tests
 
* Automated Regression tests
 
</strong>
 
 
 
 
==Getting Involved==
 
==Getting Involved==
Involvement in the development and promotion of <strong>Tool Project Template</strong> is actively encouraged!
+
Involvement in the development and promotion of <strong>OWASP SecureTea Tool Project</strong> is actively encouraged!
 
You do not have to be a security expert or a programmer to contribute.
 
You do not have to be a security expert or a programmer to contribute.
 
Some of the ways you can help are as follows:
 
Some of the ways you can help are as follows:
Line 188: Line 116:
 
We could implement some of the later items on the roadmap sooner if someone wanted to help out with unit or automated regression tests
 
We could implement some of the later items on the roadmap sooner if someone wanted to help out with unit or automated regression tests
 
===Localization===
 
===Localization===
Are you fluent in another language? Can you help translate the text strings in the <strong>Tool Project Template</strong> into that language?
+
Are you fluent in another language? Can you help translate the text strings in the <strong>OWASP SecureTea Tool Project</strong> into that language?
 
===Testing===
 
===Testing===
 
Do you have a flair for finding bugs in software? We want to product a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer your help.
 
Do you have a flair for finding bugs in software? We want to product a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer your help.
 
===Feedback===
 
===Feedback===
Please use the [https://lists.owasp.org/mailman/listinfo/OWASP_Tool_Project_Template Tool Project Template project mailing list] for feedback about:
+
Please Join to Telegram Group [https://t.me/joinchat/Az5yZxQg7Djs-UZWKKCRVQ SecureTea Project Group] for feedback about:
 
<ul>
 
<ul>
 
<li>What do like?</li>
 
<li>What do like?</li>
Line 198: Line 126:
 
<li>What features would you like to see prioritized on the roadmap?</li>
 
<li>What features would you like to see prioritized on the roadmap?</li>
 
</ul>
 
</ul>
 
=Minimum Viable Product=
 
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
<span style="color:#ff0000">
 
This page is where you should indicate what is the minimum set of functionality that is required to make this a useful product that addresses your core security concern.
 
Defining this information helps the project leader to think about what is the critical functionality that a user needs for this project to be useful, thereby helping determine what the priorities should be on the roadmap.  And it also helps reviewers who are evaluating the project to determine if the functionality sufficiently provides the critical functionality to determine if the project should be promoted to the next project category. 
 
</span>
 
 
The Tool Project Template must specify the minimum set of tabs a project should have, provide some an example layout on each tab, provide instructional text on how a project leader should modify the tab, and give some example text that illustrates how to create an actual project.
 
 
It would also be ideal if the sample text was translated into different languages.
 
  
 
=Project About=
 
=Project About=
Addtional Instructions for making changes:
 
 
The About 'tab' on that page is done with a MediaWiki template.  If you log into the wiki page for your project and click the "Edit" button/link/tab in the top-right between 'Read' and 'View History', you'll see the edit page for the main body of your project page.
 
 
If you scroll down below the form to edit that page (below the "Save page", "Show preview", "Show changes" buttons, you'll see some text with a triangle in front of it reading "Templates used on this page:"  A list will expand if you click on the triangle/text to show the templates that make up this page.  The one you want is the "Projects/OWASP Example Project About Page" - click the (edit) next to this to edit that template.  The direct link is: https://www.owasp.org/index.php?title=Projects/OWASP_Example_Project_About_Page&action=edit
 
 
The template takes 'input' that are key/value pairs where you'll need to edit the stuff after the equals (=) like:
 
project_name =Place your project name here.
 
 
You'd edit the bold bit.
 
  
 
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
 
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.-->
<span style="color:#ff0000">
+
Detail around this project can be found at: https://github.com/OWASP/SecureTea-Project
This page is where you need to place your legacy project template page if your project was created before October 2013. To edit this page you will need to edit your project information template. You can typically find this page by following this address and substituting your project name where it says "OWASP_Example_Project". When in doubt, ask the OWASP Projects Manager.
 
Example template page: https://www.owasp.org/index.php/Projects/OWASP_Example_Project
 
</span>
 
  
{{:Projects/OWASP_Example_Project_About_Page}}
 
  
 
__NOTOC__ <headertabs></headertabs>  
 
__NOTOC__ <headertabs></headertabs>  

Latest revision as of 15:18, 23 November 2019

OWASP Project Header.jpg

Maintenance notice

This site is no longer maintained: please go to https://www2.owasp.org/www-project-securetea/ for our new website!

OWASP SecureTea Tool Project

The OWASP SecureTea Project is an application designed to help secure a person's laptop or computer / server with IoT (Internet Of Things) and notify users (via various communication mechanisms), whenever someone accesses their computer / server. This application uses the touchpad/mouse/wireless mouse to determine activity and is developed in Python and tested on various machines (Linux, Mac & Windows). The software is still under development, and will eventually have it's own IDS(Intrusion Detection System) / IPS(Instrusion Prevention System), firewall, anti-virus, intelligent log monitoring capabilities with web defacement detection, and support for much more communication medium.


User Guide

https://github.com/OWASP/SecureTea-Project/blob/master/doc/en-US/user_guide.md

Developer Guide

https://github.com/OWASP/SecureTea-Project/blob/master/doc/en-US/dev_guide.md

Demo

You can see what SecureTea Project is all about in the following video:

OWASP SecureTea Notify to telegram:
OWASP SecureTea Notify to twilio/sms:

Licensing

OWASP SecureTea Tool is free to use. It is licensed under the MIT license.

News and Events

  • [20 Mar 2017] V1.0 Beta Release candidate is available for download. First release for trial period.
  • [04 Feb 2018] V1.0 Release Candidate is available for download. This release provides final bug fixes and product stabilization. Any feedback (good or bad) in the next few weeks would be greatly appreciated.
  • [25 Jan 2018] Published in ToolsWatch.org, Blackhat Arsenal Asia 2018 Great Lineup.

Project Resources

Installation Package

Source Code

Wiki Home Page

Issue Tracker
Presentation (Old PDF-2017)

Project Leader

Video Creator

Contributors


Open Hub

https://www.openhub.net/p/734848

Related Projects

Classifications

Project Type Files TOOL.jpg
Incubator Project Owasp-builders-small.png
Owasp-defenders-small.png

How can I participate in your project?

All you have to do is make the Project Leader's aware of your available time to contribute to the project. It is also important to let the Leader's know how you would like to contribute and pitch in to help the project meet it's goals and milestones. There are many different ways you can contribute to an OWASP Project, but communication with the leads is key.

If I am not a programmer can I participate in your project?

Yes, you can certainly participate in the project if you are not a programmer or technical. The project needs different skills and expertise and different times during its development. Currently, we are looking for researchers, writers, graphic designers, and a project administrator. See the Road Map and Getting Involved tab for more details.

Contributors

Everyone is invited to collaborate on this project.

The OWASP SecureTea Project is extremely grateful for all of our contributors both prior to becoming open source and after. A live update of the project contributors is found here.

Road Map

  • Gather existing presentations and pull ideas into OWASP.
  • Review IoT and identify security issues handled by these application.
  • Review PYTHON related literature (books, articles, ...)
  • Document ways to secure computer/laptop/server.
  • Roadmap Can see more at Dev Guide & List Integration here

Getting Involved

Involvement in the development and promotion of OWASP SecureTea Tool Project is actively encouraged! You do not have to be a security expert or a programmer to contribute. Some of the ways you can help are as follows:

Coding

We could implement some of the later items on the roadmap sooner if someone wanted to help out with unit or automated regression tests

Localization

Are you fluent in another language? Can you help translate the text strings in the OWASP SecureTea Tool Project into that language?

Testing

Do you have a flair for finding bugs in software? We want to product a high quality product, so any help with Quality Assurance would be greatly appreciated. Let us know if you can offer your help.

Feedback

Please Join to Telegram Group SecureTea Project Group for feedback about:

  • What do like?
  • What don't you like?
  • What features would you like to see prioritized on the roadmap?

Detail around this project can be found at: https://github.com/OWASP/SecureTea-Project