Plugins

interface Products.PluggableAuthService.interfaces.plugins.IExtractionPlugin[source]

Extracts login name and credentials from a request.

interface Products.PluggableAuthService.interfaces.plugins.ILoginPasswordExtractionPlugin[source]

Extends: Products.PluggableAuthService.interfaces.plugins.IExtractionPlugin

Common-case derivative.

interface Products.PluggableAuthService.interfaces.plugins.ILoginPasswordHostExtractionPlugin[source]

Extends: Products.PluggableAuthService.interfaces.plugins.ILoginPasswordExtractionPlugin

Common-case derivative.

interface Products.PluggableAuthService.interfaces.plugins.IAuthenticationPlugin[source]

Map credentials to a user ID.

interface Products.PluggableAuthService.interfaces.plugins.IChallengePlugin[source]

Initiate a challenge to the user to provide credentials.

Challenge plugins have an attribute ‘protocol’ representing the protocol the plugin operates under, defaulting to None.

Plugins operating under the same protocol will all be given an attempt to fire. The first plugin of a protocol group that successfully fires establishes the protocol of the overall challenge.

interface Products.PluggableAuthService.interfaces.plugins.ICredentialsUpdatePlugin[source]

Callback: user has changed her password.

This interface is not responsible for the actual password change, it is used after a successful password change event.

interface Products.PluggableAuthService.interfaces.plugins.ICredentialsResetPlugin[source]

Callback: user has logged out.

interface Products.PluggableAuthService.interfaces.plugins.IUserAdderPlugin[source]

Create a new user record in a User Manager

interface Products.PluggableAuthService.interfaces.plugins.IRoleAssignerPlugin[source]

Assign a role to an identified principal

interface Products.PluggableAuthService.interfaces.plugins.IUserFactoryPlugin[source]

Create a new IPropertiedUser.

interface Products.PluggableAuthService.interfaces.plugins.IAnonymousUserFactoryPlugin[source]

Create a new anonymous IPropertiedUser.

interface Products.PluggableAuthService.interfaces.plugins.IPropertiesPlugin[source]

Return a property set for a user.

interface Products.PluggableAuthService.interfaces.plugins.IGroupsPlugin[source]

Determine the groups to which a user belongs.

interface Products.PluggableAuthService.interfaces.plugins.IRolesPlugin[source]

Determine the (global) roles which a user has.

interface Products.PluggableAuthService.interfaces.plugins.IUpdatePlugin[source]

Allow the user or the application to update the user’s properties.

interface Products.PluggableAuthService.interfaces.plugins.IValidationPlugin[source]

Specify allowable values for user properties.

o E.g., constrain minimum password length, allowed characters, etc.

o Operate on entire property sets, not individual properties.

interface Products.PluggableAuthService.interfaces.plugins.IUserEnumerationPlugin[source]

Allow querying users by ID, and searching for users.

o ???: can these be done by a single plugin?

interface Products.PluggableAuthService.interfaces.plugins.IGroupEnumerationPlugin[source]

Allow querying groups by ID, and searching for groups.

o ???: can these be done by a single plugin?

interface Products.PluggableAuthService.interfaces.plugins.IRoleEnumerationPlugin[source]

Allow querying roles by ID, and searching for roles.

interface Products.PluggableAuthService.interfaces.plugins.IRequestTypeSniffer[source]

Given a request, detects request type for later use by other plugins.

interface Products.PluggableAuthService.interfaces.plugins.IChallengeProtocolChooser[source]

Choose a proper set of protocols to be used for challenging the client given a request.

interface Products.PluggableAuthService.interfaces.plugins.INotCompetentPlugin[source]

check whether this user folder is not competent to authenticate.

Never used for a top level user folder; primarily used to prevent shadowing of authentications by higher level user folders.