org.zaproxy.zap.authentication

Class HttpAuthenticationMethodType.HttpAuthenticationMethod

java.lang.Object

org.zaproxy.zap.authentication.AuthenticationMethod

org.zaproxy.zap.authentication.HttpAuthenticationMethodType.HttpAuthenticationMethod

Enclosing class:

HttpAuthenticationMethodType

public static class HttpAuthenticationMethodType.HttpAuthenticationMethod
extends AuthenticationMethod

The implementation for an AuthenticationMethodType where the Users are authenticated through HTTP Authentication.

Nested Class Summary

Nested classes/interfaces inherited from class org.zaproxy.zap.authentication.AuthenticationMethod

AuthenticationMethod.AuthCheckingStrategy, AuthenticationMethod.AuthPollFrequencyUnits, AuthenticationMethod.UnsupportedAuthenticationCredentialsException

Field Summary

Fields

Modifier and Type	Field and Description
protected String	hostname
protected int	port
protected String	realm

Fields inherited from class org.zaproxy.zap.authentication.AuthenticationMethod

AUTH_STATE_ASSUMED_IN_STATS, AUTH_STATE_LOGGED_IN_STATS, AUTH_STATE_LOGGED_OUT_STATS, AUTH_STATE_NO_INDICATOR_STATS, AUTH_STATE_UNKNOWN_STATS, CONTEXT_CONFIG_AUTH, CONTEXT_CONFIG_AUTH_LOGGEDIN, CONTEXT_CONFIG_AUTH_LOGGEDOUT, CONTEXT_CONFIG_AUTH_POLL_DATA, CONTEXT_CONFIG_AUTH_POLL_FREQ, CONTEXT_CONFIG_AUTH_POLL_HEADERS, CONTEXT_CONFIG_AUTH_POLL_UNITS, CONTEXT_CONFIG_AUTH_POLL_URL, CONTEXT_CONFIG_AUTH_STRATEGY, CONTEXT_CONFIG_AUTH_TYPE, DEFAULT_POLL_FREQUENCY, loggedInIndicatorPattern, loggedOutIndicatorPattern, TOKEN_POSTFIX, TOKEN_PREFIX

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticationMethod()

Method Summary

Modifier and Type	Method and Description
WebSession	authenticate(SessionManagementMethod sessionManagementMethod, AuthenticationCredentials credentials, User user) Performs an authentication in a web application, returning an authenticated.
AuthenticationCredentials	createAuthenticationCredentials() Creates a new, empty, Authentication Credentials object corresponding to this type of Authentication method.
protected AuthenticationMethod	duplicate() Internal method for cloning the current authentication method, creating a deep-copy of it.
ApiResponse	getApiResponseRepresentation() Gets an api response that represents the Authentication Method.
AuthenticationMethodType	getType() Gets the AuthenticationMethodType corresponding to this authentication method.
boolean	isConfigured() Checks if the authentication method is fully configured.
void	replaceUserDataInPollRequest(HttpMessage msg, User user)
void	setHostname(String hostname)
void	setPort(int port)
void	setRealm(String realm)

Methods inherited from class org.zaproxy.zap.authentication.AuthenticationMethod

clone, equals, evaluateAuthRequest, getAuthCheckingStrategy, getLoggedInIndicatorPattern, getLoggedOutIndicatorPattern, getPollData, getPollFrequency, getPollFrequencyUnits, getPollHeaders, getPollUrl, hashCode, isAuthenticated, isAuthenticated, isAuthenticated, isSameType, onMethodDiscarded, onMethodPersisted, pollAsUser, setAuthCheckingStrategy, setLoggedInIndicatorPattern, setLoggedOutIndicatorPattern, setPollData, setPollFrequency, setPollFrequencyUnits, setPollHeaders, setPollUrl, validateCreationOfAuthenticationCredentials

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

hostname

protected String hostname

port

protected int port

realm

protected String realm

Constructor Detail

HttpAuthenticationMethod

public HttpAuthenticationMethod()

Method Detail

setHostname

public void setHostname(String hostname)

setPort

public void setPort(int port)

setRealm

public void setRealm(String realm)

isConfigured

public boolean isConfigured()

Description copied from class: AuthenticationMethod

Checks if the authentication method is fully configured.

Specified by:

isConfigured in class AuthenticationMethod

Returns:

true, if is configured

duplicate

protected AuthenticationMethod duplicate()

Description copied from class: AuthenticationMethod

Internal method for cloning the current authentication method, creating a deep-copy of it.

Specified by:

duplicate in class AuthenticationMethod

Returns:

a deep copy of the authentication method

createAuthenticationCredentials

public AuthenticationCredentials createAuthenticationCredentials()

Description copied from class: AuthenticationMethod

Creates a new, empty, Authentication Credentials object corresponding to this type of Authentication method.

Specified by:

createAuthenticationCredentials in class AuthenticationMethod

Returns:

the authentication credentials

See Also:

AuthenticationMethod.validateCreationOfAuthenticationCredentials()

getType

public AuthenticationMethodType getType()

Description copied from class: AuthenticationMethod

Gets the AuthenticationMethodType corresponding to this authentication method.

Implementations may return new instantiations at every call, so performance considerations should be taken by users.

Specified by:

getType in class AuthenticationMethod

Returns:

the type

authenticate

public WebSession authenticate(SessionManagementMethod sessionManagementMethod,
                               AuthenticationCredentials credentials,
                               User user)
                        throws AuthenticationMethod.UnsupportedAuthenticationCredentialsException

Description copied from class: AuthenticationMethod

Performs an authentication in a web application, returning an authenticated.

Specified by:

authenticate in class AuthenticationMethod

Parameters:

sessionManagementMethod - the set up session management method is provided so it can be used, if needed, to automatically extract session information from Http Messages.

credentials - the credentials

user - the user to authenticate

Returns:

an authenticated web session

Throws:

AuthenticationMethod.UnsupportedAuthenticationCredentialsException - the unsupported authentication credentials exception WebSession.

getApiResponseRepresentation

public ApiResponse getApiResponseRepresentation()

Description copied from class: AuthenticationMethod

Gets an api response that represents the Authentication Method.

Specified by:

getApiResponseRepresentation in class AuthenticationMethod

Returns:

the api response representation

replaceUserDataInPollRequest

public void replaceUserDataInPollRequest(HttpMessage msg,
                                         User user)

Specified by:

replaceUserDataInPollRequest in class AuthenticationMethod