org.zaproxy.zap.authentication.AuthenticationCredentials 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 2013 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.authentication;

import org.zaproxy.zap.extension.api.ApiResponse;

/**
 * The Credentials is an entity, corresponding to an Authentication Method, that has all the
 * information required to create a new authenticated WebSession in a web application , for one of
 * the web application's 'users'.
 *
 * For example, in the case of form based authentication, the AuthenticationMethod 'knows' which
 * is the login URL, which are the names of the fields it has to submit for user and password, while
 * the Authenticator is an 'instance' corresponding to an user, which knows it's password and
 * username.
 */
public interface AuthenticationCredentials {

    /**
     * Checks if the credentials object is fully configured.
     *
     * @return true, if is configured
     */
    boolean isConfigured();

    /**
     * Encodes the Credentials in a String. Fields that contain strings should not contain the
     * {@code parentFieldSeparator}. Should be consistent with {@link #decode(String)}.
     *
     * @param parentFieldSeparator the parent field separator
     * @return the string
     */
    String encode(String parentFieldSeparator);

    /**
     * Decodes the internal values of the Authentication Credentials from an encoded string and
     * fills in the current object. The string provided as input should have been obtained through
     * calls to {@link #encode(String)}.
     *
     * @param encodedCredentials the encoded credentials
     */
    void decode(String encodedCredentials);

    /**
     * Gets an api response that represents the Credentials.
     *
     * @return the api response representation
     */
    public abstract ApiResponse getApiResponseRepresentation();
}