mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 05:07:41 +00:00
GUACAMOLE-1656: Add per-user KSM vault functionality.
This commit is contained in:
@@ -30,6 +30,16 @@ import org.apache.guacamole.form.Form;
|
||||
*/
|
||||
public interface VaultAttributeService {
|
||||
|
||||
/**
|
||||
* Return all custom connection attributes to be exposed through the
|
||||
* admin UI for the current vault implementation.
|
||||
*
|
||||
* @return
|
||||
* All custom connection attributes to be exposed through the
|
||||
* admin UI for the current vault implementation.
|
||||
*/
|
||||
public Collection<Form> getConnectionAttributes();
|
||||
|
||||
/**
|
||||
* Return all custom connection group attributes to be exposed through the
|
||||
* admin UI for the current vault implementation.
|
||||
@@ -39,4 +49,24 @@ public interface VaultAttributeService {
|
||||
* admin UI for the current vault implementation.
|
||||
*/
|
||||
public Collection<Form> getConnectionGroupAttributes();
|
||||
|
||||
/**
|
||||
* Return all custom user attributes to be exposed through the admin UI for
|
||||
* the current vault implementation.
|
||||
*
|
||||
* @return
|
||||
* All custom user attributes to be exposed through the admin UI for
|
||||
* the current vault implementation.
|
||||
*/
|
||||
public Collection<Form> getUserAttributes();
|
||||
|
||||
/**
|
||||
* Return all user preference attributes to be exposed through the user
|
||||
* preferences UI for the current vault implementation.
|
||||
*
|
||||
* @return
|
||||
* All user preference attributes to be exposed through the user
|
||||
* preferences UI for the current vault implementation.
|
||||
*/
|
||||
public Collection<Form> getUserPreferenceAttributes();
|
||||
}
|
||||
|
@@ -241,7 +241,7 @@ public class VaultUserContext extends TokenInjectingUserContext {
|
||||
*
|
||||
* @throws GuacamoleException
|
||||
* If the value for any applicable secret cannot be retrieved from the
|
||||
* vault due to an error.
|
||||
* vault due to an error.1
|
||||
*/
|
||||
private Map<String, Future<String>> getTokens(
|
||||
Connectable connectable, Map<String, String> tokenMapping,
|
||||
@@ -407,7 +407,6 @@ public class VaultUserContext extends TokenInjectingUserContext {
|
||||
TokenFilter filter = createFilter();
|
||||
filter.setToken(CONNECTION_NAME_TOKEN, connection.getName());
|
||||
filter.setToken(CONNECTION_IDENTIFIER_TOKEN, identifier);
|
||||
|
||||
// Add hostname and username tokens if available (implementations are
|
||||
// not required to expose connection configuration details)
|
||||
|
||||
@@ -439,17 +438,6 @@ public class VaultUserContext extends TokenInjectingUserContext {
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getConnectionGroupAttributes() {
|
||||
|
||||
// Add any custom attributes to any previously defined attributes
|
||||
return Collections.unmodifiableCollection(Stream.concat(
|
||||
super.getConnectionGroupAttributes().stream(),
|
||||
attributeService.getConnectionGroupAttributes().stream()
|
||||
).collect(Collectors.toList()));
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Directory<User> getUserDirectory() throws GuacamoleException {
|
||||
|
||||
@@ -490,6 +478,51 @@ public class VaultUserContext extends TokenInjectingUserContext {
|
||||
|
||||
// Defer to the vault-specific directory service
|
||||
return directoryService.getSharingProfileDirectory(super.getSharingProfileDirectory());
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getUserAttributes() {
|
||||
|
||||
// Add any custom attributes to any previously defined attributes
|
||||
return Collections.unmodifiableCollection(Stream.concat(
|
||||
super.getUserAttributes().stream(),
|
||||
attributeService.getUserAttributes().stream()
|
||||
).collect(Collectors.toList()));
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getUserPreferenceAttributes() {
|
||||
|
||||
// Add any custom preference attributes to any previously defined attributes
|
||||
return Collections.unmodifiableCollection(Stream.concat(
|
||||
super.getUserPreferenceAttributes().stream(),
|
||||
attributeService.getUserPreferenceAttributes().stream()
|
||||
).collect(Collectors.toList()));
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getConnectionAttributes() {
|
||||
|
||||
// Add any custom attributes to any previously defined attributes
|
||||
return Collections.unmodifiableCollection(Stream.concat(
|
||||
super.getConnectionAttributes().stream(),
|
||||
attributeService.getConnectionAttributes().stream()
|
||||
).collect(Collectors.toList()));
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getConnectionGroupAttributes() {
|
||||
|
||||
// Add any custom attributes to any previously defined attributes
|
||||
return Collections.unmodifiableCollection(Stream.concat(
|
||||
super.getConnectionGroupAttributes().stream(),
|
||||
attributeService.getConnectionGroupAttributes().stream()
|
||||
).collect(Collectors.toList()));
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
@@ -57,6 +57,7 @@ public class KsmAuthenticationProviderModule
|
||||
|
||||
// Bind services specific to Keeper Secrets Manager
|
||||
bind(KsmRecordService.class);
|
||||
bind(KsmAttributeService.class);
|
||||
bind(VaultAttributeService.class).to(KsmAttributeService.class);
|
||||
bind(VaultConfigurationService.class).to(KsmConfigurationService.class);
|
||||
bind(VaultSecretService.class).to(KsmSecretService.class);
|
||||
|
@@ -23,10 +23,13 @@ import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
|
||||
import org.apache.guacamole.GuacamoleException;
|
||||
import org.apache.guacamole.form.BooleanField;
|
||||
import org.apache.guacamole.form.Form;
|
||||
import org.apache.guacamole.form.TextField;
|
||||
import org.apache.guacamole.vault.conf.VaultAttributeService;
|
||||
|
||||
import com.google.inject.Inject;
|
||||
import com.google.inject.Singleton;
|
||||
|
||||
/**
|
||||
@@ -36,28 +39,81 @@ import com.google.inject.Singleton;
|
||||
@Singleton
|
||||
public class KsmAttributeService implements VaultAttributeService {
|
||||
|
||||
|
||||
@Inject
|
||||
private KsmConfigurationService configurationService;
|
||||
|
||||
/**
|
||||
* The name of the attribute which can contain a KSM configuration blob
|
||||
* associated with a connection group.
|
||||
* associated with either a connection group or user.
|
||||
*/
|
||||
public static final String KSM_CONFIGURATION_ATTRIBUTE = "ksm-config";
|
||||
|
||||
/**
|
||||
* All attributes related to configuring the KSM vault on a
|
||||
* per-connection-group basis.
|
||||
* per-connection-group or per-user basis.
|
||||
*/
|
||||
public static final Form KSM_CONFIGURATION_FORM = new Form("ksm-config",
|
||||
Arrays.asList(new TextField(KSM_CONFIGURATION_ATTRIBUTE)));
|
||||
|
||||
/**
|
||||
* All KSM-specific connection group attributes, organized by form.
|
||||
* All KSM-specific attributes for users or connection groups, organized by form.
|
||||
*/
|
||||
public static final Collection<Form> KSM_CONNECTION_GROUP_ATTRIBUTES =
|
||||
public static final Collection<Form> KSM_ATTRIBUTES =
|
||||
Collections.unmodifiableCollection(Arrays.asList(KSM_CONFIGURATION_FORM));
|
||||
|
||||
/**
|
||||
* The name of the attribute which can controls whether a KSM user configuration
|
||||
* is enabled on a connection-by-connection basis.
|
||||
*/
|
||||
public static final String KSM_USER_CONFIG_ENABLED_ATTRIBUTE = "ksm-user-config-enabled";
|
||||
|
||||
/**
|
||||
* The string value used by KSM attributes to represent the boolean value "true".
|
||||
*/
|
||||
public static final String TRUTH_VALUE = "true";
|
||||
|
||||
/**
|
||||
* All attributes related to configuring the KSM vault on a per-connection basis.
|
||||
*/
|
||||
public static final Form KSM_CONNECTION_FORM = new Form("ksm-config",
|
||||
Arrays.asList(new BooleanField(KSM_USER_CONFIG_ENABLED_ATTRIBUTE, TRUTH_VALUE)));
|
||||
|
||||
/**
|
||||
* All KSM-specific attributes for connections, organized by form.
|
||||
*/
|
||||
public static final Collection<Form> KSM_CONNECTION_ATTRIBUTES =
|
||||
Collections.unmodifiableCollection(Arrays.asList(KSM_CONNECTION_FORM));
|
||||
|
||||
@Override
|
||||
public Collection<Form> getConnectionAttributes() {
|
||||
return KSM_CONNECTION_ATTRIBUTES;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getConnectionGroupAttributes() {
|
||||
return KSM_CONNECTION_GROUP_ATTRIBUTES;
|
||||
return KSM_ATTRIBUTES;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getUserAttributes() {
|
||||
return KSM_ATTRIBUTES;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Form> getUserPreferenceAttributes() {
|
||||
|
||||
try {
|
||||
|
||||
// Expose the user attributes IFF user-level KSM configuration is enabled
|
||||
return configurationService.getAllowUserConfig() ? KSM_ATTRIBUTES : Collections.emptyList();
|
||||
|
||||
} catch (GuacamoleException e) {
|
||||
|
||||
// If the configuration can't be parsed, default to not exposing the attribute
|
||||
return Collections.emptyList();
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
@@ -84,6 +84,17 @@ public class KsmConfigurationService extends VaultConfigurationService {
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether users should be able to supply their own KSM configurations.
|
||||
*/
|
||||
private static final BooleanGuacamoleProperty ALLOW_USER_CONFIG = new BooleanGuacamoleProperty() {
|
||||
|
||||
@Override
|
||||
public String getName() {
|
||||
return "ksm-allow-user-config";
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Whether windows domains should be stripped off from usernames that are
|
||||
* read from the KSM vault.
|
||||
@@ -138,6 +149,21 @@ public class KsmConfigurationService extends VaultConfigurationService {
|
||||
return environment.getProperty(ALLOW_UNVERIFIED_CERT, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return whether users should be able to provide their own KSM configs.
|
||||
*
|
||||
* @return
|
||||
* true if users should be able to provide their own KSM configs,
|
||||
* false otherwise.
|
||||
*
|
||||
* @throws GuacamoleException
|
||||
* If the value specified within guacamole.properties cannot be
|
||||
* parsed.
|
||||
*/
|
||||
public boolean getAllowUserConfig() throws GuacamoleException {
|
||||
return environment.getProperty(ALLOW_USER_CONFIG, false);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean getSplitWindowsUsernames() throws GuacamoleException {
|
||||
return environment.getProperty(STRIP_WINDOWS_DOMAINS, false);
|
||||
|
@@ -26,8 +26,11 @@ import com.keepersecurity.secretsManager.core.SecretsManagerOptions;
|
||||
|
||||
import java.io.UnsupportedEncodingException;
|
||||
import java.net.URLEncoder;
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.HashSet;
|
||||
import java.util.Iterator;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
@@ -304,6 +307,34 @@ public class KsmSecretService implements VaultSecretService {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if user-level KSM configuration is enabled for the given
|
||||
* Connectable, false otherwise.
|
||||
*
|
||||
* @param connectable
|
||||
* The connectable to check for whether user-level KSM configs are
|
||||
* enabled.
|
||||
*
|
||||
* @return
|
||||
* True if user-level KSM configuration is enabled for the given
|
||||
* Connectable, false otherwise.
|
||||
*/
|
||||
private boolean isKsmUserConfigEnabled(Connectable connectable) {
|
||||
|
||||
// If it's a connection, user-level config is enabled IFF the appropriate
|
||||
// attribute is set to true
|
||||
if (connectable instanceof Connection)
|
||||
return KsmAttributeService.TRUTH_VALUE.equals(((Connection) connectable).getAttributes().get(
|
||||
KsmAttributeService.KSM_USER_CONFIG_ENABLED_ATTRIBUTE));
|
||||
|
||||
// KSM token replacement is not enabled for balancing groups, so for
|
||||
// now, user-level KSM configs will be explicitly disabled.
|
||||
// TODO: If token replacement is implemented for balancing groups,
|
||||
// implement this functionality for them as well.
|
||||
return false;
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, Future<String>> getTokens(UserContext userContext, Connectable connectable,
|
||||
GuacamoleConfiguration config, TokenFilter filter) throws GuacamoleException {
|
||||
@@ -314,78 +345,92 @@ public class KsmSecretService implements VaultSecretService {
|
||||
// Attempt to find a KSM config for this connection or group
|
||||
String ksmConfig = getConnectionGroupKsmConfig(userContext, connectable);
|
||||
|
||||
// Get a client instance for this KSM config
|
||||
KsmClient ksm = getClient(ksmConfig);
|
||||
// Create a list containing just the global / connection group config
|
||||
List<KsmClient> ksmClients = new ArrayList<>(2);
|
||||
ksmClients.add(getClient(ksmConfig));
|
||||
|
||||
// Retrieve and define server-specific tokens, if any
|
||||
String hostname = parameters.get("hostname");
|
||||
if (hostname != null && !hostname.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_SERVER_",
|
||||
ksm.getRecordByHost(filter.filter(hostname)));
|
||||
// Only use the user-specific KSM config if explicitly enabled in the global
|
||||
// configuration, AND for the specific connectable being connected to
|
||||
if (confService.getAllowUserConfig() && isKsmUserConfigEnabled(connectable)) {
|
||||
|
||||
// Tokens specific to RDP
|
||||
if ("rdp".equals(config.getProtocol())) {
|
||||
|
||||
// Retrieve and define gateway server-specific tokens, if any
|
||||
String gatewayHostname = parameters.get("gateway-hostname");
|
||||
if (gatewayHostname != null && !gatewayHostname.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_GATEWAY_",
|
||||
ksm.getRecordByHost(filter.filter(gatewayHostname)));
|
||||
|
||||
// Retrieve and define domain tokens, if any
|
||||
String domain = parameters.get("domain");
|
||||
String filteredDomain = null;
|
||||
if (domain != null && !domain.isEmpty()) {
|
||||
filteredDomain = filter.filter(domain);
|
||||
addRecordTokens(tokens, "KEEPER_DOMAIN_",
|
||||
ksm.getRecordByDomain(filteredDomain));
|
||||
}
|
||||
|
||||
// Retrieve and define gateway domain tokens, if any
|
||||
String gatewayDomain = parameters.get("gateway-domain");
|
||||
String filteredGatewayDomain = null;
|
||||
if (gatewayDomain != null && !gatewayDomain.isEmpty()) {
|
||||
filteredGatewayDomain = filter.filter(gatewayDomain);
|
||||
addRecordTokens(tokens, "KEEPER_GATEWAY_DOMAIN_",
|
||||
ksm.getRecordByDomain(filteredGatewayDomain));
|
||||
}
|
||||
|
||||
// If domain matching is disabled for user records,
|
||||
// explicitly set the domains to null when storing
|
||||
// user records to enable username-only matching
|
||||
if (!confService.getMatchUserRecordsByDomain()) {
|
||||
filteredDomain = null;
|
||||
filteredGatewayDomain = null;
|
||||
}
|
||||
|
||||
// Retrieve and define user-specific tokens, if any
|
||||
String username = parameters.get("username");
|
||||
if (username != null && !username.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_USER_",
|
||||
ksm.getRecordByLogin(filter.filter(username),
|
||||
filteredDomain));
|
||||
|
||||
// Retrieve and define gateway user-specific tokens, if any
|
||||
String gatewayUsername = parameters.get("gateway-username");
|
||||
if (gatewayUsername != null && !gatewayUsername.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_GATEWAY_USER_",
|
||||
ksm.getRecordByLogin(
|
||||
filter.filter(gatewayUsername),
|
||||
filteredGatewayDomain));
|
||||
// Find a user-specific KSM config, if one exists
|
||||
String userKsmConfig = userContext.self().getAttributes().get(
|
||||
KsmAttributeService.KSM_CONFIGURATION_ATTRIBUTE);
|
||||
|
||||
// If a user-specific config exsts, process it first
|
||||
if (userKsmConfig != null && !userKsmConfig.trim().isEmpty())
|
||||
ksmClients.add(0, getClient(userKsmConfig));
|
||||
}
|
||||
|
||||
else {
|
||||
// Iterate through the KSM clients, processing using the user-specific
|
||||
// config first (if it exists), to ensure that any admin-defined values
|
||||
// will override the user-speicifc values
|
||||
Iterator<KsmClient> ksmIterator = ksmClients.iterator();
|
||||
while (ksmIterator.hasNext()) {
|
||||
|
||||
// Retrieve and define user-specific tokens, if any
|
||||
// NOTE that non-RDP connections do not have a domain
|
||||
// field in the connection parameters, so the domain
|
||||
// will always be null
|
||||
String username = parameters.get("username");
|
||||
if (username != null && !username.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_USER_",
|
||||
ksm.getRecordByLogin(filter.filter(username), null));
|
||||
}
|
||||
KsmClient ksm = ksmIterator.next();
|
||||
|
||||
// Retrieve and define server-specific tokens, if any
|
||||
String hostname = parameters.get("hostname");
|
||||
if (hostname != null && !hostname.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_SERVER_",
|
||||
ksm.getRecordByHost(filter.filter(hostname)));
|
||||
|
||||
// Tokens specific to RDP
|
||||
if ("rdp".equals(config.getProtocol())) {
|
||||
// Retrieve and define domain tokens, if any
|
||||
String domain = parameters.get("domain");
|
||||
String filteredDomain = null;
|
||||
if (domain != null && !domain.isEmpty()) {
|
||||
filteredDomain = filter.filter(domain);
|
||||
addRecordTokens(tokens, "KEEPER_DOMAIN_",
|
||||
ksm.getRecordByDomain(filteredDomain));
|
||||
}
|
||||
|
||||
// Retrieve and define gateway domain tokens, if any
|
||||
String gatewayDomain = parameters.get("gateway-domain");
|
||||
String filteredGatewayDomain = null;
|
||||
if (gatewayDomain != null && !gatewayDomain.isEmpty()) {
|
||||
filteredGatewayDomain = filter.filter(gatewayDomain);
|
||||
addRecordTokens(tokens, "KEEPER_GATEWAY_DOMAIN_",
|
||||
ksm.getRecordByDomain(filteredGatewayDomain));
|
||||
}
|
||||
|
||||
// If domain matching is disabled for user records,
|
||||
// explicitly set the domains to null when storing
|
||||
// user records to enable username-only matching
|
||||
if (!confService.getMatchUserRecordsByDomain()) {
|
||||
filteredDomain = null;
|
||||
filteredGatewayDomain = null;
|
||||
}
|
||||
|
||||
// Retrieve and define user-specific tokens, if any
|
||||
String username = parameters.get("username");
|
||||
if (username != null && !username.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_USER_",
|
||||
ksm.getRecordByLogin(filter.filter(username),
|
||||
filteredDomain));
|
||||
|
||||
// Retrieve and define gateway user-specific tokens, if any
|
||||
String gatewayUsername = parameters.get("gateway-username");
|
||||
if (gatewayUsername != null && !gatewayUsername.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_GATEWAY_USER_",
|
||||
ksm.getRecordByLogin(
|
||||
filter.filter(gatewayUsername),
|
||||
filteredGatewayDomain));
|
||||
}
|
||||
|
||||
else {
|
||||
|
||||
// Retrieve and define user-specific tokens, if any
|
||||
// NOTE that non-RDP connections do not have a domain
|
||||
// field in the connection parameters, so the domain
|
||||
// will always be null
|
||||
String username = parameters.get("username");
|
||||
if (username != null && !username.isEmpty())
|
||||
addRecordTokens(tokens, "KEEPER_USER_",
|
||||
ksm.getRecordByLogin(filter.filter(username), null));
|
||||
}
|
||||
|
||||
return tokens;
|
||||
|
||||
|
@@ -0,0 +1,82 @@
|
||||
/*
|
||||
* 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.vault.ksm.user;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.guacamole.net.auth.DelegatingConnection;
|
||||
import org.apache.guacamole.net.auth.Connection;
|
||||
|
||||
import com.google.common.collect.Maps;
|
||||
|
||||
/**
|
||||
* A Connection that explicitly adds a blank entry for any defined
|
||||
* KSM connection attributes.
|
||||
*/
|
||||
public class KsmConnection extends DelegatingConnection {
|
||||
|
||||
/**
|
||||
* The names of all connection attributes defined for the vault.
|
||||
*/
|
||||
private List<String> connectionAttributeNames;
|
||||
|
||||
/**
|
||||
* Create a new Vault connection wrapping the provided Connection record. Any
|
||||
* attributes defined in the provided connection attribute forms will have empty
|
||||
* values automatically populated when getAttributes() is called.
|
||||
*
|
||||
* @param connection
|
||||
* The connection record to wrap.
|
||||
*
|
||||
* @param connectionAttributeNames
|
||||
* The names of all connection attributes to automatically expose.
|
||||
*/
|
||||
KsmConnection(Connection connection, List<String> connectionAttributeNames) {
|
||||
|
||||
super(connection);
|
||||
this.connectionAttributeNames = connectionAttributeNames;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the underlying wrapped connection record.
|
||||
*
|
||||
* @return
|
||||
* The wrapped connection record.
|
||||
*/
|
||||
Connection getUnderlyingConnection() {
|
||||
return getDelegateConnection();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, String> getAttributes() {
|
||||
|
||||
// Make a copy of the existing map
|
||||
Map<String, String> attributeMap = Maps.newHashMap(super.getAttributes());
|
||||
|
||||
// Add every defined attribute
|
||||
connectionAttributeNames.forEach(
|
||||
attributeName -> attributeMap.putIfAbsent(attributeName, null));
|
||||
|
||||
return attributeMap;
|
||||
}
|
||||
|
||||
}
|
@@ -26,13 +26,16 @@ import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import org.apache.guacamole.GuacamoleException;
|
||||
import org.apache.guacamole.language.TranslatableGuacamoleClientException;
|
||||
import org.apache.guacamole.net.auth.Attributes;
|
||||
import org.apache.guacamole.net.auth.Connection;
|
||||
import org.apache.guacamole.net.auth.ConnectionGroup;
|
||||
import org.apache.guacamole.net.auth.DecoratingDirectory;
|
||||
import org.apache.guacamole.net.auth.Directory;
|
||||
import org.apache.guacamole.net.auth.User;
|
||||
import org.apache.guacamole.vault.ksm.conf.KsmAttributeService;
|
||||
import org.apache.guacamole.vault.ksm.conf.KsmConfig;
|
||||
import org.apache.guacamole.vault.ksm.conf.KsmConfigurationService;
|
||||
@@ -57,6 +60,12 @@ public class KsmDirectoryService extends VaultDirectoryService {
|
||||
@Inject
|
||||
private KsmConfigurationService configurationService;
|
||||
|
||||
/**
|
||||
* Service for retrieving KSM-specific attributes.
|
||||
*/
|
||||
@Inject
|
||||
private KsmAttributeService ksmAttributeService;
|
||||
|
||||
/**
|
||||
* A singleton ObjectMapper for converting a Map to a JSON string when
|
||||
* generating a base64-encoded JSON KSM config blob.
|
||||
@@ -222,6 +231,36 @@ public class KsmDirectoryService extends VaultDirectoryService {
|
||||
|
||||
}
|
||||
|
||||
@Override
|
||||
public Directory<Connection> getConnectionDirectory(
|
||||
Directory<Connection> underlyingDirectory) throws GuacamoleException {
|
||||
|
||||
// A Connection directory that will intercept add and update calls to
|
||||
// validate KSM configurations, and translate one-time-tokens, if possible
|
||||
return new DecoratingDirectory<Connection>(underlyingDirectory) {
|
||||
|
||||
@Override
|
||||
protected Connection decorate(Connection connection) throws GuacamoleException {
|
||||
|
||||
// Wrap in a KsmConnection class to ensure that all defined KSM fields will be
|
||||
// present
|
||||
return new KsmConnection(
|
||||
connection,
|
||||
ksmAttributeService.getConnectionAttributes().stream().flatMap(
|
||||
form -> form.getFields().stream().map(field -> field.getName())
|
||||
).collect(Collectors.toList()));
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Connection undecorate(Connection connection) throws GuacamoleException {
|
||||
|
||||
// Unwrap the KsmUser
|
||||
return ((KsmConnection) connection).getUnderlyingConnection();
|
||||
}
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@Override
|
||||
public Directory<ConnectionGroup> getConnectionGroupDirectory(
|
||||
Directory<ConnectionGroup> underlyingDirectory) throws GuacamoleException {
|
||||
@@ -269,4 +308,52 @@ public class KsmDirectoryService extends VaultDirectoryService {
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
@Override
|
||||
public Directory<User> getUserDirectory(
|
||||
Directory<User> underlyingDirectory) throws GuacamoleException {
|
||||
|
||||
// A User directory that will intercept add and update calls to
|
||||
// validate KSM configurations, and translate one-time-tokens, if possible
|
||||
return new DecoratingDirectory<User>(underlyingDirectory) {
|
||||
|
||||
@Override
|
||||
public void add(User user) throws GuacamoleException {
|
||||
|
||||
// Check for the KSM config attribute and translate the one-time token
|
||||
// if possible before adding
|
||||
processAttributes(user);
|
||||
super.add(user);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void update(User user) throws GuacamoleException {
|
||||
|
||||
// Check for the KSM config attribute and translate the one-time token
|
||||
// if possible before updating
|
||||
processAttributes(user);
|
||||
super.update(user);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected User decorate(User user) throws GuacamoleException {
|
||||
|
||||
// Wrap in a KsmUser class to ensure that all defined KSM fields will be
|
||||
// present
|
||||
return new KsmUser(
|
||||
user,
|
||||
ksmAttributeService.getUserAttributes().stream().flatMap(
|
||||
form -> form.getFields().stream().map(field -> field.getName())
|
||||
).collect(Collectors.toList()));
|
||||
}
|
||||
|
||||
@Override
|
||||
protected User undecorate(User user) throws GuacamoleException {
|
||||
|
||||
// Unwrap the KsmUser
|
||||
return ((KsmUser) user).getUnderlyingUser();
|
||||
}
|
||||
|
||||
};
|
||||
}
|
||||
}
|
||||
|
@@ -0,0 +1,82 @@
|
||||
/*
|
||||
* 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.vault.ksm.user;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import org.apache.guacamole.net.auth.DelegatingUser;
|
||||
import org.apache.guacamole.net.auth.User;
|
||||
|
||||
import com.google.common.collect.Maps;
|
||||
|
||||
/**
|
||||
* A User that explicitly adds a blank entry for any defined
|
||||
* KSM user attributes.
|
||||
*/
|
||||
public class KsmUser extends DelegatingUser {
|
||||
|
||||
/**
|
||||
* The names of all user attributes defined for the vault.
|
||||
*/
|
||||
private List<String> userAttributeNames;
|
||||
|
||||
/**
|
||||
* Create a new Vault user wrapping the provided User record. Any
|
||||
* attributes defined in the provided user attribute forms will have empty
|
||||
* values automatically populated when getAttributes() is called.
|
||||
*
|
||||
* @param user
|
||||
* The user record to wrap.
|
||||
*
|
||||
* @param userAttributeNames
|
||||
* The names of all user attributes to automatically expose.
|
||||
*/
|
||||
KsmUser(User user, List<String> userAttributeNames) {
|
||||
|
||||
super(user);
|
||||
this.userAttributeNames = userAttributeNames;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the underlying wrapped user record.
|
||||
*
|
||||
* @return
|
||||
* The wrapped user record.
|
||||
*/
|
||||
User getUnderlyingUser() {
|
||||
return getDelegateUser();
|
||||
}
|
||||
|
||||
@Override
|
||||
public Map<String, String> getAttributes() {
|
||||
|
||||
// Make a copy of the existing map
|
||||
Map<String, String> attributeMap = Maps.newHashMap(super.getAttributes());
|
||||
|
||||
// Add every defined attribute
|
||||
userAttributeNames.forEach(
|
||||
attributeName -> attributeMap.putIfAbsent(attributeName, null));
|
||||
|
||||
return attributeMap;
|
||||
}
|
||||
|
||||
}
|
@@ -4,12 +4,22 @@
|
||||
"NAME" : "Keeper Secrets Manager"
|
||||
},
|
||||
|
||||
"CONNECTION_ATTRIBUTES" : {
|
||||
"SECTION_HEADER_KSM_CONFIG" : "Keeper Secrets Manager",
|
||||
"FIELD_HEADER_KSM_USER_CONFIG_ENABLED" : "Allow user-provided KSM configuration"
|
||||
},
|
||||
|
||||
"CONNECTION_GROUP_ATTRIBUTES" : {
|
||||
"SECTION_HEADER_KSM_CONFIG" : "Keeper Secrets Manager",
|
||||
"FIELD_HEADER_KSM_CONFIG" : "KSM Service Configuration ",
|
||||
|
||||
"ERROR_INVALID_KSM_CONFIG_BLOB" : "The provided base64-encoded KSM configuration blob is not valid. Please ensure that you have copied the entire blob.",
|
||||
"ERROR_INVALID_KSM_ONE_TIME_TOKEN" : "The provided configuration is not a valid KSM one-time token or base64-encoded configuration blob. Please ensure that you have copied the entire token value."
|
||||
},
|
||||
|
||||
"USER_ATTRIBUTES" : {
|
||||
"SECTION_HEADER_KSM_CONFIG" : "Keeper Secrets Manager",
|
||||
"FIELD_HEADER_KSM_CONFIG" : "KSM Service Configuration "
|
||||
}
|
||||
|
||||
}
|
||||
|
Reference in New Issue
Block a user