org.zaproxy.zap.extension.users

Class ExtensionUserManagement

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.users.ExtensionUserManagement

All Implemented Interfaces:

Extension, ContextDataFactory, ContextPanelFactory

public class ExtensionUserManagement
extends ExtensionAdaptor
implements ContextPanelFactory, ContextDataFactory

The Extension for managing Users, Roles, and related entities.

This class also handles the loading of AuthenticationMethodType and AuthenticationMethodType classes in the system using the AddOnLoader ( ExtensionFactory.getAddOnLoader()).

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_CONFIG_USERS
static String	CONTEXT_CONFIG_USERS_USER
static int	EXTENSION_ORDER The extension's order during loading.
static String	NAME The NAME of the extension.

Constructor Summary

Constructors

Constructor and Description
ExtensionUserManagement() Instantiates a new extension.

Method Summary

Modifier and Type	Method and Description
void	addSharedContextUser(Context sharedContext, User user) Add a new user shown in the UI (for the Users context panel) that corresponds to a particular shared Context.
void	discardContext(Context ctx)
void	discardContexts()
void	exportContextData(Context ctx, org.apache.commons.configuration.Configuration config) Export the Context data into the given configuration
String	getAuthor()
AbstractContextPropertiesPanel	getContextPanel(Context ctx)
ContextUserAuthManager	getContextUserAuthManager(int contextId) Gets the context user auth manager for a given context.
List<Class<? extends Extension>>	getDependencies() Gets the list of Extensions that this extension depends on.
protected ExtensionHttpSessions	getExtensionHttpSessions() Gets the ExtensionHttpSessions, if it's enabled.
List<User>	getSharedContextUsers(Context sharedContext)
List<User>	getUIConfiguredUsers(int contextId) Gets an unmodifiable view of the users that are currently shown in the UI.
UsersTableModel	getUIConfiguredUsersModel(int contextId) Gets the model of the users that are currently shown in the UI.
String	getUIName() By default returns the name returned by getName().
URL	getURL()
void	hook(ExtensionHook extensionHook) Called during extension's initialisation to allow to add new functionality to core components.
void	importContextData(Context ctx, org.apache.commons.configuration.Configuration config) Import the Context data from the given configuration
void	loadContextData(Session session, Context context) Loads the Context data from the given session.
void	persistContextData(Session session, Context context) Save the Context data into the given session.
void	removeContextUsers(int contextId) Removes all the that correspond to a Context with a given id.
void	removeSharedContextUsers(Context sharedContext) Removes all the users that are shown in the UI (for the Users context panel) and correspond to a particular shared Context.
boolean	supportsDb(String type) No database tables used, so all supported

Methods inherited from class org.parosproxy.paros.extension.ExtensionAdaptor

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDescription, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, postInit, postInstall, setAddOn, setDescription, setEnabled, setI18nPrefix, setMessages, setName, setOrder, start, stop, supportsLowMemory, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.parosproxy.paros.extension.Extension

getVersion

Field Detail

CONTEXT_CONFIG_USERS

public static final String CONTEXT_CONFIG_USERS

See Also:

Constant Field Values

CONTEXT_CONFIG_USERS_USER

public static final String CONTEXT_CONFIG_USERS_USER

See Also:

Constant Field Values

EXTENSION_ORDER

public static final int EXTENSION_ORDER

The extension's order during loading. Make sure we load this extension AFTER the Authentication one.

See Also:

Constant Field Values

NAME

public static final String NAME

The NAME of the extension.

See Also:

Constant Field Values

Constructor Detail

ExtensionUserManagement

public ExtensionUserManagement()

Instantiates a new extension.

Method Detail

getExtensionHttpSessions

protected ExtensionHttpSessions getExtensionHttpSessions()

Gets the ExtensionHttpSessions, if it's enabled.

Returns:

the Http Sessions extension or null, if it's not available

getUIName

public String getUIName()

Description copied from class: ExtensionAdaptor

By default returns the name returned by getName().

Specified by:

getUIName in interface Extension

Overrides:

getUIName in class ExtensionAdaptor

Returns:

the UI name of the extension, never null

See Also:

ExtensionAdaptor.getName()

getAuthor

public String getAuthor()

Specified by:

getAuthor in interface Extension

hook

public void hook(ExtensionHook extensionHook)

Description copied from interface: Extension

Called during extension's initialisation to allow to add new functionality to core components.

Specified by:

hook in interface Extension

Overrides:

hook in class ExtensionAdaptor

Parameters:

extensionHook - the hook to add the components.

getDependencies

public List<Class<? extends Extension>> getDependencies()

Description copied from interface: Extension

Gets the list of Extensions that this extension depends on.

Specified by:

getDependencies in interface Extension

Overrides:

getDependencies in class ExtensionAdaptor

Returns:

the list of dependencies, empty (or null) if none.

getURL

public URL getURL()

Specified by:

getURL in interface Extension

Overrides:

getURL in class ExtensionAdaptor

getContextPanel

public AbstractContextPropertiesPanel getContextPanel(Context ctx)

Specified by:

getContextPanel in interface ContextPanelFactory

getContextUserAuthManager

public ContextUserAuthManager getContextUserAuthManager(int contextId)

Gets the context user auth manager for a given context.

Parameters:

contextId - the context id

Returns:

the context user auth manager

getUIConfiguredUsers

public List<User> getUIConfiguredUsers(int contextId)

Gets an unmodifiable view of the users that are currently shown in the UI.

Parameters:

contextId - the context id

Returns:

the uI configured users

getUIConfiguredUsersModel

public UsersTableModel getUIConfiguredUsersModel(int contextId)

Gets the model of the users that are currently shown in the UI.

Parameters:

contextId - the context id

Returns:

the users model, if any, or null, if there is no panel for the given model

discardContexts

public void discardContexts()

Specified by:

discardContexts in interface ContextPanelFactory

discardContext

public void discardContext(Context ctx)

Specified by:

discardContext in interface ContextPanelFactory

loadContextData

public void loadContextData(Session session,
                            Context context)

Description copied from interface: ContextDataFactory

Loads the Context data from the given session.

Specified by:

loadContextData in interface ContextDataFactory

Parameters:

session - the session to load from, not null.

context - the context to load into, not null.

persistContextData

public void persistContextData(Session session,
                               Context context)

Description copied from interface: ContextDataFactory

Save the Context data into the given session.

Specified by:

persistContextData in interface ContextDataFactory

Parameters:

session - the session to persist into, not null.

context - the context to persist from, not null.

removeSharedContextUsers

public void removeSharedContextUsers(Context sharedContext)

Removes all the users that are shown in the UI (for the Users context panel) and correspond to a particular shared Context.

Parameters:

sharedContext - the shared context

addSharedContextUser

public void addSharedContextUser(Context sharedContext,
                                 User user)

Add a new user shown in the UI (for the Users context panel) that corresponds to a particular shared Context.

Parameters:

sharedContext - the shared context

user - the user

getSharedContextUsers

public List<User> getSharedContextUsers(Context sharedContext)

removeContextUsers

public void removeContextUsers(int contextId)

Removes all the that correspond to a Context with a given id.

Parameters:

contextId - the context id

exportContextData

public void exportContextData(Context ctx,
                              org.apache.commons.configuration.Configuration config)

Description copied from interface: ContextDataFactory

Export the Context data into the given configuration

Specified by:

exportContextData in interface ContextDataFactory

Parameters:

ctx - the context to export, not null.

config - the Configuration where to export the context data, not null.

importContextData

public void importContextData(Context ctx,
                              org.apache.commons.configuration.Configuration config)

Description copied from interface: ContextDataFactory

Import the Context data from the given configuration

Specified by:

importContextData in interface ContextDataFactory

Parameters:

ctx - the context to import the context data to

config - the Configuration containing the context data, not null.

supportsDb

public boolean supportsDb(String type)

No database tables used, so all supported

Specified by:

supportsDb in interface Extension

Overrides:

supportsDb in class ExtensionAdaptor

Parameters:

type - the db type

Returns:

true if the specified db type is supported by the extension (or if it doesnt use any db)

See Also:

Database.getType()