org.apache.guacamole.net.auth.simple

Class SimpleAuthenticationProvider

java.lang.Object

org.apache.guacamole.net.auth.simple.SimpleAuthenticationProvider

All Implemented Interfaces:

AuthenticationProvider

public abstract class SimpleAuthenticationProvider
extends Object
implements AuthenticationProvider

Provides means of retrieving a set of named GuacamoleConfigurations for a given Credentials object. This is a simple AuthenticationProvider implementation intended to be easily extended. It is useful for simple authentication situations where access to web-based administration and complex users and permissions are not required. The interface provided by SimpleAuthenticationProvider is similar to that of the AuthenticationProvider interface of older Guacamole releases.

Constructor Summary

Constructors

Constructor and Description
SimpleAuthenticationProvider()

Method Summary

Modifier and Type	Method and Description
AuthenticatedUser	authenticateUser(Credentials credentials) Returns an AuthenticatedUser representing the user authenticated by the given credentials, if any.
abstract Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration>	getAuthorizedConfigurations(Credentials credentials) Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials.
Object	getResource() Returns an arbitrary REST resource representing this AuthenticationProvider.
UserContext	getUserContext(AuthenticatedUser authenticatedUser) Returns the UserContext of the user authenticated by the given credentials.
AuthenticatedUser	updateAuthenticatedUser(AuthenticatedUser authenticatedUser, Credentials credentials) Returns a new or updated AuthenticatedUser for the given credentials already having produced the given AuthenticatedUser.
UserContext	updateUserContext(UserContext context, AuthenticatedUser authorizedUser, Credentials credentials) Returns a new or updated UserContext for the given AuthenticatedUser already having the given UserContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.guacamole.net.auth.AuthenticationProvider

getIdentifier

Constructor Detail

SimpleAuthenticationProvider

public SimpleAuthenticationProvider()

Method Detail

getAuthorizedConfigurations

public abstract Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> getAuthorizedConfigurations(Credentials credentials)
                                                                                                      throws org.apache.guacamole.GuacamoleException

Given an arbitrary credentials object, returns a Map containing all configurations authorized by those credentials. The keys of this Map are Strings which uniquely identify each configuration.

Parameters:

credentials - The credentials to use to retrieve authorized configurations.

Returns:

A Map of all configurations authorized by the given credentials, or null if the credentials given are not authorized.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving configurations.

getResource

public Object getResource()
                   throws org.apache.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

Returns an arbitrary REST resource representing this AuthenticationProvider. The REST resource returned must be properly annotated with JSR-311 annotations, and may serve as the root resource for any number of subresources. The returned resource is ultimately exposed at ".../api/ext/IDENTIFIER/", where IDENTIFIER is the identifier of this AuthenticationProvider. REST resources returned by this function will be reachable by all users, regardless of whether they have authenticated. REST resources which must only be accessible by authenticated users should instead be returned from UserContext.getResource().

Specified by:

getResource in interface AuthenticationProvider

Returns:

An arbitrary REST resource, annotated with JSR-311 annotations, or null if no such resource is defined.

Throws:

org.apache.guacamole.GuacamoleException - If the REST resource cannot be returned due to an error.

authenticateUser

public AuthenticatedUser authenticateUser(Credentials credentials)
                                   throws org.apache.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

Returns an AuthenticatedUser representing the user authenticated by the given credentials, if any.

Specified by:

authenticateUser in interface AuthenticationProvider

Parameters:

credentials - The credentials to use for authentication.

Returns:

An AuthenticatedUser representing the user authenticated by the given credentials, if any, or null if the credentials are invalid.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while authenticating the user, or if access is temporarily, permanently, or conditionally denied, such as if the supplied credentials are insufficient or invalid.

getUserContext

public UserContext getUserContext(AuthenticatedUser authenticatedUser)
                           throws org.apache.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

Returns the UserContext of the user authenticated by the given credentials.

Specified by:

getUserContext in interface AuthenticationProvider

Parameters:

authenticatedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

Returns:

A UserContext describing the permissions, connection, connection groups, etc. accessible or associated with the given authenticated user, or null if this AuthenticationProvider refuses to provide any such data.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the UserContext.

updateAuthenticatedUser

public AuthenticatedUser updateAuthenticatedUser(AuthenticatedUser authenticatedUser,
                                                 Credentials credentials)
                                          throws org.apache.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

Returns a new or updated AuthenticatedUser for the given credentials already having produced the given AuthenticatedUser. Note that because this function will be called for all future requests after initial authentication, including tunnel requests, care must be taken to avoid using functions of HttpServletRequest which invalidate the entire request body, such as getParameter(). Doing otherwise may cause the GuacamoleHTTPTunnelServlet to fail.

Specified by:

updateAuthenticatedUser in interface AuthenticationProvider

Parameters:

authenticatedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

credentials - The credentials to use for authentication.

Returns:

An updated AuthenticatedUser representing the user authenticated by the given credentials, if any, or null if the credentials are invalid.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while updating the AuthenticatedUser.

updateUserContext

public UserContext updateUserContext(UserContext context,
                                     AuthenticatedUser authorizedUser,
                                     Credentials credentials)
                              throws org.apache.guacamole.GuacamoleException

Description copied from interface: AuthenticationProvider

Returns a new or updated UserContext for the given AuthenticatedUser already having the given UserContext. Note that because this function will be called for all future requests after initial authentication, including tunnel requests, care must be taken to avoid using functions of HttpServletRequest which invalidate the entire request body, such as getParameter(). Doing otherwise may cause the GuacamoleHTTPTunnelServlet to fail.

Specified by:

updateUserContext in interface AuthenticationProvider

Parameters:

context - The existing UserContext belonging to the user in question.

authorizedUser - An AuthenticatedUser object representing the user authenticated by an arbitrary set of credentials. The AuthenticatedUser may come from this AuthenticationProvider or any other installed AuthenticationProvider.

credentials - The credentials which were most recently submitted. These are not guaranteed to be the same as the credentials associated with the AuthenticatedUser when they originally authenticated.

Returns:

An updated UserContext describing the permissions, connection, connection groups, etc. accessible or associated with the given authenticated user, or null if this AuthenticationProvider refuses to provide any such data.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while updating the UserContext.