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

GUACAMOLE-197: Clean up comments and configured parameters.

Browse Source
This commit is contained in:
Nick Couchman
2018-01-15 15:02:37 -05:00
parent 8cf66bc3df
commit ab90606c81
6 changed files with 108 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/ConfigurationService.java
View File

@@ -53,8 +53,9 @@ public class ConfigurationService {
} }
/** /**
* Returns the authentication port of the RADIUS server configured with * Returns the UDP port that will be used to communicate authentication
* guacamole.properties. * and authorization information to the RADIUS server, as configured in
* guacamole.properties. By default this will be 1812.
* *
* @return * @return
* The authentication port of the RADIUS server, as configured with * The authentication port of the RADIUS server, as configured with
@@ -71,8 +72,9 @@ public class ConfigurationService {
} }
/** /**
* Returns the accounting port of the RADIUS server configured with * Returns the UDP port that will be used to communicate accounting
* guacamole.properties. * information to the RADIUS server, as configured in
* guacamole.properties. The default is 1813.
* *
* @return * @return
* The accouting port of the RADIUS server, as configured with * The accouting port of the RADIUS server, as configured with
@@ -89,8 +91,9 @@ public class ConfigurationService {
} }
/** /**
* Returns the shared secret of the RADIUS server configured with * Returns the shared secret used to communicate with the RADIUS server,
* guacamole.properties. * as configured in guacamole.properties. This must match the value
* in the RADIUS server configuration.
* *
* @return * @return
* The shared secret of the RADIUS server, as configured with * The shared secret of the RADIUS server, as configured with
@@ -106,8 +109,11 @@ public class ConfigurationService {
} }
/** /**
* Returns the authentication protocol of the RADIUS server * Returns the authentication protocol Guacamole should use when
* from guacamole.properties. * communicating with the RADIUS server, as configured in
* guacamole.properties. This must match the configuration
* of the RADIUS server, so that the RADIUS server and Guacamole
* client are "speaking the same language."
* *
* @return * @return
* The authentication protocol of the RADIUS server, * The authentication protocol of the RADIUS server,
@@ -123,8 +129,8 @@ public class ConfigurationService {
} }
/** /**
* Returns the number of retries for connecting to the RADIUS server * Returns the maximum number of retries for connecting to the RADIUS server
* from guacamole.properties. * from guacamole.properties. The default number of retries is 5.
* *
* @return * @return
* The number of retries for connection to the RADIUS server, * The number of retries for connection to the RADIUS server,
@@ -133,19 +139,19 @@ public class ConfigurationService {
* @throws GuacamoleException * @throws GuacamoleException
* If guacamole.properties cannot be parsed. * If guacamole.properties cannot be parsed.
*/ */
public int getRadiusRetries() throws GuacamoleException { public int getRadiusMaxRetries() throws GuacamoleException {
return environment.getProperty( return environment.getProperty(
RadiusGuacamoleProperties.RADIUS_RETRIES, RadiusGuacamoleProperties.RADIUS_MAX_RETRIES,
5 5
); );
} }
/** /**
* Returns the timeout for connecting to the RADIUS server * Returns the timeout, in seconds, for connecting to the RADIUS server
* from guacamole.properties. * from guacamole.properties. The default timeout is 60 seconds.
* *
* @return * @return
* The timeout for connection to the RADIUS server, * The timeout, in seconds, for connection to the RADIUS server,
* from guacamole.properties. * from guacamole.properties.
* *
* @throws GuacamoleException * @throws GuacamoleException
@@ -159,8 +165,9 @@ public class ConfigurationService {
} }
/** /**
* Returns the CA file for validating certificates for * Returns the CA file for validating certificates for encrypted
* encrypted connections as specified in guacamole.properties * connections to the RADIUS server, as configured in
* guacamole.properties.
* *
* @return * @return
* The file name for the CA file for validating * The file name for the CA file for validating
@@ -178,7 +185,8 @@ public class ConfigurationService {
/** /**
* Returns the key file for the client for creating encrypted * Returns the key file for the client for creating encrypted
* connections to RADIUS servers as specified in * connections to RADIUS servers as specified in
* guacamole.properties. * guacamole.properties. By default a file called radius.pem
* is used.
* *
* @return * @return
* The file name for the client certificate/key pair * The file name for the client certificate/key pair
@@ -213,7 +221,8 @@ public class ConfigurationService {
/** /**
* Returns the type of store that the CA file represents * Returns the type of store that the CA file represents
* so that it can be correctly processed by the RADIUS * so that it can be correctly processed by the RADIUS
* library, as configured in guacamole.properties. * library, as configured in guacamole.properties. By
* default the pem type is used.
* *
* @return * @return
* The type of store that the CA file is encoded * The type of store that the CA file is encoded
@@ -248,7 +257,8 @@ public class ConfigurationService {
/** /**
* Returns the type of store that the key file represents * Returns the type of store that the key file represents
* so that it can be correctly processed by the RADIUS * so that it can be correctly processed by the RADIUS
* library, as configured in guacamole.properties. * library, as configured in guacamole.properties. By
* default the pem type is used.
* *
* @return * @return
* The type of store that the key file is encoded * The type of store that the key file is encoded
@@ -268,7 +278,9 @@ public class ConfigurationService {
* Returns the boolean value of whether or not the * Returns the boolean value of whether or not the
* RADIUS library should trust all server certificates * RADIUS library should trust all server certificates
* or should validate them against known CA certificates, * or should validate them against known CA certificates,
* as configured in guacamole.properties. * as configured in guacamole.properties. By default
* this is false, indicating that server certificates
* must be validated against a known good CA.
* *
* @return * @return
* True if the RADIUS client should trust all * True if the RADIUS client should trust all

59
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/RadiusConnectionService.java
View File

@@ -26,6 +26,7 @@ import java.net.InetAddress;
import java.net.UnknownHostException; import java.net.UnknownHostException;
import java.security.NoSuchAlgorithmException; import java.security.NoSuchAlgorithmException;
import org.apache.guacamole.GuacamoleException; import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.GuacamoleServerException;
import org.apache.guacamole.environment.LocalEnvironment; import org.apache.guacamole.environment.LocalEnvironment;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
@@ -68,11 +69,15 @@ public class RadiusConnectionService {
* Creates a new instance of RadiusClient, configured with parameters * Creates a new instance of RadiusClient, configured with parameters
* from guacamole.properties. * from guacamole.properties.
* *
* @return
* A RadiusClient instance, configured with server, shared secret,
* ports, and timeout, as configured in guacamole.properties.
*
* @throws GuacamoleException * @throws GuacamoleException
* If an error occurs while parsing guacamole.properties, or if the * If an error occurs while parsing guacamole.properties, or if the
* configuration of RadiusClient fails. * configuration of RadiusClient fails.
*/ */
private RadiusClient createRadiusConnection() { private RadiusClient createRadiusConnection() throws GuacamoleException {
// Create the RADIUS client with the configuration parameters // Create the RADIUS client with the configuration parameters
try { try {
@@ -82,31 +87,34 @@ public class RadiusConnectionService {
confService.getRadiusAcctPort(), confService.getRadiusAcctPort(),
confService.getRadiusTimeout()); confService.getRadiusTimeout());
} }
catch (GuacamoleException e) {
logger.error("Unable to initialize RADIUS client: {}", e.getMessage());
logger.debug("Failed to init RADIUS client.", e);
}
catch (UnknownHostException e) { catch (UnknownHostException e) {
logger.error("Unable to resolve host: {}", e.getMessage());
logger.debug("Failed to resolve host.", e); logger.debug("Failed to resolve host.", e);
throw new GuacamoleServerException("Unable to resolve RADIUS server host.", e);
} }
catch (IOException e) { catch (IOException e) {
logger.error("Unable to communicate with host: {}", e.getMessage());
logger.debug("Failed to communicate with host.", e); logger.debug("Failed to communicate with host.", e);
throw new GuacamoleServerException("Failed to communicate with RADIUS server.", e);
} }
return null;
} }
/** /**
* Creates a new instance of RadiusAuthentictor, configured with * Creates a new instance of RadiusAuthentictor, configured with
* parameters specified within guacamole.properties. * parameters specified within guacamole.properties.
* *
* @param radiusClient
* A RadiusClient instance that has been initialized to
* communicate with a RADIUS server.
*
* @return * @return
* A new RadiusAuthenticator instance which has been configured * A new RadiusAuthenticator instance which has been configured
* with parameters from guacamole.properties, or null if * with parameters from guacamole.properties, or null if
* configuration fails. * configuration fails.
*
* @throws GuacamoleException
* If the configuration cannot be read or the inner protocol is
* not configured when the client is set up for a tunneled
* RADIUS connection.
*/ */
private RadiusAuthenticator setupRadiusAuthenticator(RadiusClient radiusClient) private RadiusAuthenticator setupRadiusAuthenticator(RadiusClient radiusClient)
throws GuacamoleException { throws GuacamoleException {
@@ -168,10 +176,13 @@ public class RadiusConnectionService {
* *
* @param username * @param username
* The username for the authentication * The username for the authentication
*
* @param secret
* The secret, usually a password or challenge response, to send
* to authenticate to the RADIUS server.
*
* @param state * @param state
* The previous state of the RADIUS connection * The previous state of the RADIUS connection
* @param response
* The response to the RADIUS challenge
* *
* @return * @return
* A RadiusPacket with the response of the server. * A RadiusPacket with the response of the server.
@@ -228,12 +239,12 @@ public class RadiusConnectionService {
radAuth.setupRequest(radiusClient, radAcc); radAuth.setupRequest(radiusClient, radAcc);
radAuth.processRequest(radAcc); radAuth.processRequest(radAcc);
RadiusResponse reply = radiusClient.sendReceive(radAcc, confService.getRadiusRetries()); RadiusResponse reply = radiusClient.sendReceive(radAcc, confService.getRadiusMaxRetries());
// We receive a Challenge not asking for user input, so silently process the challenge // We receive a Challenge not asking for user input, so silently process the challenge
while((reply instanceof AccessChallenge) && (reply.findAttribute(Attr_ReplyMessage.TYPE) == null)) { while((reply instanceof AccessChallenge) && (reply.findAttribute(Attr_ReplyMessage.TYPE) == null)) {
radAuth.processChallenge(radAcc, reply); radAuth.processChallenge(radAcc, reply);
reply = radiusClient.sendReceive(radAcc, confService.getRadiusRetries()); reply = radiusClient.sendReceive(radAcc, confService.getRadiusMaxRetries());
} }
return reply; return reply;
} }
@@ -252,6 +263,28 @@ public class RadiusConnectionService {
} }
} }
/**
* Send a challenge response to the RADIUS server by validating the input and
* then sending it along to the authenticate method.
*
* @param username
* The username to send to the RADIUS server for authentication.
*
* @param response
* The response phrase to send to the RADIUS server in response to the
* challenge previously provided.
*
* @param state
* The state data provided by the RADIUS server in order to continue
* the RADIUS conversation.
*
* @return
* A RadiusPacket containing the server's response to the authentication
* attempt.
*
* @throws GuacamoleException
* If an error is encountered trying to talk to the RADIUS server.
*/
public RadiusPacket sendChallengeResponse(String username, String response, String state) public RadiusPacket sendChallengeResponse(String username, String response, String state)
throws GuacamoleException { throws GuacamoleException {

8
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/RadiusGuacamoleProperties.java
View File

@@ -88,17 +88,17 @@ public class RadiusGuacamoleProperties {
}; };
/** /**
* The number of retries when attempting a RADIUS packet transaction. * The maximum number of retries when attempting a RADIUS packet transaction.
*/ */
public static final IntegerGuacamoleProperty RADIUS_RETRIES = new IntegerGuacamoleProperty() { public static final IntegerGuacamoleProperty RADIUS_MAX_RETRIES = new IntegerGuacamoleProperty() {
@Override @Override
public String getName() { return "radius-retries"; } public String getName() { return "radius-max-retries"; }
}; };
/** /**
* The network timeout when attempting a RADIUS packet transaction. * The network timeout, in seconds, when attempting a RADIUS packet transaction.
*/ */
public static final IntegerGuacamoleProperty RADIUS_TIMEOUT = new IntegerGuacamoleProperty() { public static final IntegerGuacamoleProperty RADIUS_TIMEOUT = new IntegerGuacamoleProperty() {

21
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/form/RadiusChallengeResponseField.java
View File

@@ -41,21 +41,28 @@ public class RadiusChallengeResponseField extends Field {
/** /**
* The message the RADIUS server sent back in the challenge. * The message the RADIUS server sent back in the challenge.
*/ */
private final String replyMsg; private final String challenge;
/** /**
* Initialize the field with the reply message and the state. * Initialize the field with the challenge sent back by the RADIUS server.
*
* @param challenge
* The challenge message sent back by the RADIUS server.
*/ */
public RadiusChallengeResponseField(String replyMsg) { public RadiusChallengeResponseField(String challenge) {
super(PARAMETER_NAME, RADIUS_FIELD_TYPE); super(PARAMETER_NAME, RADIUS_FIELD_TYPE);
this.replyMsg = replyMsg; this.challenge = challenge;
} }
/** /**
* Get the value of the replyMsg field. * Get the challenge sent by the RADIUS server.
*
* @return
* A String that indicates the challenge returned
* by the RADIUS server.
*/ */
public String getReplyMsg() { public String getChallenge() {
return replyMsg; return challenge;
} }
} }

11
extensions/guacamole-auth-radius/src/main/java/org/apache/guacamole/auth/radius/form/RadiusStateField.java
View File

@@ -45,7 +45,10 @@ public class RadiusStateField extends Field {
private final String radiusState; private final String radiusState;
/** /**
* Initialize the field with the reply message and the state. * Initialize the field with the state returned by the RADIUS server.
*
* @param radiusState
* The state returned by the RADIUS server.
*/ */
public RadiusStateField(String radiusState) { public RadiusStateField(String radiusState) {
super(PARAMETER_NAME, RADIUS_FIELD_TYPE); super(PARAMETER_NAME, RADIUS_FIELD_TYPE);
@@ -53,6 +56,12 @@ public class RadiusStateField extends Field {
} }
/**
* Get the state provided by the RADIUS server.
*
* @return
* The state provided by the RADIUS server.
*/
public String getRadiusState() { public String getRadiusState() {
return radiusState; return radiusState;
} }

2
extensions/guacamole-auth-radius/src/main/resources/controllers/radiusResponseController.js
View File

@@ -25,6 +25,6 @@ angular.module('guacRadius').controller('radiusResponseController', ['$scope', '
function radiusResponseController($scope, $injector) { function radiusResponseController($scope, $injector) {
// Populate the reply message field // Populate the reply message field
$scope.radiusPlaceholder = $scope.field.replyMsg; $scope.radiusPlaceholder = $scope.field.challenge;
}]); }]);