# skf-flask **Repository Path**: free2048/skf-flask ## Basic Information - **Project Name**: skf-flask - **Description**: Security Knowledge Framework (SKF) Python Flask / Angular project - **Primary Language**: Unknown - **License**: AGPL-3.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-08-20 - **Last Updated**: 2020-12-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # OWASP Security Knowledge Framework [![SKF Logo](https://www.securityknowledgeframework.org/img/banner-wiki-owasp.jpg)](https://www.securityknowledgeframework.org/)
Project status details:
[![Build Travis CI Master](https://travis-ci.org/blabla1337/skf-flask.svg?branch=master)](https://travis-ci.org/blabla1337/skf-flask) [![Join the chat at https://gitter.im/Security-Knowledge-Framework/Lobby](https://badges.gitter.im/Security-Knowledge-Framework/Lobby.svg)](https://gitter.im/Security-Knowledge-Framework/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://owasp.slack.com/messages/C0F7L9X6V](https://img.shields.io/badge/chat-on%20slack-blueviolet)](https://owasp.slack.com/messages/C0F7L9X6V) [![OWASP Flagship](https://img.shields.io/badge/owasp-flagship%20project-orange.svg)](https://www.owasp.org/index.php/OWASP_Security_Knowledge_Framework)
Quality testing:
[![Known Vulnerabilities](https://snyk.io/test/github/blabla1337/skf-flask/badge.svg)](https://snyk.io/test/github/blabla1337/skf-flask) [![Coverage Status](https://coveralls.io/repos/blabla1337/skf-flask/badge.svg?branch=master)](https://coveralls.io/repos/blabla1337/skf-flask/badge.svg?branch=master) [![Black Duck Security Risk](https://copilot.blackducksoftware.com/github/repos/blabla1337/skf-flask/branches/master/badge-risk.svg)](https://copilot.blackducksoftware.com/github/repos/blabla1337/skf-flask/branches/master) [![Requirements Status](https://requires.io/github/blabla1337/skf-flask/requirements.svg?branch=master)](https://requires.io/github/blabla1337/skf-flask/requirements/?branch=master) Security Knowledge Framework is an expert system application that uses the OWASP Application Security Verification Standard with detailed code examples (secure coding principles) to help developers in pre-development and post-development phases and create applications that are secure by design. ## Table of Contents * [Introduction](#introduction) * [Installing](#installing) * [Updating Database](#updating-db) * [Updating Chatbot](#updating-dataset) * [Usage](#usage) * [CI-Pipeline](#ci-pipeline) * [Development / Contributing](https://github.com/blabla1337/skf-flask/blob/master/CONTRIBUTING.md) * [Scrum Board](#scrum-board) * [License](#license) * [Contributors](#contributors) ## Introduction Our experience taught us that the current level of security of web-applications is not sufficient enough to ensure security. This is mainly because web-developers simply aren't aware of the risks and dangers that are lurking, waiting to be exploited by hackers. Because of this we decided to develop a framework in order to create a guide-system available for all developers so they can develop applications secure by design from the start. The OWASP Security Knowledge Framework is here to support developers in creating secure applications. By using the [OWASP Application Security Verification Standards.](https://www.owasp.org/index.php/Category:OWASP_Application_Security_Verification_Standard_Project) as a security requirement and give the developer feedback regarding descriptions and solutions on how to properly implement these security controls in a safe manner. The second stage is validating if the developer properly implemented different security controls and the belonging defence mechanisms by means of checklists created with the [OWASP Application Security Verification Standards.](https://www.owasp.org/index.php/Category:OWASP_Application_Security_Verification_Standard_Project) By means of the answers supplied by the developer the application again generates documentation in which it gives feedback on what defence mechanisms the developer forgot to implement and gives him feedback regarding descriptions and solutions on how to properly implement these techniques in a safe manner. ## Installing ### [Local on premise installation how to](https://github.com/blabla1337/skf-flask/tree/master/installations/local) ### [Docker local installation how to](https://github.com/blabla1337/skf-flask/tree/master/installations/docker) ### [Kubernetes installation how to](https://github.com/blabla1337/skf-flask/tree/master/installations/Kubernetes) ### [Azure installation how to](https://github.com/blabla1337/skf-flask/tree/master/installations/azure-deployment) ### [SKF Chatbot installation how to](https://github.com/blabla1337/skf-bot) ## Updating Database There is a method available to update the content of the SKF application. When you have modified or created new Knowledge base items, code examples or checklist you need to run the following commands in the SKF root directory: ``` export FLASK_APP=skf/app.py export PYTHONPATH=.:$PYTHONPATH flask updatedb ``` ## Updating chatbot There is a method available to update the dataset of the SKF chatbot application. When you have modified or created new Knowledge base items, code examples or checklist you need to run the following commands in the SKF root directory: ``` export FLASK_APP=skf/app.py export PYTHONPATH=.:$PYTHONPATH flask initdataset ``` ## Usage For more detailed information such as setting up an admin account and user guides please see the extended documentation that can be found below: [Readme: extended documentation](https://skf.readme.io/) ## CI-Pipeline ### Travis-ci.org: ``` Test and Deploy with Confidence. Easily sync your GitHub projects with Travis CI and you'll be testing your code in minutes! SKF Build details: ``` https://travis-ci.org/blabla1337/skf-flask ### Coveralls.io Python: ``` DELIVER BETTER CODE. We help developers deliver code confidently by showing which parts of your code aren't covered by your test suite. SKF Coveralls details: ``` https://coveralls.io/r/blabla1337/skf-flask ### codecov.io for Angular: ``` Code coverage done right. Highly integrated with GitHub, Bitbucket and GitLab. SKF codecov details: ``` https://codecov.io/gh/blabla1337/skf-flask ### Bithound.io NPM packages: ``` BitHound provides your Node team with comprehensive and prioritized issues in your code and npm packages. SKF Bithound details: ``` https://www.bithound.io/github/blabla1337/skf-flask ### Requires.io pip packages: ``` Stay Up-to-date! Stay secure! Requires.io monitors your Python projects dependencies, and notify you whenever any of your dependency is out-of-date. SKF Requires details: ``` https://requires.io/github/blabla1337/skf-flask/requirements/ ### Black Duck Security Risk: ``` Announcing Black Duck CoPilot, a new service helping open source project teams catalog and report on their project's dependencies. SKF Requires details: ``` https://copilot.blackducksoftware.com/github/groups/blabla1337/locations/skf-flask/public/results ### uptimerobot.com: ``` Monitor HTTP(s), Ping, Port and check Keywords. Get alerted via e-mail, SMS, Twitter, web-hooks or push. View uptime, downtime and response times. ``` ### ssllabs.com & sslbadge.org: ``` ssllabs.org: Bringing you the best SSL/TLS and PKI testing tools and documentation. sslbadge.org: Creates a nice badge for your website SSL/TLS security settings based on the Qualys SSL Labs testing. ``` [![SSL Rating](http://sslbadge.org/?domain=securityknowledgeframework.org)](https://www.ssllabs.com/ssltest/analyze.html?d=securityknowledgeframework.org) ## License Copyright (C) 2020 Glenn ten Cate, Riccardo ten Cate This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of the GNU Affero General Public License along with this program. If not, see . ### OWASP: * [Owasp](http://owasp.com/index.php/Main_Page) Licensed under the [creative commons](http://creativecommons.org/licenses/by-nd/3.0/nl/) license ## Contributors - Lucas Luitjes - [Mattijs van Ommeren](https://twitter.com/alcyonsecurity) - [Glenn ten Cate](https://twitter.com/FooBar_testing_) - [Riccardo ten Cate](https://twitter.com/RiieCco) - [Alexander Kaasjager](https://twitter.com/akaasjager) - John Haley - Daniel Paulus - [Erik de Kuijper](https://twitter.com/edkpr) - Roderick Schaefer - [Jim Manico](https://twitter.com/manicode) - Martijn Gijsberti Hodenpijl - Bithin Alangot - Martin Knobloch - Adam Fisher - Tom Wirschell - Joerg Stephan - Simon Brakhane - Gerco Grandia - [Ross Nanopoulos](https://twitter.com/rossnanop) - Bob van den Heuvel - Mariano Jose Abdala - Ilguiz Latypov - Laurence Keijmel - Rick Mitchell (Kingthorin) - Xenofon Vassilakopoulos - Heeraj Nair - Alpha Kitonga - [Wojciech Reguła](https://www.linkedin.com/in/wojciech-regula/) - Amadeusz Starzykiewicz - Adam Zima - Kacper Madej - Rafał Fronczyk - Chang Xu (Neo) - Martin Marsicano - [Priyanka Jain](https://www.linkedin.com/in/priyanka997/) - Chandrasekar Karthickrajan - Leena Bhegade - Balazs Hambalko - Rudy Truyens - Giulio Comi - Aniket Surwade - Thiago Luiz Dimbarre - Harshant Sharma - Semen Rozhkov - Mehtab Zafar - Daniel Spilsbury