Difference between revisions of "OWASP Security Shepherd"

From OWASP
Jump to: navigation, search
(reflect the download link to include latest releases)
 
(37 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div style="width:100%;height:90px;border:0,margin:0;overflow: hidden;">[[File:Incubator_big.jpg|link=OWASP_Project_Stages#tab=Incubator_Projects]]</div>
+
=Main=
[[Image:Shepherd-Injection-Lesson.JPG|thumb|300px|right|Detailed vulnerability explainations]][[Image:Shepherd-Scoreboard.JPG|thumb|300px|right|Competitive Learning Environment]]
+
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:flagship_big.jpg|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Flagship_Projects]]</div>
'''Security Shepherd''' is a computer based training application for web and mobile application security vulnerabilities. This project strives to herd the lost sheep of the technological world back to the safe and sound ways of secure practices. Security Shepherd can be deployed as a CTF (Capture the Flag) game or as an open floor educational server.
+
{| style="padding: 0;margin:0;margin-top:10px;text-align:left;" |-
 +
| valign="top" style="border-right: 1px dotted gray;padding-right:25px;" |
  
== Overview ==
+
==OWASP Security Shepherd==
[[Image:Shepherd-CTF-Level-One.JPG|thumb|300px|right|Easy configuration to suit every use]]
 
Security Shepherd has been implemented with the aim of fostering and improving security awareness among a varied skill-set demographic. This project enables users to learn or to improve upon existing manual penetration testing skills. This is accomplished through lesson and challenge techniques. A lesson provides a user with a lot of help in completing that module, where a challenge puts what the user learned in the lesson to use. Utilizing the OWASP top ten as a challenge test bed, common security vulnerabilities can be explored and their impact on a system understood. The by-product of this challenge game is the acquired skill to harden a player's own environment from OWASP top ten security risks. The modules have been crafted to provide not only a challenge for a security novice, but security professionals as well.
 
  
Security Shepherd's vulnerabilities are not simulated, and are instead delivered through hardened real security vulnerabilities that can not be abused to compromise the application or its environment. Many of these levels include insufficient protections to these vulnerabilities, such as black list filters and poor security configuration.
+
The OWASP Security Shepherd project is a web and mobile application security training platform. Security Shepherd has been designed to foster and improve security awareness among a varied skill-set demographic. The aim of this project is to take AppSec novices or experienced engineers and sharpen their penetration testing skillset to security expert status.
  
===CTF Mode===
+
==Description==
Security Shepherd can be morphed into a CTF server by an administrator with the click of a button. This presents users with one module at a time. They must complete their current level before they can continue. Administrators can also set a "Module Block" that prevents users from progressing past a certain level. It is also possible to run a CTF in a Tournament mode where a user can complete any module in any order they wish. When either of these modes are enabled, the scoreboard is then available. The scoreboard updates automatically and reflects the bonus points users achieve by completing a module first, second or third.
 
  
===User Management===
+
The OWASP Security Shepherd project enables users to learn or to improve upon existing manual penetration testing skills. This is accomplished by presenting security risk concepts to users in lessons followed by challenges. A lesson provides a user with help in layman terms about a specific security risk, and helps them exploit a text book version of the issue. Challenges include poor security mitigations to vulnerabilities which have left room for users to exploit.
Security Shepherd includes a user friendly method of creating many users at a time for administrators, as well as an optional open registry system. Users' activities are logged allowing an administrator to gather real time data on who is connected to Security Shepherd and what their module progress is. This data can be mined to gather information on who was online, at what time and how much time has been actively spent on a challenge.
 
  
===Topic Coverage===
+
Utilizing the OWASP top ten as a challenge test bed, common security vulnerabilities can be explored and their impact on a system understood. The by-product of this challenge game is the acquired skill to harden a player's own environment from OWASP top ten security risks. The modules have been crafted to provide not only a challenge for a security novice, but security professionals as well.
The Security Shepherd project covers the following web application security topics;
 
  
*[[Top_10_2010-A1|SQL Injection]]
+
Shepherd's security risks are delivered through hardened real vulnerabilities that can not be abused to compromise the application or its environment. Shepherd does not simulate security risks so that all and any attack vectors will work, ensuring a real world response.
*[[Top_10_2010-A2|Cross Site Scripting]]
+
 
*[[Top_10_2010-A3|Broken Authetication and Session Management]]
+
Security Shepherd is highly configurable. System administrators can tune the project experience to present specific security risk topics or even specific Security Shepherd modules. The array of user and module configuration available allows Shepherd to be used by a single local user, by many in a competitive classroom environment or by hundreds in an online hacking competition.
*[[Top_10_2010-A5|Cross Site Rrequest Forgery]]
+
 
*[[Top_10_2010-A4|Insecure Direct Object Reference]]
+
== Why use Security Shepherd? ==
*[[Top_10_2010-A7|Insecure Cryptographic Storage]]
+
 
*[[Top_10_2010-A8|Failure to Restrict URL Access]]
+
'''Wide Topic Coverage: ''' Shepherd includes more than seventy levels - across the entire spectrum of Web and mobile application security - within a single project.
*[[Top_10_2010-A10|Unvalidated Redirects and Forwards]]
+
 
*[[Top_10_2010-A9|Insufficient Transport Layer Security]]
+
'''Gentle Learning Curve: ''' Shepherd is a perfect entry point for users completely new to security, with levels increasing in difficulty at a manageable pace.
 +
 
 +
'''Layman Write Ups: ''' Each security concept, when first addressed in Shepherd, is presented using plain language, so it can be readily understood by beginners.
 +
 
 +
'''Real World Examples: ''' The security risks in Shepherd are real vulnerabilities that have had their exploit impact dampened to protect the application, users and environment. There are no simulated security risks which require an expected, specific attack
 +
vector in order to pass a level. Attack vectors when used on Shepherd are how they would behave in the real world.
 +
 
 +
'''Scalability: ''' Shepherd can be used locally by a single user or easily as a server for a high amount of users.
 +
 
 +
'''Highly Customisable: ''' Shepherd enables admins to set what levels are available to their users and in what way they are presented (Open, CTF and Tournament Layouts)
 +
 
 +
'''Perfect for Classrooms: ''' Shepherd gives its players user specific solution keys to prevent students from sharing keys, rather than going through the steps required to complete a level.
 +
 
 +
'''Scoreboard: ''' Security Shepherd has a configurable scoreboard to encourage a competitive learning environment. Users that complete levels first, second and third get medals on their scoreboard entry and bonus points to keep things entertaining on the scoreboard.
 +
 
 +
'''User Management: ''' Security Shepherd admins can create users, create admins, suspend, unsuspend, add bonus points or take penalty points away user accounts with the admin user management controls. Admins can also segment their students into specific class groups. Admins can view the progress a class has made to identify struggling participants. An admin can even close public registration and manually create users if they wish for a private experience.
 +
 
 +
'''Localisation Support: ''' Security Shepherd material is available in multiple languages from a single instance. Students with alternative language preferences can compete in the same Shepherd instance as others without issue.
 +
 
 +
'''Robust Service: ''' Shepherd has been used to run online CTFs such as the OWASP Global CTF and OWASP LATAM Tour CTF 2015, both surpassing 200 active users and running with no downtime, bar planned maintenance periods.
 +
 
 +
'''Configurable Feedback: ''' An administrator can enable a feedback process, which must be completed by users before a level is marked as complete. This is used both to facilitate project improvements based on feedback submitted and for system administrators to collect "Reports of Understanding" from their students.
 +
 
 +
'''Granular Logging: ''' The logs reported by Security Shepherd are highly detailed and descriptive, but not screen blinding. If a user is misbehaving, you will know.
 +
 
 +
== Security Shepherd Road Map ==
 +
Security Shepherd wants to be as highly usable as we can achieve. Our primary objective is currently to achieve full language localisation support for the entire application. Currently we have covered the main pages users would interact with. We actively need volunteers to take part in the translation process. If you are interested in getting involved please check out our [http://bit.ly/securityShepherdGithub GitHub] Wiki describing [https://github.com/OWASP/SecurityShepherd/wiki/How-to-Create-a-Web-Shepherd-Level How to Add a New Language to Security Shepherd].
 +
 
 +
Our long term goals are to cover as many web and mobile application security risks as possible. If you are interested in getting involved in adding levels to Security Shepherd, please check out our [http://bit.ly/securityShepherdGithub GitHub] Wiki describing [https://github.com/OWASP/SecurityShepherd/wiki/Adding-a-new-Language-to-Shepherd How to Make a Security Shepherd Level]. For the Latest and Greatest short term goals. Please see the [https://github.com/OWASP/SecurityShepherd/issues issues page in our GitHub].
 +
 
 +
| valign="top" style="padding-left:25px;width:350px;border-right: 1px dotted gray;padding-right:25px;" |
 +
 
 +
== What is Security Shepherd? ==
 +
 
 +
OWASP Security Shepherd provides:
 +
 
 +
* Teaching Tool for All Application Security
 +
* Web Application Pen Testing Training
 +
* Mobile Application Pen Testing Training
 +
* Safe Playground to Practise AppSec Techniques
 +
* Real Security Risk Examples
 +
 
 +
==Topic Coverage==
 +
The Security Shepherd project covers the following web and mobile application security topics;
 +
 
 +
*[[Top_10_2013-A1|SQL Injection]]
 +
*[[Top_10_2013-A2|Broken Authentication and Session Management]]
 +
*[[Top_10_2013-A3|Cross Site Scripting]]
 +
*[[Top_10_2013-A4|Insecure Direct Object Reference]]
 +
*[[Top_10_2013-A5|Security Misconfiguration]]
 +
*[[Top_10_2013-A6|Sensitive Data Exposure]]
 +
*[[Top_10_2013-A7|Missing Function Level Access Control]]
 +
*[[Top_10_2013-A8|Cross Site Request Forgery]]
 +
*[[Top 10 2013-A10|Unvalidated Redirects and Forwards]]
 +
*[[Data_Validation|Poor Data Validation]]
 
*[[Mobile_Top_10_2014-M2|Insecure Data Storage]]
 
*[[Mobile_Top_10_2014-M2|Insecure Data Storage]]
 +
*[[Mobile_Top_10_2014-M4|Unintended Data Leakage]]
 +
*[[Mobile_Top_10_2014-M5|Poor Authentication and Authorisation]]
 +
*[[Mobile_Top_10_2014-M6|Broken crypto]]
 
*[[Mobile_Top_10_2014-M7|Client Side Injection]]
 
*[[Mobile_Top_10_2014-M7|Client Side Injection]]
 
*[[Mobile_Top_10_2014-M10|Lack Of Binary Protections]]
 
*[[Mobile_Top_10_2014-M10|Lack Of Binary Protections]]
*[[Mobile_Top_10_2014-M4|Unintended Data Leakage]]
 
*[[Mobile_Top_10_2014-M6|Broken crypto]]
 
  
==Download==
+
==Layout Options==
 +
 
 +
An administrator user of Security Shepherd can change the layout in which the levels are presented to players. There are three options:
 +
 
 +
'''CTF Mode'''
 +
 
 +
When Shepherd has been deployed in the CTF mode, a user can only access one uncompleted module at a time. The first module presented to the user is the easiest in Security Shepherd, which has not been marked as closed by the administrator. The levels increase slowly in difficulty and jump from one topic to another. This layout is the recommended setting when using Security Shepherd for a competitive training scenario.
 +
 
 +
'''Open Floor'''
 +
 
 +
When Shepherd has been deployed in the Open Floor mode, a user can access any level that is marked as open by the admin. Modules are sorted into their Security Risk Categories, and the lessons are presented first. This layout is ideal for users wishing to explore security risks.
 +
 
 +
'''Tournament Mode'''
 +
 
 +
When Shepherd has been deployed in the Tournament Mode, a user can access any level that is marked as open by the admin. Modules are sorted into difficulty bands, from least to most difficult. This layout is ideal when Shepherd is being utilised as an open application security competition. 
 +
 
 +
| valign="top" style="padding-left:25px;width:250px;" |
 +
 
 +
== Download ==
  
You can download the Security Shepherd VM or Manual Installation Pack from [https://sourceforge.net/projects/owaspshepherd/files/ Source Forge].
+
* [https://github.com/OWASP/SecurityShepherd/releases OWASP Security Shepherd GitHub Downloads]
  
==Releases==
+
== Presentation ==
  
Security Shepherd has been designed with expansion in mind. The application's underlying architecture is composed of a secure core application and database server that depicts how the application runs. There is also an exposed application and database service that runs all of the server side vulnerability examples. If these services are compromised, the core service can continue to run unaffected.
+
[https://www.youtube.com/watch?v=-brsnYrksAI AppSecEU 2014 Video]
  
Security Shepherd is written in Java and is compiled in a web application archive (WAR) and therefore can be run on any platform with a Java virtual machine and a web application server like Tomcat. To eliminate tedious environment configuration; there is a Security Shepherd Virtual Machine. This environment includes Tomcat/MySQL servers pre-loaded with Security Shepherd. For those that prefer the path of higher resistance or want to build a dedicated Security Shepherd server, a manual pack is available for download as well.
+
[http://2014.appsec.eu/wp-content/uploads/2014/07/Sean.Duggan-OWASP-Security-Shepherd-Mobile-Web-Security-Awareness-and-Education.pdf AppSecEU 2014 Presentation]
  
===Security Shepherd v2.0 VM Setup:===
+
== Project Leaders ==
To get a Security Shepherd VM ready to rock, follow these steps;
 
  
Setting up your instance of Security Shepherd with the VM: In Steps!
+
Mark Denihan - mark.denihan@owasp.org
  
* Import the VM to your hyper visor (Eg: Virtual Box)
+
Sean Duggan  - sean.duggan@owasp.org
* Make sure the VM has a bridged adapter
 
* Boot the VM
 
* Sign in with securityshepherd / owaspSecurityShepherd
 
* Change the user password with the passwd command
 
* In the VM, run "ifconfig" to find the IP address. Make note of this
 
* On your host machine, open http://<VM IP Address>/
 
* Sign in with admin / password
 
* Change the admin password (cannot be password again)
 
* Use the configuration menu in the home page to change the application address from http://127.0.0.1/ to http://<VM IP Address>/
 
* Time to play!
 
  
===Security Shepherd v2.0 Manual Pack:===
+
== Recent News and Events ==
The manual release is a single download, unrar, and follow the steps release.
+
* [January 2017] Shepherd Graduates to Flagship
* Download the Security Shepherd Manual Pack
 
* Install Apache Tomcat 7
 
* Install MySql, using the default password (Contained in readme.txt) to skip future steps, if you prefer your own password go ahead and set-up MySql with that instead!
 
* Extract the Security Shepherd Manual Pack
 
* Copy the sql files extracted from the pack to the bin directory of MySql
 
* Open MySql from the command line (eg: mySqlBinDirectory/mysql -u root -p )
 
* Type the following commands to execute the Shepherd Manual Pack SQL files;
 
  
source core.sql
+
== Related Projects ==
source exposedSchema.sql
 
  
* Open the webapps directory of your Tomcat instance
+
* [[OWASP_WebGoat_Project|OWASP Webgoat Project]]
* Delete any directories that are there already
 
* Move the WAR files from the Shepherd Manual Pack into the webapps folder of Tomcat
 
* Start Tomcat
 
* Open the temp directory of Tomcat
 
* If you chose the default when configuring MySql as your DB password, you are running MySql on the same machine as Tomcat and you are using port 3306 for MySql, you can skip this step. Otherwise, in the temp directory, in both the ROOT and Exposed directories in the temp folder, modify the /WEB-INF/site.properties to point at your local DB with your MySql settings. Leave the Driver alone!
 
* If you have more than one ROOT or Exposed folder in your temp folder, visit your Tomcat instance with your browser and then check the Tomcat logs for a line that reads "Servlet root =" to find which directory is the correct one to modify the MySql settings of.
 
* Open your the root context of your Tomcat server (eg: http://127.0.0.1:8080/ )
 
* Sign into Security Shepherd with the default admin credentials (admin / password)
 
* Change the admin password
 
* Follow in application prompts for further configuration
 
  
== Future Development ==
+
==Licensing==
 +
The Security Shepherd project is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  
New levels or level ideas are wanted in the highest degree and there is development is in progress to fork the Security Shepherd platform into a CTF framework. If you wish to contribute a level or even an idea; contact Mark Denihan on mark.denihan@owasp.org.
+
The Security Shepherd project 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 General Public License for more details. See http://www.gnu.org/licenses/ .
  
The aim of Security Shepherd's future development is to create a comprehensive platform for web and mobile application pen testing training / security risk education.
+
==Classifications==
Check out the project [https://www.owasp.org/index.php/Projects/OWASP_Security_Shepherd/Roadmap roadmap] and find some tasks that you can help with right away..
 
  
To contribute right away, pull the source from [http://bit.ly/securityShepherdGithub GitHub]
+
  {| width="200" cellpadding="2"
 +
  |-
 +
  | rowspan="2" align="center" valign="top" width="50%" | [[File:Owasp-flagship-trans-85.png|link=https://www.owasp.org/index.php/OWASP_Project_Stages#tab=Flagship_Projects]]
 +
  | align="center" valign="top" width="50%" | [[File:Owasp-breakers-small.png|link=]] 
 +
  |-
 +
  | align="center" valign="top" width="50%" | [[File:Owasp-builders-small.png|link=]]
 +
  |-
 +
  | colspan="2" align="center" | [[File:Project_Type_Files_TOOL.jpg|link=]]
 +
  |}
  
== Events with Security Shepherd ==
+
|}
[[Image:Shepherd-CTF-In-Play.JPG|thumb|300px|right|Over 60 people playing the CTF at [[HackDub2012]]]]
 
  
The Security Shepherd application has been tried and tested across a number of Beta runs in venues like Facebook and the IRISScon CTF. Since these events Security Shepherd has been knocking on security doors trying to be recognized as the new platform for web application security training.
+
=FAQs=
  
* Security Shepherd was used as the [[HackDub2012|OWASP Dublin Hackathon 2012]]
+
; Q Can I Re-Skin Shepherd and then Train People With it?
* Security Shepherd's platform was used be used to manage the [[AppSecIreland2012| OWASP Ireland AppSec 2012]] CTF in September 2012
+
: A Yes! Follow [[https://github.com/OWASP/SecurityShepherd/wiki/How-To-Reskin-Shepherd this guide]]!
* Security Shepherd's platform was used to administer the Traditional Style CTF at the IRISS security conference in October 2012 and 2013
 
* Security Shepherd's platform was used to deliver the Traditional Style CTF at the 2013 SOURCE Conference CTF in Facebook
 
* Security Shepherd's platform was used to govern the EU Tour 2013 and LATAM Tour 2013 Online CTF's
 
* Security Shepherd's platform was used to conduct the 2013 OWASP Global CTF
 
* Security Shepherd was used as the 2014 OWASP application security summer school CTF at the Faculty of Organization and Informatics in Varaždin
 
  
== Project Contributors ==
+
; Q Where can I access Security Shepherd?
 +
: A You can Download it and run it yourself or there are various public instances (eg: [https://community.ctf365.com/t/owasp-security-shepherd/357 CTF365])
  
The Security Shepherd project was founded and is ran by Mark Denihan. The mobile wing of Security Shepherd is lead by Sean Duggan. If you wish to contribute to the OWASP Security Shepherd project please contact at mark.denihan@owasp.org, as help in any regard of the application is very much appreciated.  Security Shepherd distributions are currently maintained on [http://bit.ly/shepherdSourceForge SourceForge]. The Security Shepherd template makes it extremely easy to add additional lessons. We are actively seeking developers to add new lessons as new web technologies emerge. If you are interested in volunteering for the project, or have a comment, question, or suggestion, please join the Security Shepherd [https://lists.owasp.org/mailman/listinfo/owasp_security_shepherd mailing list].
+
; Q Where can I download Security Shepherd?
 +
: A You can download it from the [[https://github.com/OWASP/SecurityShepherd/releases/tag/v3.0 GitHub Release Page]]
  
Both the Security Shepherd Platform and the Mobile Shepherd aspects of this project were initially created as part of BSc degrees in the Dublin Institute of Technology. Thanks to [http://www.dit.ie DIT] for allowing those projects to be donated to the OWASP community.
+
; Q How can I run Shepherd on my network safely?
 +
: A just boot up the VM, install it manually or with Docker. The Security Shepherd application cannot be exploited to compromise the security of its environment. Make sure you patch your VM regularly to prevent intrusion to the host machine though.
  
 +
= Acknowledgements =
 
== Project Sponsors ==
 
== Project Sponsors ==
  
The OWASP Security Shepherd project would like to acknowledge and thank the generous support of our sponsors. Please be certain to visit their stall at the [http://bit.ly/AppSecEu2014|OWASP AppSec EU 2014] conference as well as follow them on [http://bit.ly/bccRiskAdvisory Twitter].  
+
The OWASP Security Shepherd project would like to acknowledge and thank the generous support of our sponsors. Please be certain to visit their websites and follow them on Twitter.
[[File:BccRiskAdvisoryLogo.jpg]][[File:EdgescanLogo.jpg]]
+
 
 +
[[File:BccRiskAdvisoryLogo.jpg]]
 +
 
 +
[[File:EdgescanLogo.jpg]]
 +
 
 +
[[File:Manicode-logo.png]]
 +
[[File:Axway logo.png|none|thumb|243x243px]]
 +
 
 +
==Contributors==
 +
OWASP Security Shepherd is developed by a worldwide team of volunteers. The primary contributors to date have been:
 +
 
 +
* Mark Denihan
 +
* Sean Duggan
 +
* Paul McCann
 +
* John Clarke
 +
* Lei Shao
 +
* Natalia Lopez
 +
* Aidan Knowles
 +
* Jason Flood
 +
 
 +
The Security Shepherd template makes it extremely easy to add additional lessons. We are actively seeking developers to add new lessons as new web technologies emerge. If you are interested in volunteering for the project, or have a comment, question, or suggestion, please contact Mark.denihan@owasp.org
 +
 
 +
New levels or level ideas are wanted in the highest degree and there is development is in progress to fork the Security Shepherd platform into a CTF framework. If you wish to contribute a level or even an idea; contact Mark Denihan on mark.denihan@owasp.org. The aim of Security Shepherd's future development is to create a comprehensive platform for web and mobile application pen testing training / security risk education. Check out the project [http://bit.ly/securityShepherdGithub GitHub] and find some issues that you can help with right away.
 +
 
 +
To contribute right away, pull the source from [http://bit.ly/securityShepherdGithub GitHub]
 +
 
 +
==Other==
 +
Both the Security Shepherd Platform and the Mobile Shepherd aspects of this project were initially created as part of BSc degrees in the Dublin Institute of Technology. Thanks to DIT for allowing those projects to be donated to the OWASP community.
 +
 
 +
=Setup Help=
 +
Use our [https://github.com/OWASP/SecurityShepherd/wiki Github Wiki page] for the best Setup Help going!
 +
 
 +
=Videos=
 +
{|
 +
|-
 +
{{#ev:youtube|uWk0NOSpyQc}}&nbsp;
 +
{{#ev:youtube|yppMkJRp4pk}}
 +
|}
 +
{|
 +
|-
 +
{{#ev:youtube|0jTWVLSGbPk}}&nbsp;
 +
{{#ev:youtube|sb8KQV6morY}}
 +
|}
 +
{|
 +
|-
 +
{{#ev:youtube|ZgqAXdwNeCI}}&nbsp;
 +
{{#ev:youtube|8mlY4ob757s}}
 +
|}
  
[[Category:OWASP Project|Security Shepherd Project]]
+
=Screenshots=
[[Category:OWASP Download]]
+
[[Image:Shepherd-Injection-Lesson.JPG|thumb|300px|left|Detailed vulnerability explainations]][[Image:Shepherd-Scoreboard.JPG|thumb|300px|left|Competitive Learning Environment]] [[Image:Shepherd-CTF-Level-One.JPG|thumb|300px|left|Easy configuration to suit every use]]
[[Category:OWASP Tool]]
 
[[Category:OWASP Release Quality Tool]]
 
  
__NOTOC__
+
__NOTOC__ <headertabs />
  
[[Category:OWASP Project]]
+
[[Category:OWASP Project]] 
 +
[[Category:OWASP_Builders]]
 +
[[Category:OWASP_Breakers]] 
 +
[[Category:OWASP_Tool]]

Latest revision as of 06:00, 15 October 2018

Flagship big.jpg

OWASP Security Shepherd

The OWASP Security Shepherd project is a web and mobile application security training platform. Security Shepherd has been designed to foster and improve security awareness among a varied skill-set demographic. The aim of this project is to take AppSec novices or experienced engineers and sharpen their penetration testing skillset to security expert status.

Description

The OWASP Security Shepherd project enables users to learn or to improve upon existing manual penetration testing skills. This is accomplished by presenting security risk concepts to users in lessons followed by challenges. A lesson provides a user with help in layman terms about a specific security risk, and helps them exploit a text book version of the issue. Challenges include poor security mitigations to vulnerabilities which have left room for users to exploit.

Utilizing the OWASP top ten as a challenge test bed, common security vulnerabilities can be explored and their impact on a system understood. The by-product of this challenge game is the acquired skill to harden a player's own environment from OWASP top ten security risks. The modules have been crafted to provide not only a challenge for a security novice, but security professionals as well.

Shepherd's security risks are delivered through hardened real vulnerabilities that can not be abused to compromise the application or its environment. Shepherd does not simulate security risks so that all and any attack vectors will work, ensuring a real world response.

Security Shepherd is highly configurable. System administrators can tune the project experience to present specific security risk topics or even specific Security Shepherd modules. The array of user and module configuration available allows Shepherd to be used by a single local user, by many in a competitive classroom environment or by hundreds in an online hacking competition.

Why use Security Shepherd?

Wide Topic Coverage: Shepherd includes more than seventy levels - across the entire spectrum of Web and mobile application security - within a single project.

Gentle Learning Curve: Shepherd is a perfect entry point for users completely new to security, with levels increasing in difficulty at a manageable pace.

Layman Write Ups: Each security concept, when first addressed in Shepherd, is presented using plain language, so it can be readily understood by beginners.

Real World Examples: The security risks in Shepherd are real vulnerabilities that have had their exploit impact dampened to protect the application, users and environment. There are no simulated security risks which require an expected, specific attack vector in order to pass a level. Attack vectors when used on Shepherd are how they would behave in the real world.

Scalability: Shepherd can be used locally by a single user or easily as a server for a high amount of users.

Highly Customisable: Shepherd enables admins to set what levels are available to their users and in what way they are presented (Open, CTF and Tournament Layouts)

Perfect for Classrooms: Shepherd gives its players user specific solution keys to prevent students from sharing keys, rather than going through the steps required to complete a level.

Scoreboard: Security Shepherd has a configurable scoreboard to encourage a competitive learning environment. Users that complete levels first, second and third get medals on their scoreboard entry and bonus points to keep things entertaining on the scoreboard.

User Management: Security Shepherd admins can create users, create admins, suspend, unsuspend, add bonus points or take penalty points away user accounts with the admin user management controls. Admins can also segment their students into specific class groups. Admins can view the progress a class has made to identify struggling participants. An admin can even close public registration and manually create users if they wish for a private experience.

Localisation Support: Security Shepherd material is available in multiple languages from a single instance. Students with alternative language preferences can compete in the same Shepherd instance as others without issue.

Robust Service: Shepherd has been used to run online CTFs such as the OWASP Global CTF and OWASP LATAM Tour CTF 2015, both surpassing 200 active users and running with no downtime, bar planned maintenance periods.

Configurable Feedback: An administrator can enable a feedback process, which must be completed by users before a level is marked as complete. This is used both to facilitate project improvements based on feedback submitted and for system administrators to collect "Reports of Understanding" from their students.

Granular Logging: The logs reported by Security Shepherd are highly detailed and descriptive, but not screen blinding. If a user is misbehaving, you will know.

Security Shepherd Road Map

Security Shepherd wants to be as highly usable as we can achieve. Our primary objective is currently to achieve full language localisation support for the entire application. Currently we have covered the main pages users would interact with. We actively need volunteers to take part in the translation process. If you are interested in getting involved please check out our GitHub Wiki describing How to Add a New Language to Security Shepherd.

Our long term goals are to cover as many web and mobile application security risks as possible. If you are interested in getting involved in adding levels to Security Shepherd, please check out our GitHub Wiki describing How to Make a Security Shepherd Level. For the Latest and Greatest short term goals. Please see the issues page in our GitHub.

What is Security Shepherd?

OWASP Security Shepherd provides:

  • Teaching Tool for All Application Security
  • Web Application Pen Testing Training
  • Mobile Application Pen Testing Training
  • Safe Playground to Practise AppSec Techniques
  • Real Security Risk Examples

Topic Coverage

The Security Shepherd project covers the following web and mobile application security topics;

Layout Options

An administrator user of Security Shepherd can change the layout in which the levels are presented to players. There are three options:

CTF Mode

When Shepherd has been deployed in the CTF mode, a user can only access one uncompleted module at a time. The first module presented to the user is the easiest in Security Shepherd, which has not been marked as closed by the administrator. The levels increase slowly in difficulty and jump from one topic to another. This layout is the recommended setting when using Security Shepherd for a competitive training scenario.

Open Floor

When Shepherd has been deployed in the Open Floor mode, a user can access any level that is marked as open by the admin. Modules are sorted into their Security Risk Categories, and the lessons are presented first. This layout is ideal for users wishing to explore security risks.

Tournament Mode

When Shepherd has been deployed in the Tournament Mode, a user can access any level that is marked as open by the admin. Modules are sorted into difficulty bands, from least to most difficult. This layout is ideal when Shepherd is being utilised as an open application security competition.

Download

Presentation

AppSecEU 2014 Video

AppSecEU 2014 Presentation

Project Leaders

Mark Denihan - mark.denihan@owasp.org

Sean Duggan - sean.duggan@owasp.org

Recent News and Events

  • [January 2017] Shepherd Graduates to Flagship

Related Projects

Licensing

The Security Shepherd project is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Security Shepherd project 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 General Public License for more details. See http://www.gnu.org/licenses/ .

Classifications

Owasp-flagship-trans-85.png Owasp-breakers-small.png
Owasp-builders-small.png
Project Type Files TOOL.jpg
Q Can I Re-Skin Shepherd and then Train People With it?
A Yes! Follow [this guide]!
Q Where can I access Security Shepherd?
A You can Download it and run it yourself or there are various public instances (eg: CTF365)
Q Where can I download Security Shepherd?
A You can download it from the [GitHub Release Page]
Q How can I run Shepherd on my network safely?
A just boot up the VM, install it manually or with Docker. The Security Shepherd application cannot be exploited to compromise the security of its environment. Make sure you patch your VM regularly to prevent intrusion to the host machine though.

Project Sponsors

The OWASP Security Shepherd project would like to acknowledge and thank the generous support of our sponsors. Please be certain to visit their websites and follow them on Twitter.

BccRiskAdvisoryLogo.jpg

EdgescanLogo.jpg

Manicode-logo.png

Axway logo.png

Contributors

OWASP Security Shepherd is developed by a worldwide team of volunteers. The primary contributors to date have been:

  • Mark Denihan
  • Sean Duggan
  • Paul McCann
  • John Clarke
  • Lei Shao
  • Natalia Lopez
  • Aidan Knowles
  • Jason Flood

The Security Shepherd template makes it extremely easy to add additional lessons. We are actively seeking developers to add new lessons as new web technologies emerge. If you are interested in volunteering for the project, or have a comment, question, or suggestion, please contact Mark.denihan@owasp.org

New levels or level ideas are wanted in the highest degree and there is development is in progress to fork the Security Shepherd platform into a CTF framework. If you wish to contribute a level or even an idea; contact Mark Denihan on mark.denihan@owasp.org. The aim of Security Shepherd's future development is to create a comprehensive platform for web and mobile application pen testing training / security risk education. Check out the project GitHub and find some issues that you can help with right away.

To contribute right away, pull the source from GitHub

Other

Both the Security Shepherd Platform and the Mobile Shepherd aspects of this project were initially created as part of BSc degrees in the Dublin Institute of Technology. Thanks to DIT for allowing those projects to be donated to the OWASP community.

Use our Github Wiki page for the best Setup Help going!

 
 
 
Detailed vulnerability explainations
Competitive Learning Environment
Easy configuration to suit every use