org.owasp.webgoat.session.WebgoatContext Maven / Gradle / Ivy
package org.owasp.webgoat.session;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.servlet.http.HttpServlet;
/**
* WebgoatContext class.
*
* @version $Id: $Id
* @author dm
*/
public class WebgoatContext {
final Logger logger = LoggerFactory.getLogger(WebgoatContext.class);
/** Constant DATABASE_CONNECTION_STRING="DatabaseConnectionString" */
public final static String DATABASE_CONNECTION_STRING = "DatabaseConnectionString";
/** Constant DATABASE_DRIVER="DatabaseDriver" */
public final static String DATABASE_DRIVER = "DatabaseDriver";
/** Constant DATABASE_USER="DatabaseUser" */
public final static String DATABASE_USER = "DatabaseUser";
/** Constant DATABASE_PASSWORD="DatabasePassword" */
public final static String DATABASE_PASSWORD = "DatabasePassword";
/** Constant ENTERPRISE="Enterprise" */
public final static String ENTERPRISE = "Enterprise";
/** Constant CODING_EXERCISES="CodingExercises" */
public final static String CODING_EXERCISES = "CodingExercises";
/** Constant SHOWCOOKIES="ShowCookies" */
public final static String SHOWCOOKIES = "ShowCookies";
/** Constant SHOWPARAMS="ShowParams" */
public final static String SHOWPARAMS = "ShowParams";
/** Constant SHOWREQUEST="ShowRequest" */
public final static String SHOWREQUEST = "ShowRequest";
/** Constant SHOWSOURCE="ShowSource" */
public final static String SHOWSOURCE = "ShowSource";
/** Constant SHOWSOLUTION="ShowSolution" */
public final static String SHOWSOLUTION = "ShowSolution";
/** Constant SHOWHINTS="ShowHints" */
public final static String SHOWHINTS = "ShowHints";
/** Constant DEFUSEOSCOMMANDS="DefuseOSCommands" */
public final static String DEFUSEOSCOMMANDS = "DefuseOSCommands";
/** Constant FEEDBACK_ADDRESS_HTML="FeedbackAddressHTML" */
public final static String FEEDBACK_ADDRESS_HTML = "FeedbackAddressHTML";
/** Constant FEEDBACK_ADDRESS="email" */
public final static String FEEDBACK_ADDRESS = "email";
/** Constant DEBUG="debug" */
public final static String DEBUG = "debug";
/** Constant DEFAULTLANGUAGE="DefaultLanguage" */
public final static String DEFAULTLANGUAGE = "DefaultLanguage";
private String databaseConnectionString;
private String realConnectionString = null;
private String databaseDriver;
private String databaseUser;
private String databasePassword;
private boolean showCookies = false;
private boolean showParams = false;
private boolean showRequest = false;
private boolean showSource = false;
private boolean showSolution = false;
private boolean defuseOSCommands = false;
private boolean enterprise = false;
private boolean codingExercises = false;
private String feedbackAddress = "[email protected]";
private String feedbackAddressHTML = "[email protected]";
private boolean isDebug = false;
private String servletName;
private HttpServlet servlet;
private String defaultLanguage;
private java.nio.file.Path pluginDirectory;
/**
* Constructor for WebgoatContext.
*
* @param servlet a {@link javax.servlet.http.HttpServlet} object.
*/
public WebgoatContext(HttpServlet servlet) {
this.servlet = servlet;
databaseConnectionString = getParameter(servlet, DATABASE_CONNECTION_STRING);
databaseDriver = getParameter(servlet, DATABASE_DRIVER);
databaseUser = getParameter(servlet, DATABASE_USER);
databasePassword = getParameter(servlet, DATABASE_PASSWORD);
// initialize from web.xml
showParams = "true".equals(getParameter(servlet, SHOWPARAMS));
showCookies = "true".equals(getParameter(servlet, SHOWCOOKIES));
showSource = "true".equals(getParameter(servlet, SHOWSOURCE));
showSolution = "true".equals(getParameter(servlet, SHOWSOLUTION));
defuseOSCommands = "true".equals(getParameter(servlet, DEFUSEOSCOMMANDS));
enterprise = "true".equals(getParameter(servlet, ENTERPRISE));
codingExercises = "true".equals(getParameter(servlet, CODING_EXERCISES));
feedbackAddressHTML = getParameter(servlet, FEEDBACK_ADDRESS_HTML) != null ? getParameter(servlet,
FEEDBACK_ADDRESS_HTML)
: feedbackAddressHTML;
feedbackAddress = getParameter(servlet, FEEDBACK_ADDRESS) != null ? getParameter(servlet, FEEDBACK_ADDRESS)
: feedbackAddress;
showRequest = "true".equals(getParameter(servlet, SHOWREQUEST));
isDebug = "true".equals(getParameter(servlet, DEBUG));
servletName = servlet.getServletName();
defaultLanguage = getParameter(servlet, DEFAULTLANGUAGE) != null ? new String(getParameter(servlet, DEFAULTLANGUAGE)) : new String("en");
}
private String getParameter(HttpServlet servlet, String key) {
String value = System.getenv().get(key);
if (value == null) {
value = servlet.getInitParameter(key);
}
return value;
}
/**
* returns the connection string with the real path to the database
* directory inserted at the word PATH
*
* @return The databaseConnectionString value
*/
public String getDatabaseConnectionString() {
if (realConnectionString == null) {
try {
String path = servlet.getServletContext().getRealPath("/database").replace('\\', '/');
System.out.println("PATH: " + path);
realConnectionString = databaseConnectionString.replaceAll("PATH", path);
System.out.println("Database Connection String: " + realConnectionString);
} catch (Exception e) {
logger.error("Couldn't open database: check web.xml database parameters", e);
}
}
return realConnectionString;
}
/**
* Gets the databaseDriver attribute of the WebSession object
*
* @return The databaseDriver value
*/
public String getDatabaseDriver() {
return (databaseDriver);
}
/**
* Gets the databaseUser attribute of the WebSession object
*
* @return The databaseUser value
*/
public String getDatabaseUser() {
return (databaseUser);
}
/**
* Gets the databasePassword attribute of the WebSession object
*
* @return The databasePassword value
*/
public String getDatabasePassword() {
return (databasePassword);
}
/**
* isDefuseOSCommands.
*
* @return a boolean.
*/
public boolean isDefuseOSCommands() {
return defuseOSCommands;
}
/**
* isEnterprise.
*
* @return a boolean.
*/
public boolean isEnterprise() {
return enterprise;
}
/**
* isCodingExercises.
*
* @return a boolean.
*/
public boolean isCodingExercises() {
return codingExercises;
}
/**
* Getter for the field feedbackAddress.
*
* @return a {@link java.lang.String} object.
*/
public String getFeedbackAddress() {
return feedbackAddress;
}
/**
* Getter for the field feedbackAddressHTML.
*
* @return a {@link java.lang.String} object.
*/
public String getFeedbackAddressHTML() {
return feedbackAddressHTML;
}
/**
* isDebug.
*
* @return a boolean.
*/
public boolean isDebug() {
return isDebug;
}
/**
* Getter for the field servletName.
*
* @return a {@link java.lang.String} object.
*/
public String getServletName() {
return servletName;
}
/**
* isShowCookies.
*
* @return a boolean.
*/
public boolean isShowCookies() {
return showCookies;
}
/**
* isShowParams.
*
* @return a boolean.
*/
public boolean isShowParams() {
return showParams;
}
/**
* isShowRequest.
*
* @return a boolean.
*/
public boolean isShowRequest() {
return showRequest;
}
/**
* isShowSource.
*
* @return a boolean.
*/
public boolean isShowSource() {
return showSource;
}
/**
* isShowSolution.
*
* @return a boolean.
*/
public boolean isShowSolution() {
return showSolution;
}
/**
* Getter for the field defaultLanguage.
*
* @return a {@link java.lang.String} object.
*/
public String getDefaultLanguage() {
return defaultLanguage;
}
}