From af26543cf2626d9ee8f5bda727301b6d6bd0af86 Mon Sep 17 00:00:00 2001 From: Jeff Date: Fri, 24 Apr 2015 14:55:25 -0400 Subject: [PATCH] WEB-204 updated readme with MD syntax. Removed .txt file. Conflicts: README.txt --- README.MD | 86 +++++++++++++++++++++++++++++++++++++++++ README.txt | 110 ----------------------------------------------------- 2 files changed, 86 insertions(+), 110 deletions(-) create mode 100644 README.MD delete mode 100644 README.txt diff --git a/README.MD b/README.MD new file mode 100644 index 000000000..9aac56d44 --- /dev/null +++ b/README.MD @@ -0,0 +1,86 @@ +# Important Information + +Thank you for downloading WebGoat! + +This program is a demonstration of common server-side application flaws. The +exercises are intended to be used by people to learn about application +penetration testing techniques. + +* [Home Page:](http://webgoat.github.io) +* [OWASP Project Home Page:](http://www.owasp.org/index.php/Category:OWASP_WebGoat_Project) +* [Source Code:](https://github.com/WebGoat/WebGoat) +* [Easy-Run Download:](https://webgoat.atlassian.net/builds/browse/WEB-DAIL/latestSuccessful/artifact/JOB1/WebGoat-Embedded-Tomcat/WebGoat-6.0-SNAPSHOT-war-exec.jar ) +* [User Guide:](http://www.owasp.org/index.php/WebGoat_User_and_Install_Guide_Table_of_Contents) +* [Wiki:](http://code.google.com/p/webgoat/w/list) +* [FAQ:](http://code.google.com/p/webgoat/wiki/FAQ) +* [Contact Info:](webgoat@owasp.org (Direct to Bruce Mayhew) +* [Mailing List - WebGoat Community - For most questions:](owasp-webgoat@lists.owasp.org) + +**WARNING 1:** *While running this program your machine will be extremely +vulnerable to attack. You should to disconnect from the Internet while using +this program.* + +**WARNING 2:** *This program is for educational purposes only. If you attempt +these techniques without authorization, you are very likely to get caught. If +you are caught engaging in unauthorized hacking, most companies will fire you. +Claiming that you were doing security research will not work as that is the +first thing that all hackers claim.* + +You can find more information about WebGoat at: +(https://github.com/WebGoat/) + + +# Easy Run Instructions ( For non-developers ) + +Follow these instructions if you simply wish to run WebGoat + +**Prerequisites:** + +Java VM >= 1.6 installed ( JDK 1.7 recommended) + +1. Download the executable jar file to any location of your choice: + + (https://webgoat.atlassian.net/builds/browse/WEB-WGM/latestSuccessful/artifact/shared/WebGoat-Embedded-Tomcat/WebGoat-6.0.1-war-exec.jar) + +2. Run it using java: + + > java -jar WebGoat-6.0-exec-war.jar + +3. Then navigate in your browser to: (http://localhost:8080/WebGoat) + +4. If you would like to change the port or other options, use: + + > java -jar WebGoat-6.0-exec-war.jar --help + + +# Standard Run Instructions (For Developers) + +Follow These instructions if you wish to run Webgoat and modify the source code +as well. + +**Prerequisites:** + +* Java >= 1.6 ( JDK 1.7 recommended ) +* Maven > 2.0.9 +* Your favorite IDE, with Maven awareness: Netbeans/IntelliJ/Eclipse with m2e + installed. If you are setting up an IDE, Netbeans 8.0 contains the Maven and + Git support you need: (https://netbeans.org/downloads/) +* Git, or Git support in your IDE + +**Note:** WebGoat source code can be downloaded at: (https://github.com/WebGoat/WebGoat). + + +1. Building the project (Developers) using a command shell/window: + + > cd webgoat + > mvn clean package + +2. After opening the project in Netbeans or Eclipse, you can easily run the +project using maven: + + > mvn tomcat:run-war + +3. Maven will run the project in an embedded tomcat. The package phase also builds an executable jar file. You can run it using: + + > cd target + > java -jar WebGoat-6.0-exec-war.jar http://localhost:8080/WebGoat diff --git a/README.txt b/README.txt deleted file mode 100644 index 827c121af..000000000 --- a/README.txt +++ /dev/null @@ -1,110 +0,0 @@ -********** -********** WebGoat 6.0 -********** August 23, 2014 -********** -** -** Home Page: http://webgoat.github.io -** Home Page: http://www.owasp.org/index.php/Category:OWASP_WebGoat_Project -** Source Code: https://github.com/WebGoat/WebGoat -** Easy-Run Download: https://webgoat.atlassian.net/builds/browse/WEB-DAIL/latestSuccessful/artifact/JOB1/WebGoat-Embedded-Tomcat/WebGoat-6.0-SNAPSHOT-war-exec.jar -** User Guide: http://www.owasp.org/index.php/WebGoat_User_and_Install_Guide_Table_of_Contents -** Wiki: http://code.google.com/p/webgoat/w/list -** FAQ: http://code.google.com/p/webgoat/wiki/FAQ -** Contact Info: webgoat@owasp.org (Direct to Bruce Mayhew) -** Mailing List: owasp-webgoat@lists.owasp.org (WebGoat Community - For most questions) -** -********** - -Thank you for downloading WebGoat! - -This program is a demonstration of common server-side -application flaws. The exercises are intended to -be used by people to learn about application penetration -testing techniques. - - -WARNING 1: While running this program your machine will be -extremely vulnerable to attack. You should to disconnect -from the Internet while using this program. - -WARNING 2: This program is for educational purposes only. If you -attempt these techniques without authorization, you are very -likely to get caught. If you are caught engaging in unauthorized -hacking, most companies will fire you. Claiming that you were -doing security research will not work as that is the first thing -that all hackers claim. - -You can find more information about WebGoat at: -https://github.com/WebGoat/ - ----------------------------------------------------------------------------------------- -Easy Run Instructions ( For non-developers ) ----------------------------------------------------------------------------------------- -Follow these instructions if you simply wish to run WebGoat - - Prerequisites: Java VM >= 1.6 installed ( JDK 1.7 recommended) - Download the executable jar file to any location of your choice from: -https://webgoat.atlassian.net/builds/browse/WEB-WGM/latestSuccessful/artifact/shared/WebGoat-Embedded-Tomcat/WebGoat-6.0.1-war-exec.jar - Run it using java: - java -jar WebGoat-6.0-exec-war.jar - - Then navigate in your browser to: - http://localhost:8080/WebGoat - - If you would like to change the port or other options, use: - java -jar WebGoat-6.0-exec-war.jar --help - ----------------------------------------------------------------------------------------- -For Developers ----------------------------------------------------------------------------------------- -Follow These instructions if you wish to run Webgoat and modify the source code as well. - - Prerequisites: - * Java >= 1.6 ( JDK 1.7 recommended ) - * Maven > 2.0.9 - *Your favorite IDE, with Maven awareness: Netbeans/IntelliJ/Eclipse with m2e installed - * Git, or Git support in your IDE - - WebGoat source code - WebGoat source code can be downloaded at: - https://github.com/WebGoat/WebGoat - - If you are setting up an IDE, Netbeans 8.0 contains the Maven and Git support you need: - https://netbeans.org/downloads/ - ---------------------------------- -Building the project (Developers) ---------------------------------- - -Using a command shell/window: - -> cd webgoat-classloader -> mvn clean install -> cd .. -> mvn clean package - -Building the webgoat-classloader is only necessary once, the classloader needs to be present in your local repository. -After opening the project in Netbeans or Eclipse, you can easily run the project using: - -1. Maven-Tomcat Plugin -Using a command shell/window: - -> mvn tomcat:run-war - -Maven will run the project in an embedded tomcat. - - -2. Java JAR -the package phase also builds an executable jar file. You can run it using: -cd target -java -jar WebGoat-6.0-exec-war.jar -http://localhost:8080/WebGoat - - -3. Tomcat -the package phase also builds a war file. You can deploy it using: -cp target/WebGoat-6.0-exec-war.war /webapps/ -Then also clone https://github.com/WebGoat/WebGoat-Lessons run: -cd WebGoat-Lessons -mvn package -cp plugins/* /webapps/WebGoat-6.0-exec-war/plugin_lessons/