From 82d270ad59e267843f70992b2bb86658fa27baf6 Mon Sep 17 00:00:00 2001 From: Glenn ten Cate Date: Fri, 4 Aug 2023 15:07:00 +0200 Subject: [PATCH] Update README.md --- README.md | 135 ++---------------------------------------------------- 1 file changed, 5 insertions(+), 130 deletions(-) diff --git a/README.md b/README.md index cc139d69c..7918dd4cf 100755 --- a/README.md +++ b/README.md @@ -1,32 +1,9 @@ -# OWASP Security Knowledge Framework -[![SKF Logo](https://github.com/blabla1337/skf-www/blob/master/images/site-skf/logo_github.png?raw=true)](https://www.securityknowledgeframework.org/) +# OLD and archived Security Knowledge Framework -
Project status details:
-[![Build Travis CI main](https://travis-ci.org/blabla1337/skf-flask.svg?branch=main)](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) -[![OSSF Working group: Best Practices for Open Source Developers](https://img.shields.io/badge/openssf-Learning%20Platform%20Project-orange.svg)](https://openssf.org) - -
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=main)](https://coveralls.io/repos/blabla1337/skf-flask/badge.svg?branch=main) -[![Requirements Status](https://requires.io/github/blabla1337/skf-flask/requirements.svg?branch=main)](https://requires.io/github/blabla1337/skf-flask/requirements/?branch=main) -[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/133/badge)](https://bestpractices.coreinfrastructure.org/projects/133) - -The OWASP Security Knowledge Framework is an open source web application that explains secure coding principles in multiple programming languages. The goal of OWASP-SKF is to help you learn and integrate security by design in your software development and build applications that are secure by design. OWASP-SKF does this through manageable software development projects with checklists (using OWASP-ASVS/OWASP-MASVS or custom security checklists) and labs to practice security verification (using SKF-Labs, OWASP Juice-shop, and best practice code examples from SKF and the OWASP-Cheatsheets). - -## Table of Contents -* [Introduction](#introduction) -* [Installing](#installing) -* [Updating Database](#updating-db) -* [Updating Chatbot](#updating-dataset) -* [Usage](#usage) -* [CI-Pipeline](#ci-pipeline) -* [Development / Contributing](CONTRIBUTING.md) -* [Scrum Board](#scrum-board) -* [License](#license) -* [Contributors](#contributors) +Please note that this is the archived version of SKF, we are busy building a brand new Security Knowledge Framework. For more updates please visit this github repo: +- **https://github.com/Security-Knowledge-Framework/Platform** +- **https://github.com/Security-Knowledge-Framework/SKF-requirements-tool** +- **https://github.com/Security-Knowledge-Framework/Labs** ## Introduction @@ -38,108 +15,6 @@ Because of this we decided to develop a framework in order to create a guide-sys [![SKF Flow](https://raw.githubusercontent.com/blabla1337/skf-www/master/images/site-skf/skf_flow.gif)](https://www.securityknowledgeframework.org/) -## Installing - -### [Kubernetes installation how to](installations/Kubernetes) -### [Docker-compose local how to](installations/docker) -### [SKF K8s Raspberry pi cluster how to](installations/pi-cluster) -### [SKF Chatbot installation how to](https://github.com/blabla1337/skf-bot) -### [Bare metal / on premise installation how to DEPRECATED](installations/local) - -## 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 - -### 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/ - -### 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) 2021 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 - [Imanuel Febie](https://github.com/tuffgniuz)