org.zaproxy.zap.spider.filters.MaxChildrenParseFilter Maven / Gradle / Ivy

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.

There is a newer version: 2.15.0

Show newest version

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2014 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.zaproxy.zap.spider.filters;

import java.util.Collections;
import java.util.Enumeration;
import java.util.ResourceBundle;
import org.parosproxy.paros.model.Model;
import org.parosproxy.paros.model.SiteNode;
import org.parosproxy.paros.network.HttpMessage;

/**
 * The MaxChildrenFetchFilter defines a filter rule for limiting the number of children explored.
 */
public class MaxChildrenParseFilter extends ParseFilter {

    private int maxChildren = -1;

    private Model model;

    private final FilterResult filtered;

    /**
     * Constructs a {@code MaxChildrenParseFilter}, with no reason of why the message was filtered.
     *
     * @deprecated (2.7.0) Use {@link #MaxChildrenParseFilter(ResourceBundle)} instead.
     */
    @Deprecated
    public MaxChildrenParseFilter() {
        this(
                new ResourceBundle() {

                    @Override
                    public Enumeration getKeys() {
                        return Collections.emptyEnumeration();
                    }

                    @Override
                    protected Object handleGetObject(String key) {
                        return "";
                    }
                });
    }

    /**
     * Constructs a {@code MaxChildrenParseFilter} with the given resource bundle.
     *
     * The resource bundle is used to obtain the (internationalised) reason of why the message
     * was filtered.
     *
     * @param resourceBundle the resource bundle to obtain the internationalised reason.
     * @throws IllegalArgumentException if the given parameter is {@code null}.
     * @since 2.7.0
     */
    public MaxChildrenParseFilter(ResourceBundle resourceBundle) {
        if (resourceBundle == null) {
            throw new IllegalArgumentException("Parameter resourceBundle must not be null.");
        }
        filtered =
                new FilterResult(resourceBundle.getString("spider.parsefilter.reason.maxchildren"));
    }

    @Override
    public FilterResult filtered(HttpMessage responseMessage) {

        SiteNode parent = model.getSession().getSiteTree().findClosestParent(responseMessage);
        if (parent != null) {
            if (maxChildren > 0 && parent.getChildCount() > maxChildren) {
                return filtered;
            }
        }

        return FilterResult.NOT_FILTERED;
    }

    public void setMaxChildren(int maxChildren) {
        this.maxChildren = maxChildren;
    }

    /**
     * Sets the model
     *
     * @param model the model used to check the number of children of a node
     */
    public void setModel(Model model) {
        this.model = model;
    }
}