diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java b/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java index 0f94399fe..2c70201de 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/HammerHead.java @@ -412,6 +412,7 @@ public class HammerHead extends HttpServlet { * * @param s Description of the Parameter * @param screen a {@link org.owasp.webgoat.session.Screen} object. + * @param screen a {@link org.owasp.webgoat.session.Screen} object. * @param response Description of the Parameter * @exception IOException Description of the Exception * @throws java.io.IOException if any. diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java b/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java index b5385f9fd..270dc434e 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/application/WebGoatServletListener.java @@ -41,9 +41,7 @@ public class WebGoatServletListener implements ServletContextListener { private static final Logger logger = LoggerFactory.getLogger(HammerHead.class); - /** - * {@inheritDoc} - */ + /** {@inheritDoc} */ @Override public void contextInitialized(ServletContextEvent sce) { ServletContext context = sce.getServletContext(); @@ -80,9 +78,7 @@ public class WebGoatServletListener implements ServletContextListener { new PluginsLoader(Paths.get(pluginPath), Paths.get(targetPath)).loadPlugins(); } - /** - * {@inheritDoc} - */ + /** {@inheritDoc} */ @Override public void contextDestroyed(ServletContextEvent sce) { ServletContext context = sce.getServletContext(); diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java index 13c0ef809..5598af3b1 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/AbstractLesson.java @@ -233,6 +233,8 @@ public abstract class AbstractLesson extends Screen implements ComparablegetSubmitMethod

+ * + * @return a {@link java.lang.String} object. */ public abstract String getSubmitMethod(); @@ -647,12 +649,14 @@ public abstract class AbstractLesson extends Screen implements Comparable @@ -26,8 +27,10 @@ import java.lang.annotation.RetentionPolicy; * Source for this application is maintained at https://github.com/WebGoat/WebGoat, a repository for free software * projects. *

+ * * @author Nanne Baars - * @created December 12, 2015 + * @since December 12, 2015 + * @version $Id: $Id */ @Retention(RetentionPolicy.RUNTIME) public @interface LessonServletMapping { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/RandomLessonAdapter.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/RandomLessonAdapter.java index b72ee620c..97f222fb2 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/RandomLessonAdapter.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/RandomLessonAdapter.java @@ -14,6 +14,7 @@ import org.owasp.webgoat.session.WebSession; *

Abstract RandomLessonAdapter class.

* * @version $Id: $Id + * @author dm */ public abstract class RandomLessonAdapter extends LessonAdapter { @@ -30,6 +31,7 @@ public abstract class RandomLessonAdapter extends LessonAdapter * * @param s a {@link org.owasp.webgoat.session.WebSession} object. * @param stage a {@link java.lang.String} object. + * @param stage a {@link java.lang.String} object. */ public void setStage(WebSession s, String stage) { @@ -65,6 +67,7 @@ public abstract class RandomLessonAdapter extends LessonAdapter * * @param s a {@link org.owasp.webgoat.session.WebSession} object. * @param stage a {@link java.lang.String} object. + * @param stage a {@link java.lang.String} object. */ public void setStageComplete(WebSession s, String stage) { @@ -100,6 +103,7 @@ public abstract class RandomLessonAdapter extends LessonAdapter * * @param s a {@link org.owasp.webgoat.session.WebSession} object. * @param stage a {@link java.lang.String} object. + * @param stage a {@link java.lang.String} object. * @return a boolean. */ public boolean isStageComplete(WebSession s, String stage) diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/SequentialLessonAdapter.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/SequentialLessonAdapter.java index c2932a453..1053d212e 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/SequentialLessonAdapter.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/SequentialLessonAdapter.java @@ -13,6 +13,7 @@ import org.owasp.webgoat.session.WebSession; *

Abstract SequentialLessonAdapter class.

* * @version $Id: $Id + * @author dm */ public abstract class SequentialLessonAdapter extends LessonAdapter { @@ -22,6 +23,7 @@ public abstract class SequentialLessonAdapter extends LessonAdapter * * @param s a {@link org.owasp.webgoat.session.WebSession} object. * @param stage a int. + * @param stage a int. */ public void setStage(WebSession s, int stage) { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/admin/MenuToLessonMapperScreen.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/admin/MenuToLessonMapperScreen.java index 9ccd0e649..5a5085ef5 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/admin/MenuToLessonMapperScreen.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/admin/MenuToLessonMapperScreen.java @@ -84,7 +84,7 @@ public class MenuToLessonMapperScreen extends LessonAdapter /** *

getDefaultRanking.

* - * @return a {@link Integer} object. + * @return a {@link java.lang.Integer} object. */ protected Integer getDefaultRanking() { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/HttpBasicsModel.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/HttpBasicsModel.java index ac403c7e5..b7a66beef 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/HttpBasicsModel.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/HttpBasicsModel.java @@ -33,6 +33,7 @@ package org.owasp.webgoat.lessons.model; * use for more complex lessons. * * @version $Id: $Id + * @author dm */ public class HttpBasicsModel { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/LessonInfoModel.java b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/LessonInfoModel.java index 9f3ef5162..a08decbc6 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/LessonInfoModel.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/lessons/model/LessonInfoModel.java @@ -4,6 +4,12 @@ import org.owasp.webgoat.lessons.AbstractLesson; import org.owasp.webgoat.lessons.Category; import org.owasp.webgoat.session.WebSession; +/** + *

LessonInfoModel class.

+ * + * @author dm + * @version $Id: $Id + */ public class LessonInfoModel { private String lessonTitle; @@ -13,6 +19,11 @@ public class LessonInfoModel { private boolean hasPlan; private String submitMethod; + /** + *

Constructor for LessonInfoModel.

+ * + * @param webSession a {@link org.owasp.webgoat.session.WebSession} object. + */ public LessonInfoModel(WebSession webSession) { AbstractLesson lesson = webSession.getCurrentLesson(); //TODO make these first class citizens of the lesson itself; and stop passing the session all over ... and generally tighten the checks up @@ -36,26 +47,56 @@ public class LessonInfoModel { } // GETTERS + /** + *

Getter for the field lessonTitle.

+ * + * @return a {@link java.lang.String} object. + */ public String getLessonTitle() { return lessonTitle; } + /** + *

Getter for the field numberHints.

+ * + * @return a int. + */ public int getNumberHints() { return numberHints; } + /** + *

isHasSource.

+ * + * @return a boolean. + */ public boolean isHasSource() { return hasSource; } + /** + *

isHasSolution.

+ * + * @return a boolean. + */ public boolean isHasSolution() { return hasSolution; } + /** + *

isHasPlan.

+ * + * @return a boolean. + */ public boolean isHasPlan() { return hasPlan; } + /** + *

Getter for the field submitMethod.

+ * + * @return a {@link java.lang.String} object. + */ public String getSubmitMethod() { return submitMethod; } diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/Plugin.java b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/Plugin.java index 7cd012d05..7621e6338 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/Plugin.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/Plugin.java @@ -22,6 +22,7 @@ import static org.owasp.webgoat.plugins.PluginFileUtils.replaceInFiles; *

Plugin class.

* * @version $Id: $Id + * @author dm */ public class Plugin { @@ -34,6 +35,11 @@ public class Plugin { private List pluginFiles = Lists.newArrayList(); private File lessonSourceFile; + /** + *

findLesson.

+ * + * @param classes a {@link java.util.List} object. + */ public void findLesson(List classes) { for (String clazzName : classes) { findLesson(clazzName); @@ -56,6 +62,11 @@ public class Plugin { } } + /** + *

loadFiles.

+ * + * @param file a {@link java.nio.file.Path} object. + */ public void loadFiles(Path file) { if (fileEndsWith(file, ".html") && hasParentDirectoryWithName(file, NAME_LESSON_SOLUTION_DIRECTORY)) { solutionLanguageFiles.put(file.getParent().getFileName().toString(), file.toFile()); diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginExtractor.java b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginExtractor.java index 4f8497259..1d7b1cf24 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginExtractor.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginExtractor.java @@ -17,12 +17,23 @@ import java.util.zip.ZipFile; /** * Extract the jar file and place them in the system temp directory in the folder webgoat and collect the files * and classes. + * + * @author dm + * @version $Id: $Id */ public class PluginExtractor { private final List classes = Lists.newArrayList(); private final List files = new ArrayList<>(); + /** + *

extractJarFile.

+ * + * @param archive a {@link java.io.File} object. + * @param targetDirectory a {@link java.io.File} object. + * @return a {@link org.owasp.webgoat.plugins.Plugin} object. + * @throws java.io.IOException if any. + */ public Plugin extractJarFile(final File archive, final File targetDirectory) throws IOException { ZipFile zipFile = new ZipFile(archive); Plugin plugin = new Plugin(); @@ -88,11 +99,21 @@ public class PluginExtractor { return targetFile; } + /** + *

Getter for the field classes.

+ * + * @return a {@link java.util.List} object. + */ public List getClasses() { return this.classes; } + /** + *

Getter for the field files.

+ * + * @return a {@link java.util.List} object. + */ public List getFiles() { return this.files; } -} \ No newline at end of file +} diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java index 1d0ccdbc6..1b9cef313 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginFileUtils.java @@ -16,6 +16,7 @@ import java.util.Collection; *

PluginFileUtils class.

* * @version $Id: $Id + * @author dm */ public class PluginFileUtils { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginLoadingFailure.java b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginLoadingFailure.java index c47edf4dd..ec9104791 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginLoadingFailure.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginLoadingFailure.java @@ -4,6 +4,7 @@ package org.owasp.webgoat.plugins; *

PluginLoadingFailure class.

* * @version $Id: $Id + * @author dm */ public class PluginLoadingFailure extends RuntimeException { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginsLoader.java b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginsLoader.java index f886ef03a..1d9731bb0 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginsLoader.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/plugins/PluginsLoader.java @@ -27,6 +27,7 @@ import java.util.concurrent.Executors; *

PluginsLoader class.

* * @version $Id: $Id + * @author dm */ public class PluginsLoader { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/service/LabelDebugService.java b/webgoat-container/src/main/java/org/owasp/webgoat/service/LabelDebugService.java index 9a7ab755a..d73f7e274 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/service/LabelDebugService.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/service/LabelDebugService.java @@ -55,6 +55,8 @@ public class LabelDebugService extends BaseService { /** * Reload all the plugins + * + * @return a {@link org.springframework.http.ResponseEntity} object. */ @RequestMapping(value = "/debug/labels.mvc") public @ResponseBody diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonInfoService.java b/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonInfoService.java index d23e70254..b334c4720 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonInfoService.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonInfoService.java @@ -16,10 +16,22 @@ import org.springframework.web.bind.annotation.ResponseStatus; import javax.servlet.http.HttpSession; @Controller +/** + *

LessonInfoService class.

+ * + * @author dm + * @version $Id: $Id + */ public class LessonInfoService extends BaseService { private static final Logger logger = LoggerFactory.getLogger(LessonMenuService.class); + /** + *

getLessonInfo.

+ * + * @param session a {@link javax.servlet.http.HttpSession} object. + * @return a {@link org.owasp.webgoat.lessons.model.LessonInfoModel} object. + */ @RequestMapping(value = "/lessoninfo.mvc", produces = "application/json") public @ResponseBody LessonInfoModel getLessonInfo(HttpSession session) { @@ -27,6 +39,12 @@ public class LessonInfoService extends BaseService { return new LessonInfoModel(webSession); } + /** + *

handleException.

+ * + * @param ex a {@link java.lang.Exception} object. + * @return a {@link java.lang.String} object. + */ @ExceptionHandler(Exception.class) @ResponseBody @ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR) @@ -34,6 +52,12 @@ public class LessonInfoService extends BaseService { return "An error occurred retrieving the LessonInfoModel:" + ex.getMessage(); } + /** + *

getLessonInfoModel.

+ * + * @param webSession a {@link org.owasp.webgoat.session.WebSession} object. + * @return a {@link org.owasp.webgoat.lessons.model.LessonInfoModel} object. + */ protected LessonInfoModel getLessonInfoModel(WebSession webSession) { return new LessonInfoModel(webSession); } diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonTitleService.java b/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonTitleService.java index 67508fed5..3c58a0efc 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonTitleService.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/service/LessonTitleService.java @@ -14,6 +14,7 @@ import org.springframework.web.bind.annotation.ResponseBody; *

LessonTitleService class.

* * @version $Id: $Id + * @author dm */ public class LessonTitleService extends BaseService { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/service/PluginReloadService.java b/webgoat-container/src/main/java/org/owasp/webgoat/service/PluginReloadService.java index 9d5b7c972..64e8fc50e 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/service/PluginReloadService.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/service/PluginReloadService.java @@ -56,7 +56,8 @@ public class PluginReloadService extends BaseService { /** * Reload all the plugins * - * @param session a {@link HttpSession} object. + * @param session a {@link javax.servlet.http.HttpSession} object. + * @return a {@link org.springframework.http.ResponseEntity} object. */ @RequestMapping(value = "/reloadplugins.mvc") public @ResponseBody diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/servlets/Controller.java b/webgoat-container/src/main/java/org/owasp/webgoat/servlets/Controller.java index 357003667..9cd7f284e 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/servlets/Controller.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/servlets/Controller.java @@ -35,6 +35,7 @@ import javax.servlet.http.HttpServletResponse; * for free software projects. * * @version $Id: $Id + * @author dm */ public class Controller extends HttpServlet { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/session/Authorization.java b/webgoat-container/src/main/java/org/owasp/webgoat/session/Authorization.java index 8edd15936..36c8c3a67 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/session/Authorization.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/session/Authorization.java @@ -32,6 +32,9 @@ import java.util.Map; * projects. * * * @version $Id: $Id + * + * @author dm + * @version $Id: $Id */ public class Authorization { diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/session/Course.java b/webgoat-container/src/main/java/org/owasp/webgoat/session/Course.java index b3d98dbeb..2e27378d0 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/session/Course.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/session/Course.java @@ -322,6 +322,11 @@ public class Course { return null; } + /** + *

loadLessonFromPlugin.

+ * + * @param context a {@link javax.servlet.ServletContext} object. + */ public void loadLessonFromPlugin(ServletContext context) { logger.debug("Loading plugins into cache"); String pluginPath = context.getRealPath("plugin_lessons"); diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/session/DatabaseUtilities.java b/webgoat-container/src/main/java/org/owasp/webgoat/session/DatabaseUtilities.java index 0be0392d7..391baec5c 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/session/DatabaseUtilities.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/session/DatabaseUtilities.java @@ -141,6 +141,14 @@ public class DatabaseUtilities * Description of the Parameter * @param resultsMetaData * Description of the Parameter + * @param resultsMetaData + * Description of the Parameter + * @param resultsMetaData + * Description of the Parameter + * @param resultsMetaData + * Description of the Parameter + * @param resultsMetaData + * Description of the Parameter * @return Description of the Return Value * @exception IOException * Description of the Exception diff --git a/webgoat-container/src/main/java/org/owasp/webgoat/session/ECSFactory.java b/webgoat-container/src/main/java/org/owasp/webgoat/session/ECSFactory.java index 1289b0536..e3f85f263 100644 --- a/webgoat-container/src/main/java/org/owasp/webgoat/session/ECSFactory.java +++ b/webgoat-container/src/main/java/org/owasp/webgoat/session/ECSFactory.java @@ -560,6 +560,12 @@ public class ECSFactory * Description of the Parameter * @param selected * Description of the Parameter + * @param selected + * Description of the Parameter + * @param selected + * Description of the Parameter + * @param selected + * Description of the Parameter * @param name * Description of the Parameter * @param options @@ -568,6 +574,8 @@ public class ECSFactory * Description of the Parameter * @param selected * Description of the Parameter + * @param selected + * Description of the Parameter * @return Description of the Return Value */ public static Element makeSelect(boolean diffNames, Select select, String name, Vector