org.zaproxy.zap.authentication

Class AuthenticationMethodType

java.lang.Object

org.zaproxy.zap.authentication.AuthenticationMethodType

Direct Known Subclasses:

HttpAuthenticationMethodType, ManualAuthenticationMethodType, PostBasedAuthenticationMethodType, ScriptBasedAuthenticationMethodType

public abstract class AuthenticationMethodType
extends Object

A type of authentication method. This class also acts as a factory for creating AuthenticationMethod objects and for creating the options panels used for configuring both the AuthenticationMethod and the AuthenticationCredentials.

The implementors of new authentication methods should also implement a corresponding AuthenticationMethodType. The system automatically detects and loads Authentication Method Types and, through them, the corresponding Authentication methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthenticationMethodType.UnsupportedAuthenticationMethodException Thrown when an unsupported type of credentials is used with a AuthenticationMethod .

Constructor Summary

Constructors

Constructor and Description
AuthenticationMethodType()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationMethodType

public AuthenticationMethodType()

Method Detail

createAuthenticationMethod

public abstract AuthenticationMethod createAuthenticationMethod(int contextId)

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

Parameters:

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

Returns:

the authentication method

See Also:

buildOptionsPanel(Context)

getName

public abstract String getName()

Gets the name of the authentication method.

Returns:

the name

getUniqueIdentifier

public abstract int getUniqueIdentifier()

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

Returns:

the unique identifier

buildOptionsPanel

public abstract AbstractAuthenticationMethodOptionsPanel buildOptionsPanel(Context uiSharedContext)

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.

Parameters:

uiSharedContext - the shared context on which the panel should work

Returns:

the abstract authentication method options panel

See Also:

hasOptionsPanel()

hasOptionsPanel

public abstract boolean hasOptionsPanel()

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

Returns:

true, if it needs one

See Also:

buildOptionsPanel(Context)

buildCredentialsOptionsPanel

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

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

Parameters:

credentials - the credentials

uiSharedContext - the shared context on which the panel should work

Returns:

the abstract credentials options panel AuthenticationCredentials object.

hasCredentialsOptionsPanel

public abstract boolean hasCredentialsOptionsPanel()

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

Returns:

true, if it needs one

isTypeForMethod

public abstract boolean isTypeForMethod(AuthenticationMethod method)

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

Parameters:

method - the method

Returns:

true, if is factory for method

hook

public abstract void hook(ExtensionHook extensionHook)

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.

Parameters:

extensionHook - the extension hook

loadMethodFromSession

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

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

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 abstract void persistMethodToSession(Session session,
                                            int contextId,
                                            AuthenticationMethod authMethod)
                                     throws DatabaseException

Persists the authentication method to the session.

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

exportData

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

Export the specified method to the configuration

Parameters:

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

authMethod - the authentication method to be exported

importData

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

Import the method from the configuration

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

toString

public String toString()

Overrides:

toString in class Object

createAuthenticationCredentials

public abstract AuthenticationCredentials createAuthenticationCredentials()

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

Returns:

the authentication credentials

getAuthenticationCredentialsType

public abstract Class<? extends AuthenticationCredentials> getAuthenticationCredentialsType()

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

Returns:

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

Since:

2.8.0

getSetMethodForContextApiAction

public abstract ApiDynamicActionImplementor getSetMethodForContextApiAction()

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.

Returns:

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

getSetCredentialsForUserApiAction

public abstract ApiDynamicActionImplementor getSetCredentialsForUserApiAction()

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.

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object