org.zaproxy.clientapi.gen.Acsrf Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zap-clientapi Show documentation
Java implementation to access ZAP API.
There is a newer version: 1.14.0
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2017 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.clientapi.gen;

import java.util.HashMap;
import java.util.Map;
import org.zaproxy.clientapi.core.ApiResponse;
import org.zaproxy.clientapi.core.ClientApi;
import org.zaproxy.clientapi.core.ClientApiException;

/** This file was automatically generated. */
@SuppressWarnings("javadoc")
public class Acsrf extends org.zaproxy.clientapi.gen.deprecated.AcsrfDeprecated {

    private final ClientApi api;

    public Acsrf(ClientApi api) {
        super(api);
        this.api = api;
    }

    /** Lists the names of all anti-CSRF tokens */
    public ApiResponse optionTokensNames() throws ClientApiException {
        return api.callApi("acsrf", "view", "optionTokensNames", null);
    }

    /** Define if ZAP should detect CSRF tokens by searching for partial matches */
    public ApiResponse optionPartialMatchingEnabled() throws ClientApiException {
        return api.callApi("acsrf", "view", "optionPartialMatchingEnabled", null);
    }

    /** Adds an anti-CSRF token with the given name, enabled by default */
    public ApiResponse addOptionToken(String string) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("String", string);
        return api.callApi("acsrf", "action", "addOptionToken", map);
    }

    /** Removes the anti-CSRF token with the given name */
    public ApiResponse removeOptionToken(String string) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("String", string);
        return api.callApi("acsrf", "action", "removeOptionToken", map);
    }

    /** Define if ZAP should detect CSRF tokens by searching for partial matches. */
    public ApiResponse setOptionPartialMatchingEnabled(boolean bool) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("Boolean", Boolean.toString(bool));
        return api.callApi("acsrf", "action", "setOptionPartialMatchingEnabled", map);
    }

    /** Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP */
    public byte[] genForm(String hrefid) throws ClientApiException {
        return genFormActionUrl(hrefid, null);
    }

    /** Generate a form for testing lack of anti-CSRF tokens - typically invoked via ZAP */
    public byte[] genFormActionUrl(String hrefid, String actionurl) throws ClientApiException {
        Map map = new HashMap<>();
        map.put("hrefId", hrefid);
        if (actionurl != null) {
            map.put("actionUrl", actionurl);
        }
        return api.callApiOther("acsrf", "other", "genForm", map);
    }
}