• Home
• org.zaproxy
• zap
• 2.15.0
• source code
• Proxy.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.parosproxy.paros.control.Proxy Maven / Gradle / Ivy

/*
 * Created on May 30, 2004
 *
 * Paros and its related class files.
 *
 * Paros is an HTTP/HTTPS proxy for assessing web application security.
 * Copyright (C) 2003-2004 Chinotec Technologies Company
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Clarified Artistic License
 * as published by the Free Software Foundation.
 *
 * This program 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
 * Clarified Artistic License for more details.
 *
 * You should have received a copy of the Clarified Artistic License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
// ZAP: 2011/05/15 Support for exclusions
// ZAP: 2012/11/01 Issue 411: Allow proxy port to be specified on the command line
// ZAP: 2012/12/27 Added method addPersistentConnectionListener(...)
// ZAP: 2013/01/25 Added method removeProxyListener()
// ZAP: 2013/08/30 Issue 775: Allow host to be set via the command line
// ZAP: 2014/03/23 Issue 1022: Proxy - Allow to override a proxied message
// ZAP: 2015/01/04 Issue 1387: Unable to change the proxy's port/address if the port/address was
// specified through the command line
// ZAP: 2015/11/04 Issue 1920: Report the host:port ZAP is listening on in daemon mode, or exit if
// it cant
// ZAP: 2016/05/30 Issue 2494: ZAP Proxy is not showing the HTTP CONNECT Request in history tab
// ZAP: 2017/03/15 Enable API
// ZAP: 2017/11/06 Removed ProxyServerSSL (Issue 3983)
// ZAP: 2019/06/01 Normalise line endings.
// ZAP: 2019/06/05 Normalise format/style.
// ZAP: 2019/09/17 Remove irrelevant conditional in stopServer().
// ZAP: 2019/12/13 Save the proxy port if it had to be selected during startup (Issue 2016).
// ZAP: 2022/02/09 Deprecate the class.
package org.parosproxy.paros.control;

import java.util.List;
import org.parosproxy.paros.core.proxy.ConnectRequestProxyListener;
import org.parosproxy.paros.core.proxy.OverrideMessageProxyListener;
import org.parosproxy.paros.core.proxy.ProxyListener;
import org.parosproxy.paros.model.Model;
import org.zaproxy.zap.PersistentConnectionListener;
import org.zaproxy.zap.control.ControlOverrides;

/**
 * @deprecated (2.12.0) No longer used/needed by core. Use the network add-on instead.
 */
@Deprecated
public class Proxy {

    private Model model = null;
    private org.parosproxy.paros.core.proxy.ProxyServer proxyServer = null;
    private boolean reverseProxy = false;
    private String reverseProxyHost = "";
    private ControlOverrides overrides = null;

    public Proxy(Model model, ControlOverrides overrides) {

        this.model = model;
        this.overrides = overrides;

        proxyServer = new org.parosproxy.paros.core.proxy.ProxyServer();
        proxyServer.setEnableApi(true);
    }

    public boolean startServer() {

        // setProxyParam put in here so restart can reread param.
        proxyServer.setProxyParam(model.getOptionsParam().getProxyParam());
        proxyServer.setConnectionParam(model.getOptionsParam().getConnectionParam());

        if (model.getOptionsParam().getProxyParam().isUseReverseProxy()) {

            proxyServer.startServer(
                    model.getOptionsParam().getProxyParam().getReverseProxyIp(),
                    model.getOptionsParam().getProxyParam().getReverseProxyHttpPort(),
                    false);

        } else {

            String proxyHost = null;
            int proxyPort = -1;
            if (this.overrides != null) {
                proxyHost = this.overrides.getProxyHost();
                proxyPort = this.overrides.getProxyPort();
                // Use overrides once.
                overrides = null;
            }
            if (proxyHost != null) {
                // Save the override in the configs
                model.getOptionsParam().getProxyParam().setProxyIp(proxyHost);
            } else {
                // ZAP: get the proxy IP as set without any check for nullable
                proxyHost = model.getOptionsParam().getProxyParam().getRawProxyIP();
            }
            if (proxyPort > 0) {
                // Save the override in the configs
                model.getOptionsParam().getProxyParam().setProxyPort(proxyPort);
            } else {
                proxyPort = model.getOptionsParam().getProxyParam().getProxyPort();
            }

            int pPort = proxyServer.startServer(proxyHost, proxyPort, false);
            if (pPort == -1) {
                return false;
            } else {
                model.getOptionsParam().getProxyParam().setProxyPort(pPort);
            }
        }
        return true;
    }

    public void stopServer() {
        proxyServer.stopServer();
    }

    public void setSerialize(boolean serialize) {
        proxyServer.setSerialize(serialize);
    }

    public void addProxyListener(ProxyListener listener) {
        proxyServer.addProxyListener(listener);
    }

    public void removeProxyListener(ProxyListener listener) {
        proxyServer.removeProxyListener(listener);
    }

    public void addOverrideMessageProxyListener(OverrideMessageProxyListener listener) {
        proxyServer.addOverrideMessageProxyListener(listener);
    }

    public void removeOverrideMessageProxyListener(OverrideMessageProxyListener listener) {
        proxyServer.removeOverrideMessageProxyListener(listener);
    }

    public void addPersistentConnectionListener(PersistentConnectionListener listener) {
        proxyServer.addPersistentConnectionListener(listener);
    }

    public void removePersistentConnectionListener(PersistentConnectionListener listener) {
        proxyServer.removePersistentConnectionListener(listener);
    }

    /**
     * Adds the given {@code listener}, that will be notified of the received CONNECT requests.
     *
     * @param listener the listener that will be added
     * @throws IllegalArgumentException if the given {@code listener} is {@code null}.
     * @since 2.5.0
     */
    public void addConnectRequestProxyListener(ConnectRequestProxyListener listener) {
        validateListenerNotNull(listener);
        proxyServer.addConnectRequestProxyListener(listener);
    }

    /**
     * Validates that the given {@code listener} is not {@code null}, throwing an {@code
     * IllegalArgumentException} if it is.
     *
     * @param listener the listener that will be validated
     * @throws IllegalArgumentException if the given {@code listener} is {@code null}.
     */
    private static void validateListenerNotNull(Object listener) {
        if (listener == null) {
            throw new IllegalArgumentException("Parameter listener must not be null.");
        }
    }

    /**
     * Removes the given {@code listener}, to no longer be notified of the received CONNECT
     * requests.
     *
     * @param listener the listener that should be removed
     * @throws IllegalArgumentException if the given {@code listener} is {@code null}.
     * @since 2.5.0
     */
    public void removeConnectRequestProxyListener(ConnectRequestProxyListener listener) {
        validateListenerNotNull(listener);
        proxyServer.removeConnectRequestProxyListener(listener);
    }

    /**
     * @return Returns the reverseProxy.
     */
    public boolean isReverseProxy() {
        return reverseProxy;
    }

    /**
     * @param reverseProxy The reverseProxy to set.
     */
    public void setReverseProxy(boolean reverseProxy) {
        this.reverseProxy = reverseProxy;
    }

    /**
     * @return Returns the reverseProxyHost.
     */
    public String getReverseProxyHost() {
        return reverseProxyHost;
    }

    /**
     * @param reverseProxyHost The reverseProxyHost to set.
     */
    public void setReverseProxyHost(String reverseProxyHost) {
        this.reverseProxyHost = reverseProxyHost;
    }

    /**
     * @param enableCacheProcessing The enableCacheProcessing to set.
     */
    public void setEnableCacheProcessing(boolean enableCacheProcessing) {
        if (proxyServer != null) {
            proxyServer.setEnableCacheProcessing(enableCacheProcessing);
        }
    }

    public void addCacheProcessingList(org.parosproxy.paros.core.proxy.CacheProcessingItem item) {
        if (proxyServer != null) {
            proxyServer.addCacheProcessingList(item);
        }
    }

    public void setIgnoreList(List urls) {
        if (proxyServer != null) {
            proxyServer.setExcludeList(urls);
        }
    }

    /**
     * Sets whether or not the {@code ProxyServer} should prompt the user for an alternate port when
     * there is a conflict.
     *
     * @param shouldPrompt {@code true} if the user should be prompted, {@code false} otherwise
     * @since 2.9.0
     */
    public void setShouldPrompt(boolean shouldPrompt) {
        this.proxyServer.setShouldPrompt(shouldPrompt);
    }
}