org.zaproxy.zap.authentication

Class HttpAuthenticationMethodType

java.lang.Object

org.zaproxy.zap.authentication.AuthenticationMethodType

org.zaproxy.zap.authentication.HttpAuthenticationMethodType

public class HttpAuthenticationMethodType
extends AuthenticationMethodType

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

See Also:

HTTP/1.0 - Access Authentication

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpAuthenticationMethodType.HttpAuthenticationMethod The implementation for an AuthenticationMethodType where the Users are authenticated through HTTP Authentication.

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

AuthenticationMethodType.UnsupportedAuthenticationMethodException

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_CONFIG_AUTH_HTTP
static String	CONTEXT_CONFIG_AUTH_HTTP_HOSTNAME
static String	CONTEXT_CONFIG_AUTH_HTTP_PORT
static String	CONTEXT_CONFIG_AUTH_HTTP_REALM

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

NULL_ENCODER

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticationMethodType()

Method Summary

Modifier and Type	Method and Description
AbstractCredentialsOptionsPanel<? extends AuthenticationCredentials>	buildCredentialsOptionsPanel(AuthenticationCredentials credentials, Context uiSharedContext) Builds the options panel that can be used to fully configure an.
AbstractAuthenticationMethodOptionsPanel	buildOptionsPanel(Context uiSharedContext) Builds the options panel that can be used to fully configure an authentication method.
AuthenticationCredentials	createAuthenticationCredentials() Creates a new, empty, Authentication Credentials object corresponding to this type of Authentication method.
HttpAuthenticationMethodType.HttpAuthenticationMethod	createAuthenticationMethod(int contextId) Builds a new, empty, authentication method.
void	exportData(org.apache.commons.configuration.Configuration config, AuthenticationMethod authMethod) Export the specified method to the configuration
Class<UsernamePasswordAuthenticationCredentials>	getAuthenticationCredentialsType() Gets the type of the authentication credentials that this authentication method creates.
String	getName() Gets the name of the authentication method.
ApiDynamicActionImplementor	getSetCredentialsForUserApiAction() Gets the ApiDynamicActionImplementor that can be used to set the authentication credentials of the corresponding type for an User of a context.
ApiDynamicActionImplementor	getSetMethodForContextApiAction() Gets the ApiAction that can be used to set an authentication method of this type for a context.
int	getUniqueIdentifier() Gets the unique identifier of this Authentication Method Type.
boolean	hasCredentialsOptionsPanel() Checks if the corresponding AuthenticationCredentials has an options panel that can be used for its configuration.
boolean	hasOptionsPanel() Checks if the corresponding AuthenticationMethod has an options panel that can be used for configuration.
void	hook(ExtensionHook extensionHook) Hooks the Authentication Method Type with other components of ZAP, if needed.
void	importData(org.apache.commons.configuration.Configuration config, AuthenticationMethod authMethod) Import the method from the configuration
boolean	isTypeForMethod(AuthenticationMethod method) Checks if is this is a type for the Authentication Method provided as parameter.
AuthenticationMethod	loadMethodFromSession(Session session, int contextId) Loads an authentication method from the Session.
void	persistMethodToSession(Session session, int contextId, AuthenticationMethod authMethod) Persists the authentication method to the session.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CONTEXT_CONFIG_AUTH_HTTP

public static final String CONTEXT_CONFIG_AUTH_HTTP

See Also:

Constant Field Values

CONTEXT_CONFIG_AUTH_HTTP_HOSTNAME

public static final String CONTEXT_CONFIG_AUTH_HTTP_HOSTNAME

See Also:

Constant Field Values

CONTEXT_CONFIG_AUTH_HTTP_REALM

public static final String CONTEXT_CONFIG_AUTH_HTTP_REALM

See Also:

Constant Field Values

CONTEXT_CONFIG_AUTH_HTTP_PORT

public static final String CONTEXT_CONFIG_AUTH_HTTP_PORT

See Also:

Constant Field Values

Constructor Detail

HttpAuthenticationMethodType

public HttpAuthenticationMethodType()

Method Detail

createAuthenticationMethod

public HttpAuthenticationMethodType.HttpAuthenticationMethod createAuthenticationMethod(int contextId)

Description copied from class: AuthenticationMethodType

Builds a new, empty, authentication method. The authentication method should then be configured through the Options panel.

Specified by:

createAuthenticationMethod in class AuthenticationMethodType

Parameters:

contextId - the ID of the context for which the authentication method is being created

Returns:

the authentication method

See Also:

AuthenticationMethodType.buildOptionsPanel(Context)

getName

public String getName()

Description copied from class: AuthenticationMethodType

Gets the name of the authentication method.

Specified by:

getName in class AuthenticationMethodType

Returns:

the name

getUniqueIdentifier

public int getUniqueIdentifier()

Description copied from class: AuthenticationMethodType

Gets the unique identifier of this Authentication Method Type. It has to be unique among all Authentication Method Types.

Specified by:

getUniqueIdentifier in class AuthenticationMethodType

Returns:

the unique identifier

buildOptionsPanel

public AbstractAuthenticationMethodOptionsPanel buildOptionsPanel(Context uiSharedContext)

Description copied from class: AuthenticationMethodType

Builds the options panel that can be used to fully configure an authentication method.

This method just builds an empty options panel. For binding an existing method to the panel, AbstractAuthenticationMethodOptionsPanel.bindMethod(AuthenticationMethod) should be used.

Specified by:

buildOptionsPanel in class AuthenticationMethodType

Parameters:

uiSharedContext - the shared context on which the panel should work

Returns:

the abstract authentication method options panel

See Also:

AuthenticationMethodType.hasOptionsPanel()

hasOptionsPanel

public boolean hasOptionsPanel()

Description copied from class: AuthenticationMethodType

Checks if the corresponding AuthenticationMethod has an options panel that can be used for configuration.

Specified by:

hasOptionsPanel in class AuthenticationMethodType

Returns:

true, if it needs one

See Also:

AuthenticationMethodType.buildOptionsPanel(Context)

buildCredentialsOptionsPanel

public AbstractCredentialsOptionsPanel<? extends AuthenticationCredentials> buildCredentialsOptionsPanel(AuthenticationCredentials credentials,
                                                                                                         Context uiSharedContext)

Description copied from class: AuthenticationMethodType

Builds the options panel that can be used to fully configure an.

Specified by:

buildCredentialsOptionsPanel in class AuthenticationMethodType

Parameters:

credentials - the credentials

uiSharedContext - the shared context on which the panel should work

Returns:

the abstract credentials options panel AuthenticationCredentials object.

hasCredentialsOptionsPanel

public boolean hasCredentialsOptionsPanel()

Description copied from class: AuthenticationMethodType

Checks if the corresponding AuthenticationCredentials has an options panel that can be used for its configuration.

Specified by:

hasCredentialsOptionsPanel in class AuthenticationMethodType

Returns:

true, if it needs one

isTypeForMethod

public boolean isTypeForMethod(AuthenticationMethod method)

Description copied from class: AuthenticationMethodType

Checks if is this is a type for the Authentication Method provided as parameter.

Specified by:

isTypeForMethod in class AuthenticationMethodType

Parameters:

method - the method

Returns:

true, if is factory for method

hook

public void hook(ExtensionHook extensionHook)

Description copied from class: AuthenticationMethodType

Hooks the Authentication Method Type with other components of ZAP, if needed. This method should is called only ones, when authentication types are loaded.

For example, PopupMenus can be registered.

Specified by:

hook in class AuthenticationMethodType

Parameters:

extensionHook - the extension hook

loadMethodFromSession

public AuthenticationMethod loadMethodFromSession(Session session,
                                                  int contextId)
                                           throws DatabaseException

Description copied from class: AuthenticationMethodType

Loads an authentication method from the Session. The implementation depends on the Authentication method type.

Specified by:

loadMethodFromSession in class AuthenticationMethodType

Parameters:

session - the session

contextId - the ID of the context

Returns:

the authentication method

Throws:

DatabaseException - if an error occurred while loading the authentication method

persistMethodToSession

public void persistMethodToSession(Session session,
                                   int contextId,
                                   AuthenticationMethod authMethod)
                            throws AuthenticationMethodType.UnsupportedAuthenticationMethodException,
                                   DatabaseException

Description copied from class: AuthenticationMethodType

Persists the authentication method to the session.

Specified by:

persistMethodToSession in class AuthenticationMethodType

Parameters:

session - the session

contextId - the context id

authMethod - the auth method to persist

Throws:

AuthenticationMethodType.UnsupportedAuthenticationMethodException - the unsupported authentication method exception

DatabaseException - if an error occurred while persisting the authentication method

createAuthenticationCredentials

public AuthenticationCredentials createAuthenticationCredentials()

Description copied from class: AuthenticationMethodType

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

Specified by:

createAuthenticationCredentials in class AuthenticationMethodType

Returns:

the authentication credentials

getAuthenticationCredentialsType

public Class<UsernamePasswordAuthenticationCredentials> getAuthenticationCredentialsType()

Description copied from class: AuthenticationMethodType

Gets the type of the authentication credentials that this authentication method creates.

Specified by:

getAuthenticationCredentialsType in class AuthenticationMethodType

Returns:

the type of the authentication credentials, should not be null.

getSetMethodForContextApiAction

public ApiDynamicActionImplementor getSetMethodForContextApiAction()

Description copied from class: AuthenticationMethodType

Gets the ApiAction that can be used to set an authentication method of this type for a context.

This api action will be handled by executing the ApiDynamicActionImplementor.handleAction(JSONObject) method.

Specified by:

getSetMethodForContextApiAction in class AuthenticationMethodType

Returns:

the api action, or null if there is no way to set this method type through the API

getSetCredentialsForUserApiAction

public ApiDynamicActionImplementor getSetCredentialsForUserApiAction()

Description copied from class: AuthenticationMethodType

Gets the ApiDynamicActionImplementor that can be used to set the authentication credentials of the corresponding type for an User of a context.

This api action will be handled by executing the ApiDynamicActionImplementor.handleAction(JSONObject) method.

Specified by:

getSetCredentialsForUserApiAction in class AuthenticationMethodType

Returns:

the api action, or null if there is no way to set this method type through the API

exportData

public void exportData(org.apache.commons.configuration.Configuration config,
                       AuthenticationMethod authMethod)

Description copied from class: AuthenticationMethodType

Export the specified method to the configuration

Specified by:

exportData in class AuthenticationMethodType

Parameters:

config - the Configuration where to export/save the authentication method

authMethod - the authentication method to be exported

importData

public void importData(org.apache.commons.configuration.Configuration config,
                       AuthenticationMethod authMethod)
                throws org.apache.commons.configuration.ConfigurationException

Description copied from class: AuthenticationMethodType

Import the method from the configuration

Specified by:

importData in class AuthenticationMethodType

Parameters:

config - the Configuration from where to import/load the authentication method

authMethod - where to set the imported authentication method data

Throws:

org.apache.commons.configuration.ConfigurationException - if an error occurred while reading the authentication method data