Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/payatu/tiredful-api

An intentionally designed broken web application based on REST API.
https://github.com/payatu/tiredful-api

Last synced: 11 days ago
JSON representation

An intentionally designed broken web application based on REST API.

Awesome Lists containing this project

README 

        
### What is Tiredful API?



Tiredful API is intentionally designed broken app. The aim of this web app is to teach developers, QA  or security professionals about flaws present in webservices (REST API) due to insecure coding practice.



![Tiredful API image](./Tiredful-API.jpg)



### Who can use Tiredful API?

* Web developers

* Web Pentesters

* Security Professionals

* Student



### What is included in Tiredful API?



I tried to cover most of the vulnerabilities, I am sure that we have missed some vulnerabilities.Please ping me if you know any good vulnerability that should be included. For now I have included following vulnerabilities.



* Information Disclosure

* Insecure Direct Object Reference

* Access Control

* Throttling

* SQL Injection (SQLite)

* Cross Site Scripting.



[You can see solution here](https://payatu.com/tiredful-api-solution/)



### Can I contribute?

Yes, you can help by sending us the details of vulnerabilities that we can implement in future versions of Tiredful API. Please mail us at info[at]payatu.com with subject "Tiredful API Scenario".



### Where can I get Tiredful API?

Source can be downloaded from [link](https://github.com/payatu/Tiredful-API).



### How to run Tiredful API?

Tiredful API is developed using Django Framework and Django Rest Framework, so for running the web server user needs execute following command.



* Navigate to the source folder and locate manage.py file.

* Then execute `python manage.py runserver`.

* If static files are not getting load, then execute above command with insecure flag i.e. `python manage.py runserver --insecure`

If you are facing any issue starting the web server please refer [django documentation admin](https://docs.djangoproject.com/en/1.11/ref/django-admin/#runserver) or [django documentation tutorial](https://docs.djangoproject.com/en/1.11/intro/tutorial01/#the-development-server).

Please ping me if you are still not able to run development server.



**Note:** It is recommended to use required libraries with the version specified in the requirements.txt. Please refer [this](https://pip.pypa.io/en/stable/user_guide/#requirements-files) more details



#### Docker Container

You can run Tiredful via [Docker](https://www.docker.com).  Simply execute:



```

docker build -t tiredful .

docker run -p 8000:8000 --name tiredful -it tiredful

```



Browse to `http://localhost:8000/` and you are all set.  Use `CTRL-C` to shut down the server.



Added new JWT based scenarios. Updated repository available at [repo](https://github.com/siddharthbezalwar/Tiredful-API)



#### Python3 Compatible Code

[Tiredful API Python3](https://github.com/siddharthbezalwar/Tiredful-API-py3-beta)



### Feedback and Bug Reports.

We would love to hear from you about your experience with Tiredful API. Please send us an email on info [at] payatu [dot] com or siddharth [dot] bezalwar [at] gmail [dot] com with Subject "Tiredful API Issue" based on what you want to share. Please include the below in your email.



* Operating system with version.

* Django Framework used.

* Steps to replicate issue.



### Author

Siddharth Bezalwar



@fattu_medjai | siddharth [dot] bezalwar [at] gmail [dot] com



### About Payatu

Payatu is a boutique security testing company with specialization in:



* IoT Security

* Mobile Security

* Cloud security

* Web Security

We also organize two International Security Conferences



nullcon International Security Conference - http://nullcon.net

hardwear.io Hardware Security Conference - http://hardwear.io

**Website:** http://payatu.com **Email:** info (at) payatu dot com