2 package net.sourceforge.guacamole.net.basic;
5 * Guacamole - Clientless Remote Desktop
6 * Copyright (C) 2010 Michael Jumper
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Affero General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
18 * You should have received a copy of the GNU Affero General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 import java.io.BufferedReader;
23 import net.sourceforge.guacamole.net.auth.AuthenticationProvider;
25 import java.io.FileReader;
26 import java.io.IOException;
27 import java.io.Reader;
28 import java.security.MessageDigest;
29 import java.security.NoSuchAlgorithmException;
30 import java.util.Collections;
31 import java.util.HashMap;
33 import net.sourceforge.guacamole.GuacamoleException;
34 import net.sourceforge.guacamole.net.auth.Credentials;
35 import net.sourceforge.guacamole.properties.FileGuacamoleProperty;
36 import net.sourceforge.guacamole.properties.GuacamoleProperties;
37 import net.sourceforge.guacamole.protocol.GuacamoleConfiguration;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40 import org.xml.sax.Attributes;
41 import org.xml.sax.InputSource;
42 import org.xml.sax.SAXException;
43 import org.xml.sax.XMLReader;
44 import org.xml.sax.helpers.DefaultHandler;
45 import org.xml.sax.helpers.XMLReaderFactory;
48 * Authenticates users against a static list of username/password pairs.
49 * Each username/password may be associated with multiple configurations.
50 * This list is stored in an XML file which is reread if modified.
52 * This is modified version of BasicFileAuthenticationProvider written by Michael Jumper.
54 * @author Michal Kotas
56 public class BasicFileAuthenticationProvider implements AuthenticationProvider {
58 private Logger logger = LoggerFactory.getLogger(BasicFileAuthenticationProvider.class);
60 private long mappingTime;
61 private Map<String, AuthInfo> mapping;
64 * The filename of the XML file to read the user mapping from.
66 public static final FileGuacamoleProperty BASIC_USER_MAPPING = new FileGuacamoleProperty() {
69 public String getName() { return "basic-user-mapping"; }
73 private File getUserMappingFile() throws GuacamoleException {
75 // Get user mapping file
76 return GuacamoleProperties.getProperty(BASIC_USER_MAPPING);
80 public synchronized void init() throws GuacamoleException {
82 // Get user mapping file
83 File mapFile = getUserMappingFile();
85 throw new GuacamoleException("Missing \"basic-user-mapping\" parameter required for basic login.");
87 logger.info("Reading user mapping file: {}", mapFile);
93 BasicUserMappingContentHandler contentHandler = new BasicUserMappingContentHandler();
95 XMLReader parser = XMLReaderFactory.createXMLReader();
96 parser.setContentHandler(contentHandler);
98 // Read and parse file
99 Reader reader = new BufferedReader(new FileReader(mapFile));
100 parser.parse(new InputSource(reader));
103 // Init mapping and record mod time of file
104 mappingTime = mapFile.lastModified();
105 mapping = contentHandler.getUserMapping();
108 catch (IOException e) {
109 throw new GuacamoleException("Error reading basic user mapping file.", e);
111 catch (SAXException e) {
112 throw new GuacamoleException("Error parsing basic user mapping XML.", e);
118 public Map<String, GuacamoleConfiguration> getAuthorizedConfigurations(Credentials credentials) throws GuacamoleException {
120 // Check mapping file mod time
121 File userMappingFile = getUserMappingFile();
122 if (userMappingFile.exists() && mappingTime < userMappingFile.lastModified()) {
124 // If modified recently, gain exclusive access and recheck
125 synchronized (this) {
126 if (userMappingFile.exists() && mappingTime < userMappingFile.lastModified()) {
127 logger.info("User mapping file {} has been modified.", userMappingFile);
128 init(); // If still not up to date, re-init
134 // If no mapping available, report as such
136 throw new GuacamoleException("User mapping could not be read.");
138 // Validate and return info for given user and pass
139 AuthInfo info = mapping.get(credentials.getUsername());
140 if (info != null && info.validate(credentials.getUsername(), credentials.getPassword())) {
142 //Map<String, GuacamoleConfiguration> configs = new HashMap<String, GuacamoleConfiguration>();
143 //configs.put("DEFAULT", info.getConfiguration());
146 Map<String, GuacamoleConfiguration> configs = info.getConfigurations();
155 public static class AuthInfo {
157 public static enum Encoding {
162 private String auth_username;
163 private String auth_password;
164 private Encoding auth_encoding;
166 private Map<String, GuacamoleConfiguration> configs;
168 public AuthInfo(String auth_username, String auth_password, Encoding auth_encoding) {
169 this.auth_username = auth_username;
170 this.auth_password = auth_password;
171 this.auth_encoding = auth_encoding;
173 configs = new HashMap<String, GuacamoleConfiguration>();
176 private static final char HEX_CHARS[] = {
177 '0', '1', '2', '3', '4', '5', '6', '7',
178 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
181 public static String getHexString(byte[] bytes) {
186 StringBuilder hex = new StringBuilder(2 * bytes.length);
187 for (byte b : bytes) {
188 hex.append(HEX_CHARS[(b & 0xF0) >> 4])
189 .append(HEX_CHARS[(b & 0x0F) ]);
192 return hex.toString();
197 public boolean validate(String username, String password) {
199 // If username matches
200 if (username != null && password != null && username.equals(auth_username)) {
202 switch (auth_encoding) {
207 return password.equals(auth_password);
211 // Compare hashed password
213 MessageDigest digest = MessageDigest.getInstance("MD5");
214 String hashedPassword = getHexString(digest.digest(password.getBytes()));
215 return hashedPassword.equals(auth_password.toUpperCase());
217 catch (NoSuchAlgorithmException e) {
218 throw new UnsupportedOperationException("Unexpected lack of MD5 support.", e);
229 public GuacamoleConfiguration getConfiguration(String name) {
231 return configs.get(name);
233 public Map<String, GuacamoleConfiguration> getConfigurations() {
236 public void addConfiguration(String name) {
237 configs.put(name, new GuacamoleConfiguration());
242 private static class BasicUserMappingContentHandler extends DefaultHandler {
244 private Map<String, AuthInfo> authMapping = new HashMap<String, AuthInfo>();
246 public Map<String, AuthInfo> getUserMapping() {
247 return Collections.unmodifiableMap(authMapping);
260 private State state = State.ROOT;
261 private AuthInfo current = null;
262 private String currentParameter = null;
263 private String currentConnection = null;
266 public void endElement(String uri, String localName, String qName) throws SAXException {
272 if (localName.equals("user-mapping")) {
281 if (localName.equals("authorize")) {
283 // Finalize mapping for this user
285 current.auth_username,
289 state = State.USER_MAPPING;
297 if (localName.equals("connection")) {
298 state = State.AUTH_INFO;
306 if (localName.equals("protocol")) {
307 state = State.CONNECTION;
315 if (localName.equals("param")) {
316 state = State.CONNECTION;
324 throw new SAXException("Tag not yet complete: " + localName);
329 public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
333 // Document must be <user-mapping>
336 if (localName.equals("user-mapping")) {
337 state = State.USER_MAPPING;
345 if (localName.equals("authorize")) {
347 AuthInfo.Encoding encoding;
348 String encodingString = attributes.getValue("encoding");
349 if (encodingString == null)
350 encoding = AuthInfo.Encoding.PLAIN_TEXT;
351 else if (encodingString.equals("plain"))
352 encoding = AuthInfo.Encoding.PLAIN_TEXT;
353 else if (encodingString.equals("md5"))
354 encoding = AuthInfo.Encoding.MD5;
356 throw new SAXException("Invalid encoding type");
359 current = new AuthInfo(
360 attributes.getValue("username"),
361 attributes.getValue("password"),
366 state = State.AUTH_INFO;
374 if (localName.equals("connection")) {
376 currentConnection = attributes.getValue("name");
377 if (currentConnection == null)
378 throw new SAXException("Attribute \"name\" required for param tag.");
380 current.addConfiguration(currentConnection);
383 state = State.CONNECTION;
391 if (localName.equals("protocol")) {
393 state = State.PROTOCOL;
397 if (localName.equals("param")) {
399 currentParameter = attributes.getValue("name");
400 if (currentParameter == null)
401 throw new SAXException("Attribute \"name\" required for param tag.");
404 state = State.PARAMETER;
412 throw new SAXException("Unexpected tag: " + localName);
417 public void characters(char[] ch, int start, int length) throws SAXException {
419 String str = new String(ch, start, length);
424 current.getConfiguration(currentConnection)
429 current.getConfiguration(currentConnection)
430 .setParameter(currentParameter, str);
435 if (str.trim().length() != 0)
436 throw new SAXException("Unexpected character data.");