org.parosproxy.paros.extension.option.DatabaseParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zap Show documentation
The Zed Attack Proxy (ZAP) is an easy to use integrated penetration testing tool for finding vulnerabilities in web applications. It is designed to be used by people with a wide range of security experience and as such is ideal for developers and functional testers who are new to penetration testing. ZAP provides automated scanners as well as a set of tools that allow you to find security vulnerabilities manually.
The newest version!
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2012 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.parosproxy.paros.extension.option;

import org.parosproxy.paros.common.AbstractParam;

/**
 * Manages the database configurations saved in the configuration file.
 *
 * It allows to change, programmatically, the following database options:
 *
 * 

 *   Compact - allows the database to be compacted on exit.
 *   
Request Body Size - the size of the request body in the 'History' database table.
 *   
Response Body Size - the size of the response body in the 'History' database table.
 *   
Recovery Log - if the recovery log should be enabled (HSQLDB option only).
 * 
 */
public class DatabaseParam extends AbstractParam {

    public static final int NEW_SESSION_NOT_SPECIFIED = 0;
    public static final int NEW_SESSION_TIMESTAMPED = 1;
    public static final int NEW_SESSION_USER_SPECIFIED = 2;
    public static final int NEW_SESSION_TEMPORARY = 3;

    /**
     * The default size of request/response bodies.
     *
     * @since 2.14.0
     */
    public static final int DEFAULT_BODY_SIZE = 16777216;

    /** The base configuration key for all database configurations. */
    private static final String PARAM_BASE_KEY = "database";

    /** The configuration key for the compact option. */
    private static final String PARAM_COMPACT_DATABASE = PARAM_BASE_KEY + ".compact";

    /** The configuration key for the request body size. */
    private static final String PARAM_REQUEST_BODY_SIZE = PARAM_BASE_KEY + ".request.bodysize";

    /** The configuration key for the response body size. */
    private static final String PARAM_RESPONSE_BODY_SIZE = PARAM_BASE_KEY + ".response.bodysize";

    /** The configuration key for the new session option. */
    private static final String PARAM_NEW_SESSION_OPTION = PARAM_BASE_KEY + ".newsession";

    /** The configuration key for whether to prompt the user about the new session option. */
    private static final String PARAM_NEW_SESSION_PROMPT = PARAM_BASE_KEY + ".newsessionprompt";

    /** The configuration key for database's recovery log option. */
    private static final String PARAM_RECOVERY_LOG_ENABLED = PARAM_BASE_KEY + ".recoverylog";

    private static final boolean DEFAULT_COMPACT_DATABASE = false;
    private static final int DEFAULT_NEW_SESSION_OPTION = NEW_SESSION_NOT_SPECIFIED;
    private static final boolean DEFAULT_NEW_SESSION_PROMPT = true;
    private static final boolean DEFAULT_RECOVERY_LOG_ENABLED = true;

    /**
     * The compact option, whether the database should be compacted on exit. Default is {@code
     * false}.
     *
     * @see org.parosproxy.paros.db.Database#close(boolean)
     */
    private boolean compactDatabase;

    /** The request body size in the history table. Default is {@value #DEFAULT_BODY_SIZE}. */
    private int requestbodysize;

    /** The response body size in the history table. Default is {@value #DEFAULT_BODY_SIZE}. */
    private int responsebodysize;

    /**
     * The session option: 0: not specified 1: use timestamped session name 2: prompt user for
     * session name 3: temporary session name (not persisted)
     */
    private int newSessionOption;

    private boolean newSessionPrompt;

    /**
     * Flag used to indicate whether or not database's recovery log is enabled.
     *
     * Default is {@code true}.
     *
     * @see #isRecoveryLogEnabled()
     */
    private boolean recoveryLogEnabled;

    public DatabaseParam() {
        super();

        compactDatabase = DEFAULT_COMPACT_DATABASE;
        requestbodysize = DEFAULT_BODY_SIZE;
        responsebodysize = DEFAULT_BODY_SIZE;
        newSessionOption = DEFAULT_NEW_SESSION_OPTION;
        newSessionPrompt = DEFAULT_NEW_SESSION_PROMPT;
        recoveryLogEnabled = DEFAULT_RECOVERY_LOG_ENABLED;
    }

    /**
     * Parses the database options.
     *
     * 
The following database options are parsed:
     *
     * 

     *   Compact - allows the database to be compacted on exit.
     *   
Request Body Size - the size of the request body in the 'History' database table.
     *   
Response Body Size - the size of the response body in the 'History' database table.
     *   
Recovery Log - if the recovery log should be enabled (HSQLDB option only).
     * 
     */
    @Override
    protected void parse() {
        compactDatabase = getBoolean(PARAM_COMPACT_DATABASE, DEFAULT_COMPACT_DATABASE);
        requestbodysize = getInt(PARAM_REQUEST_BODY_SIZE, DEFAULT_BODY_SIZE);
        responsebodysize = getInt(PARAM_RESPONSE_BODY_SIZE, DEFAULT_BODY_SIZE);
        newSessionOption = getInt(PARAM_NEW_SESSION_OPTION, DEFAULT_NEW_SESSION_OPTION);
        newSessionPrompt = getBoolean(PARAM_NEW_SESSION_PROMPT, DEFAULT_NEW_SESSION_PROMPT);
        recoveryLogEnabled = getBoolean(PARAM_RECOVERY_LOG_ENABLED, DEFAULT_RECOVERY_LOG_ENABLED);
    }

    /**
     * Tells whether the database should be compacted on exit or not.
     *
     * @return {@code true} if the database should be compacted on exit, {@code false} otherwise
     * @see #setCompactDatabase(boolean)
     */
    public boolean isCompactDatabase() {
        return compactDatabase;
    }

    /**
     * Sets whether the database should be compacted on exit or not.
     *
     * @param compactDatabase {@code true} if the database should be compacted on exit, {@code
     *     false} otherwise
     * @see #isCompactDatabase()
     * @see org.parosproxy.paros.db.Database#close(boolean)
     */
    public void setCompactDatabase(boolean compactDatabase) {
        this.compactDatabase = compactDatabase;
        getConfig().setProperty(PARAM_COMPACT_DATABASE, compactDatabase);
    }

    /**
     * Gets the request body size
     *
     * @return the size of the request body, specified in bytes
     */
    public int getRequestBodySize() {
        return requestbodysize;
    }

    /**
     * Sets the request body size
     *
     * @param requestbodysize the request body size
     */
    public void setRequestBodySize(int requestbodysize) {
        this.requestbodysize = requestbodysize;
        getConfig().setProperty(PARAM_REQUEST_BODY_SIZE, requestbodysize);
    }

    /**
     * Gets the response body size
     *
     * @return the size of the response body, specified in bytes
     */
    public int getResponseBodySize() {
        return responsebodysize;
    }

    /**
     * Sets the response body size
     *
     * @param responsebodysize the response body size
     */
    public void setResponseBodySize(int responsebodysize) {
        this.responsebodysize = responsebodysize;
        getConfig().setProperty(PARAM_RESPONSE_BODY_SIZE, responsebodysize);
    }

    /**
     * Gets the new session option.
     *
     * @return the value of the new session option
     * @see #setNewSessionOption(int)
     */
    public int getNewSessionOption() {
        return newSessionOption;
    }

    /**
     * Sets the new session option.
     *
     * @param newSessionOption the value of the new session option
     * @see #getNewSessionOption()
     * @see #NEW_SESSION_NOT_SPECIFIED
     * @see #NEW_SESSION_TIMESTAMPED
     * @see #NEW_SESSION_USER_SPECIFIED
     * @see #NEW_SESSION_TEMPORARY
     */
    public void setNewSessionOption(int newSessionOption) {
        this.newSessionOption = newSessionOption;
        getConfig().setProperty(PARAM_NEW_SESSION_OPTION, newSessionOption);
    }

    public boolean isNewSessionPrompt() {
        return newSessionPrompt;
    }

    public void setNewSessionPrompt(boolean newSessionPrompt) {
        this.newSessionPrompt = newSessionPrompt;
        getConfig().setProperty(PARAM_NEW_SESSION_PROMPT, newSessionPrompt);
    }

    /**
     * Tells whether or not database's recovery log is enabled.
     *
     * @return {@code true} if database's recovery log is enabled, {@code false} otherwise
     * @see #setRecoveryLogEnabled(boolean)
     * @since 2.5.0
     */
    public boolean isRecoveryLogEnabled() {
        return recoveryLogEnabled;
    }

    /**
     * Sets whether or not database's recovery log is enabled.
     *
     * @param enabled {@code true} if database's recovery log should be enabled, {@code false}
     *     otherwise
     * @see #isRecoveryLogEnabled()
     * @since 2.5.0
     */
    public void setRecoveryLogEnabled(boolean enabled) {
        this.recoveryLogEnabled = enabled;
        getConfig().setProperty(PARAM_RECOVERY_LOG_ENABLED, recoveryLogEnabled);
    }
}