org.zaproxy.zap.authentication

Interface AuthenticationCredentials

All Known Implementing Classes:

GenericAuthenticationCredentials, UsernamePasswordAuthenticationCredentials

public interface AuthenticationCredentials

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.

Method Summary

Modifier and Type	Method and Description
void	decode(String encodedCredentials) Decodes the internal values of the Authentication Credentials from an encoded string and fills in the current object.
String	encode(String parentFieldSeparator) Encodes the Credentials in a String.
ApiResponse	getApiResponseRepresentation() Gets an api response that represents the Credentials.
boolean	isConfigured() Checks if the credentials object is fully configured.

Method Detail

isConfigured

boolean isConfigured()

Checks if the credentials object is fully configured.

Returns:

true, if is configured

encode

String encode(String parentFieldSeparator)

Encodes the Credentials in a String. Fields that contain strings should not contain the parentFieldSeparator. Should be consistent with decode(String).

Parameters:

parentFieldSeparator - the parent field separator

Returns:

the string

decode

void decode(String encodedCredentials)

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 encode(String).

Parameters:

encodedCredentials - the encoded credentials

getApiResponseRepresentation

ApiResponse getApiResponseRepresentation()

Gets an api response that represents the Credentials.

Returns:

the api response representation