safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 21:27:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Implement simple authentication provider base class (for convenience and testing).

Browse Source
This commit is contained in:
Michael Jumper
2013-01-28 12:21:41 -08:00
committed by Michael Jumper
parent a1b989ada0
commit 01f8b4c596
4 changed files with 375 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/simple/SimpleAuthenticationProvider.java Normal file
View File

@@ -0,0 +1,100 @@
package net.sourceforge.guacamole.net.auth.simple;
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is guacamole-auth.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
import java.util.Map;
import net.sourceforge.guacamole.GuacamoleException;
import net.sourceforge.guacamole.net.auth.AuthenticationProvider;
import net.sourceforge.guacamole.net.auth.Credentials;
import net.sourceforge.guacamole.net.auth.User;
import net.sourceforge.guacamole.net.auth.UserContext;
import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
/**
* 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.
*
* @author Michael Jumper
*/
public abstract class SimpleAuthenticationProvider
implements AuthenticationProvider {
/**
* 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.
*
* @param credentials The credentials to use to retrieve authorized
* configurations.
* @return A Map of all configurations authorized by the given credentials,
* or null if the credentials given are not authorized.
* @throws GuacamoleException If an error occurs while retrieving
* configurations.
*/
public abstract Map<String, GuacamoleConfiguration>
getAuthorizedConfigurations(Credentials credentials)
throws GuacamoleException;
@Override
public UserContext getUserContext(Credentials credentials)
throws GuacamoleException {
// Get configurations
Map<String, GuacamoleConfiguration> configs =
getAuthorizedConfigurations(credentials);
// Return as unauthorized if not authorized to retrieve configs
if (configs == null)
return null;
// Build new user from credentials
User user = new SimpleUser(credentials.getUsername());
// Return user context restricted to authorized configs
return new SimpleUserContext(user, configs);
}
}

97
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/simple/SimpleGuacamoleConfigurationDirectory.java Normal file
View File

@@ -0,0 +1,97 @@
package net.sourceforge.guacamole.net.auth.simple;
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is guacamole-auth.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
import java.util.Map;
import net.sourceforge.guacamole.GuacamoleException;
import net.sourceforge.guacamole.GuacamoleSecurityException;
import net.sourceforge.guacamole.net.auth.GuacamoleConfigurationDirectory;
import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
/**
* An extremely simple read-only implementation of a
* GuacamoleConfigurationDirectory which provides access to a pre-defined
* Map of GuacamoleConfigurations.
*
* @author Michael Jumper
*/
public class SimpleGuacamoleConfigurationDirectory
implements GuacamoleConfigurationDirectory {
/**
* The Map of GuacamoleConfigurations to provide access to.
*/
private Map<String, GuacamoleConfiguration> configs;
/**
* Creates a new SimpleGuacamoleConfigurationDirectory which provides
* access to the configurations contained within the given Map.
*
* @param configs The Map of GuacamoleConfigurations to provide access to.
*/
public SimpleGuacamoleConfigurationDirectory(
Map<String, GuacamoleConfiguration> configs) {
this.configs = configs;
}
@Override
public Map<String, GuacamoleConfiguration> getConfigurations()
throws GuacamoleException {
return configs;
}
@Override
public void addConfiguration(String identifier,
GuacamoleConfiguration config) throws GuacamoleException {
throw new GuacamoleSecurityException("Permission denied.");
}
@Override
public void updateConfiguration(String identifier,
GuacamoleConfiguration config) throws GuacamoleException {
throw new GuacamoleSecurityException("Permission denied.");
}
@Override
public void removeConfiguration(String identifier)
throws GuacamoleException {
throw new GuacamoleSecurityException("Permission denied.");
}
}

65
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/simple/SimpleUser.java Normal file
View File

@@ -0,0 +1,65 @@
package net.sourceforge.guacamole.net.auth.simple;
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is guacamole-auth.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
import net.sourceforge.guacamole.net.auth.AbstractUser;
/**
* An extremely basic User implementation.
*
* @author Michael Jumper
*/
public class SimpleUser extends AbstractUser {
/**
* Creates a completely uninitialized SimpleUser.
*/
public SimpleUser() {
}
/**
* Creates a new SimpleUser having the given username.
*
* @param username The username to assign to this SimpleUser.
*/
public SimpleUser(String username) {
setUsername(username);
}
}

113
guacamole-ext/src/main/java/net/sourceforge/guacamole/net/auth/simple/SimpleUserContext.java Normal file
View File

@@ -0,0 +1,113 @@
package net.sourceforge.guacamole.net.auth.simple;
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is guacamole-ext.
*
* The Initial Developer of the Original Code is
* Michael Jumper.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
import java.util.Map;
import net.sourceforge.guacamole.GuacamoleException;
import net.sourceforge.guacamole.GuacamoleSecurityException;
import net.sourceforge.guacamole.net.auth.GuacamoleConfigurationDirectory;
import net.sourceforge.guacamole.net.auth.PermissionDirectory;
import net.sourceforge.guacamole.net.auth.User;
import net.sourceforge.guacamole.net.auth.UserContext;
import net.sourceforge.guacamole.net.auth.UserDirectory;
import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
/**
* An extremely simple UserContext implementation which provides access to
* a defined and restricted set of GuacamoleConfigurations. Access to
* querying or modifying either users or permissions is denied.
*
* @author Michael Jumper
*/
public class SimpleUserContext implements UserContext {
/**
* Reference to the user whose permissions dictate the configurations
* accessible within this UserContext.
*/
private final User self;
/**
* The GuacamoleConfigurationDirectory with access only to those
* configurations that the User associated with this UserContext has
* read access to.
*/
private final GuacamoleConfigurationDirectory configDirectory;
/**
* Creates a new SimpleUserContext which provides access to only those
* configurations within the given Map. The User given must be the user
* that owns this UserContext, and the Map given must contain only
* GuacamoleConfigurations that the given User has read access to.
*
* @param self The owner of this UserContext.
* @param configs A Map of all configurations for which the user associated
* with this UserContext has read access.
*/
public SimpleUserContext(User self,
Map<String, GuacamoleConfiguration> configs) {
this.self = self;
this.configDirectory =
new SimpleGuacamoleConfigurationDirectory(configs);
}
@Override
public User self() {
return self;
}
@Override
public GuacamoleConfigurationDirectory getGuacamoleConfigurationDirectory()
throws GuacamoleException {
return configDirectory;
}
@Override
public UserDirectory getUserDirectory() throws GuacamoleException {
throw new GuacamoleSecurityException("Permission denied.");
}
@Override
public PermissionDirectory getPermissionDirectory()
throws GuacamoleException {
throw new GuacamoleSecurityException("Permission denied.");
}
}