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-728: Refactor with EnumGuacamoleProperty and fix up comments.

Browse Source
This commit is contained in:
Virtually Nick
2020-06-13 22:34:01 -04:00
parent 8c2df77f2d
commit 31288fc4d0
7 changed files with 130 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-mysql/src/main/java/org/apache/guacamole/auth/mysql/conf/MySQLEnvironment.java
View File

@@ -318,22 +318,71 @@ public class MySQLEnvironment extends JDBCEnvironment {
* If an error occurs retrieving the property value.
*/
public MySQLSSLMode getMySQLSSLMode() throws GuacamoleException {
return getProperty(MySQLGuacamoleProperties.MYSQL_SSL_MODE,
return getProperty(
MySQLGuacamoleProperties.MYSQL_SSL_MODE,
DEFAULT_SSL_MODE);
}
/**
* Returns the File where the trusted certificate store is located as
* configured in guacamole.properties, or null if no value has been
* configured. The trusted certificate store is used to validate server
* certificates when making SSL connections to MySQL servers.
*
* @return
* The File where the trusted certificate store is located, or null
* if the value has not been configured.
*
* @throws GuacamoleException
* If guacamole.properties cannot be parsed.
*/
public File getMySQLSSLTrustStore() throws GuacamoleException {
return getProperty(MySQLGuacamoleProperties.MYSQL_SSL_TRUST_STORE);
}
/**
* Returns the password used to access the trusted certificate store as
* configured in guacamole.properties, or null if no password has been
* specified.
*
* @return
* The password used to access the trusted certificate store.
*
* @throws GuacamoleException
* If guacamole.properties cannot be parsed.
*/
public String getMySQLSSLTrustPassword() throws GuacamoleException {
return getProperty(MySQLGuacamoleProperties.MYSQL_SSL_TRUST_PASSWORD);
}
/**
* Returns the File used to store the client SSL certificate as configured
* in guacamole.properties, or null if no value has been specified. This
* file will be used to load the client certificate used for SSL connections
* to MySQL servers, if the SSL connection is so configured to require
* client certificate authentication.
*
* @return
* The File where the client SSL certificate is stored.
*
* @throws GuacamoleException
* If guacamole.properties cannot be parsed.
*/
public File getMySQLSSLClientStore() throws GuacamoleException {
return getProperty(MySQLGuacamoleProperties.MYSQL_SSL_TRUST_STORE);
}
/**
* Returns the password used to access the client certificate store as
* configured in guacamole.properties, or null if no value has been
* specified.
*
* @return
* The password used to access the client SSL certificate store.
*
* @throws GuacamoleException
* If guacamole.properties cannot be parsed.
*/
public String getMYSQLSSLClientPassword() throws GuacamoleException {
return getProperty(MySQLGuacamoleProperties.MYSQL_SSL_TRUST_PASSWORD);
}

28
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-mysql/src/main/java/org/apache/guacamole/auth/mysql/conf/MySQLGuacamoleProperties.java
View File

@@ -183,14 +183,19 @@ public class MySQLGuacamoleProperties {
* The SSL mode used to connect to the MySQL Server. By default SSL will
* not be used.
*/
public static final MySQLSSLProperty MYSQL_SSL_MODE =
new MySQLSSLProperty() {
public static final EnumGuacamoleProperty<MySQLSSLMode> MYSQL_SSL_MODE =
new EnumGuacamoleProperty<MySQLSSLMode>(MySQLSSLMode.class) {
@Override
public String getName() { return "mysql-ssl-mode" ; }
};
/**
* The File where trusted SSL certificate authorities and server certificates
* are stored. By default no file is specified, and the default Java
* trusted certificate stores will be used.
*/
public static final FileGuacamoleProperty MYSQL_SSL_TRUST_STORE =
new FileGuacamoleProperty() {
@@ -199,6 +204,10 @@ public class MySQLGuacamoleProperties {
};
/**
* The password to use to access the mysql-ssl-trust-store, if required. By
* default no password will be used to attempt to access the store.
*/
public static final StringGuacamoleProperty MYSQL_SSL_TRUST_PASSWORD =
new StringGuacamoleProperty() {
@@ -207,14 +216,25 @@ public class MySQLGuacamoleProperties {
};
public static final FileGuacamoleProperty MYSQL_SSL_CLIENT_STORE = new FileGuacamoleProperty() {
/**
* The File used to store the client certificate for configurations where
* a client certificate is required for authentication. By default no
* client certificate store will be specified.
*/
public static final FileGuacamoleProperty MYSQL_SSL_CLIENT_STORE =
new FileGuacamoleProperty() {
@Override
public String getName() { return "mysql-ssl-client-store"; }
};
public static final StringGuacamoleProperty MYSQL_SSL_CLIENT_PASSWORD = new StringGuacamoleProperty() {
/**
* The password to use to access the mysql-ssl-client-store file. By
* default no password will be used to attempt to access the file.
*/
public static final StringGuacamoleProperty MYSQL_SSL_CLIENT_PASSWORD =
new StringGuacamoleProperty() {
@Override
public String getName() { return "mysql-ssl-client-password"; }

28
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-mysql/src/main/java/org/apache/guacamole/auth/mysql/conf/MySQLSSLMode.java
View File

@@ -19,24 +19,42 @@
package org.apache.guacamole.auth.mysql.conf;
import org.apache.guacamole.properties.EnumGuacamoleProperty.PropertyValue;
/**
* Possible values for enabling SSL within the MySQL Driver.
*/
public enum MySQLSSLMode {
// Disable SSL altogether.
/**
* Do not use SSL at all.
*/
@PropertyValue("disabled")
DISABLED,
// Prefer SSL, but fall-back to non-SSL.
/**
* Prefer SSL, but fall back to unencrypted.
*/
@PropertyValue("preferred")
PREFERRED,
// Require SSL, but perform no verification.
/**
* Require SSL, but perform no certificate validation.
*/
@PropertyValue("required")
REQUIRED,
// Require SSL and verify a valid authority.
/**
* Require SSL, and validate server certificate issuer.
*/
@PropertyValue("verify-ca")
VERIFY_CA,
// Require SSL and verify a valid authority and server certificate.
/**
* Require SSL and validate both server certificate issuer and server
* identity.
*/
@PropertyValue("verify-identity")
VERIFY_IDENTITY;
}

57
extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-mysql/src/main/java/org/apache/guacamole/auth/mysql/conf/MySQLSSLProperty.java
View File

@@ -1,57 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.guacamole.auth.mysql.conf;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.GuacamoleServerException;
import org.apache.guacamole.properties.GuacamoleProperty;
/**
*
* @author nick_couchman
*/
public abstract class MySQLSSLProperty implements GuacamoleProperty<MySQLSSLMode> {
@Override
public MySQLSSLMode parseValue(String value) throws GuacamoleException {
if (value == null)
return null;
if (value.equals("disabled"))
return MySQLSSLMode.DISABLED;
if (value.equals("preferred"))
return MySQLSSLMode.PREFERRED;
if (value.equals("required"))
return MySQLSSLMode.REQUIRED;
if (value.equals("verify-ca"))
return MySQLSSLMode.VERIFY_CA;
if (value.equals("verify-identity"))
return MySQLSSLMode.VERIFY_IDENTITY;
throw new GuacamoleServerException("MySQL SSL mode set to invalid value.");
}
}