org.apache.knox.gateway.config.impl.GatewayConfigImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateway-server Show documentation
Show all versions of gateway-server Show documentation
The gateway server implementation.
The newest version!
/*
* 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.knox.gateway.config.impl;
import static org.apache.knox.gateway.services.security.impl.RemoteAliasService.REMOTE_ALIAS_SERVICE_TYPE;
import java.io.File;
import java.net.InetSocketAddress;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.UnknownHostException;
import java.nio.file.Paths;
import java.security.KeyStore;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
import org.apache.commons.codec.digest.HmacAlgorithms;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.Path;
import org.apache.knox.gateway.GatewayMessages;
import org.apache.knox.gateway.config.GatewayConfig;
import org.apache.knox.gateway.dto.HomePageProfile;
import org.apache.knox.gateway.i18n.messages.MessagesFactory;
import org.apache.knox.gateway.services.security.impl.ZookeeperRemoteAliasService;
import org.eclipse.jetty.server.handler.ContextHandler;
import org.joda.time.Period;
import org.joda.time.format.PeriodFormatter;
import org.joda.time.format.PeriodFormatterBuilder;
/**
* The configuration for the Gateway.
*
* The Gateway configuration variables are described in gateway-default.xml
*
* The Gateway specific configuration is split into two layers:
*
* 1. gateway-default.xml - All the configuration variables that the
* Gateway needs. These are the defaults that ship with the app
* and should only be changed by the app developers.
*
* 2. gateway-site.xml - The (possibly empty) configuration that the
* system administrator can set variables for their Hadoop cluster.
*
* To find the gateway configuration files the following process is used.
* First, if the GATEWAY_HOME system property contains a valid directory name,
* an attempt will be made to read the configuration files from that directory.
* Second, if the GATEWAY_HOME environment variable contains a valid directory name,
* an attempt will be made to read the configuration files from that directory.
* Third, an attempt will be made to load the configuration files from the directory
* specified via the "user.dir" system property.
* Fourth, an attempt will be made to load the configuration files from the classpath.
* Last, defaults will be used for all values will be used.
*
* If GATEWAY_HOME isn't set via either the system property or environment variable then
* a value for this will be defaulted. The default selected will be the directory that
* contained the last loaded configuration file that was not contained in a JAR. If
* no such configuration file is loaded the value of the "user.dir" system property will be used
* as the value of GATEWAY_HOME. This is important to consider for any relative file names as they
* will be resolved relative to the value of GATEWAY_HOME. One such relative value is the
* name of the directory containing cluster topologies. This value default to "clusters".
*/
public class GatewayConfigImpl extends Configuration implements GatewayConfig {
private static final String GATEWAY_DEFAULT_TOPOLOGY_NAME_PARAM = "default.app.topology.name";
private static final String GATEWAY_DEFAULT_TOPOLOGY_NAME = "homepage";
private static final GatewayMessages log = MessagesFactory.get( GatewayMessages.class );
private static final String GATEWAY_CONFIG_DIR_PREFIX = "conf";
private static final String GATEWAY_CONFIG_FILE_PREFIX = "gateway";
private static final String DEFAULT_STACKS_SERVICES_DIR = "services";
private static final String DEFAULT_APPLICATIONS_DIR = "applications";
private static final String[] GATEWAY_CONFIG_FILENAMES = {GATEWAY_CONFIG_FILE_PREFIX + "-default.xml", GATEWAY_CONFIG_FILE_PREFIX + "-site.xml"};
private static final String GATEWAY_SERVICE_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".service.";
public static final String HTTP_HOST = GATEWAY_CONFIG_FILE_PREFIX + ".host";
public static final String HTTP_PORT = GATEWAY_CONFIG_FILE_PREFIX + ".port";
public static final String HTTP_PATH = GATEWAY_CONFIG_FILE_PREFIX + ".path";
public static final String DEPLOYMENT_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".deployment.dir";
public static final String SECURITY_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".security.dir";
public static final String DATA_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".data.dir";
public static final String STACKS_SERVICES_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".services.dir";
public static final String GLOBAL_RULES_SERVICES = GATEWAY_CONFIG_FILE_PREFIX + ".global.rules.services";
public static final String APPLICATIONS_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".applications.dir";
public static final String HADOOP_CONF_DIR = GATEWAY_CONFIG_FILE_PREFIX + ".hadoop.conf.dir";
public static final String FRONTEND_URL = GATEWAY_CONFIG_FILE_PREFIX + ".frontend.url";
private static final String TRUST_ALL_CERTS = GATEWAY_CONFIG_FILE_PREFIX + ".trust.all.certs";
private static final String CLIENT_AUTH_NEEDED = GATEWAY_CONFIG_FILE_PREFIX + ".client.auth.needed";
private static final String CLIENT_AUTH_WANTED = GATEWAY_CONFIG_FILE_PREFIX + ".client.auth.wanted";
private static final String KEYSTORE_TYPE = GATEWAY_CONFIG_FILE_PREFIX + ".keystore.type";
private static final String KEYSTORE_CACHE_LIMIT = GATEWAY_CONFIG_FILE_PREFIX + ".keystore.cache.size.limit";
private static final long DEFAULT_KEYSTORE_CACHE_LIMIT = 1000;
private static final String KEYSTORE_CACHE_ENTRY_TTL = GATEWAY_CONFIG_FILE_PREFIX + ".keystore.cache.entry.ttl";
private static final long DEFAULT_KEYSTORE_CACHE_ENTRY_TTL = 60;
private static final String XFORWARDED_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".xforwarded.enabled";
private static final String EPHEMERAL_DH_KEY_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".jdk.tls.ephemeralDHKeySize";
private static final String HTTP_CLIENT_MAX_CONNECTION = GATEWAY_CONFIG_FILE_PREFIX + ".httpclient.maxConnections";
private static final String HTTP_CLIENT_CONNECTION_TIMEOUT = GATEWAY_CONFIG_FILE_PREFIX + ".httpclient.connectionTimeout";
private static final String HTTP_CLIENT_SOCKET_TIMEOUT = GATEWAY_CONFIG_FILE_PREFIX + ".httpclient.socketTimeout";
private static final String THREAD_POOL_MAX = GATEWAY_CONFIG_FILE_PREFIX + ".threadpool.max";
public static final String HTTP_SERVER_REQUEST_BUFFER = GATEWAY_CONFIG_FILE_PREFIX + ".httpserver.requestBuffer";
public static final String HTTP_SERVER_REQUEST_HEADER_BUFFER = GATEWAY_CONFIG_FILE_PREFIX + ".httpserver.requestHeaderBuffer";
public static final String HTTP_SERVER_RESPONSE_BUFFER = GATEWAY_CONFIG_FILE_PREFIX + ".httpserver.responseBuffer";
public static final String HTTP_SERVER_RESPONSE_HEADER_BUFFER = GATEWAY_CONFIG_FILE_PREFIX + ".httpserver.responseHeaderBuffer";
public static final String DEPLOYMENTS_BACKUP_VERSION_LIMIT = GATEWAY_CONFIG_FILE_PREFIX + ".deployment.backup.versionLimit";
public static final String DEPLOYMENTS_BACKUP_AGE_LIMIT = GATEWAY_CONFIG_FILE_PREFIX + ".deployment.backup.ageLimit";
public static final String METRICS_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".metrics.enabled";
public static final String JMX_METRICS_REPORTING_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".jmx.metrics.reporting.enabled";
public static final String GRAPHITE_METRICS_REPORTING_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".graphite.metrics.reporting.enabled";
public static final String GRAPHITE_METRICS_REPORTING_HOST = GATEWAY_CONFIG_FILE_PREFIX + ".graphite.metrics.reporting.host";
public static final String GRAPHITE_METRICS_REPORTING_PORT = GATEWAY_CONFIG_FILE_PREFIX + ".graphite.metrics.reporting.port";
public static final String GRAPHITE_METRICS_REPORTING_FREQUENCY = GATEWAY_CONFIG_FILE_PREFIX + ".graphite.metrics.reporting.frequency";
public static final String GATEWAY_IDLE_TIMEOUT = GATEWAY_CONFIG_FILE_PREFIX + ".idle.timeout";
public static final String REMOTE_IP_HEADER_NAME = GATEWAY_CONFIG_FILE_PREFIX + ".remote.ip.header.name";
private static final String JETTY_MAX_FORM_CONTENT_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".jetty.max.form.content.size";
private static final String JETTY_MAX_FORM_KEYS = GATEWAY_CONFIG_FILE_PREFIX + ".jetty.max.form.keys";
/* @since 0.10 Websocket config variables */
public static final String WEBSOCKET_FEATURE_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.feature.enabled";
public static final String WEBSOCKET_MAX_TEXT_MESSAGE_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.max.text.size";
public static final String WEBSOCKET_MAX_BINARY_MESSAGE_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.max.binary.size";
public static final String WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.max.text.buffer.size";
public static final String WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.max.binary.buffer.size";
public static final String WEBSOCKET_INPUT_BUFFER_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.input.buffer.size";
public static final String WEBSOCKET_ASYNC_WRITE_TIMEOUT = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.async.write.timeout";
public static final String WEBSOCKET_IDLE_TIMEOUT = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.idle.timeout";
public static final String WEBSOCKET_MAX_WAIT_BUFFER_COUNT = GATEWAY_CONFIG_FILE_PREFIX + ".websocket.max.wait.buffer.count";
/* @since 2.0.0 WebShell config variables */
public static final String WEBSHELL_FEATURE_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".webshell.feature.enabled";
public static final String WEBSHELL_AUDIT_LOGGING_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".webshell.audit.logging.enabled";
public static final String WEBSHELL_MAX_CONCURRENT_SESSIONS = GATEWAY_CONFIG_FILE_PREFIX + ".webshell.max.concurrent.sessions";
public static final String WEBSHELL_READ_BUFFER_SIZE = GATEWAY_CONFIG_FILE_PREFIX + ".webshell.read.buffer.size";
/**
* Properties for for gateway port mapping feature
*/
public static final String GATEWAY_PORT_MAPPING_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".port.mapping.";
public static final String GATEWAY_PORT_MAPPING_REGEX = GATEWAY_CONFIG_FILE_PREFIX + "\\.port\\.mapping\\..*";
public static final String GATEWAY_PORT_MAPPING_ENABLED = GATEWAY_PORT_MAPPING_PREFIX + "enabled";
public static final String CLUSTER_CONFIG_MONITOR_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".cluster.config.monitor.";
public static final String CLUSTER_CONFIG_MONITOR_INTERVAL_SUFFIX = ".interval";
public static final String CLUSTER_CONFIG_MONITOR_ENABLED_SUFFIX = ".enabled";
// These config property names are not inline with the convention of using the
// GATEWAY_CONFIG_FILE_PREFIX as is done by those above. These are left for
// backward compatibility.
// LET'S NOT CONTINUE THIS PATTERN BUT LEAVE THEM FOR NOW.
private static final String SSL_ENABLED = "ssl.enabled";
private static final String SSL_INCLUDE_PROTOCOLS = "ssl.include.protocols";
private static final String SSL_EXCLUDE_PROTOCOLS = "ssl.exclude.protocols";
private static final String SSL_INCLUDE_CIPHERS = "ssl.include.ciphers";
private static final String SSL_EXCLUDE_CIPHERS = "ssl.exclude.ciphers";
private static final String SSL_RENEGOTIATION = "ssl.renegotiation";
// END BACKWARD COMPATIBLE BLOCK
public static final String DEFAULT_HTTP_PORT = "8888";
public static final String DEFAULT_HTTP_PATH = "gateway";
public static final String DEFAULT_DEPLOYMENT_DIR = "deployments";
public static final String DEFAULT_SECURITY_DIR = "security";
public static final String DEFAULT_DATA_DIR = "data";
private static final String PROVIDERCONFIG_DIR_NAME = "shared-providers";
private static final String DESCRIPTORS_DIR_NAME = "descriptors";
public static final String REMOTE_ALIAS_SERVICE_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".remote.alias.service.enabled";
public static final String STRICT_TOPOLOGY_VALIDATION = GATEWAY_CONFIG_FILE_PREFIX + ".strict.topology.validation";
private static final String TOPOLOGY_REDEPLOYMENT_REQUIRES_CHANGES = GATEWAY_CONFIG_FILE_PREFIX + ".topology.redeploy.requires.changes";
/**
* Comma-separated list of topology names, which should be forcibly treated as read-only.
* @since 1.1.0
*/
public static final String READ_ONLY_OVERRIDE_TOPOLOGIES =
GATEWAY_CONFIG_FILE_PREFIX + ".read.only.override.topologies";
public static final String READ_ONLY_OVERRIDE_PROVIDERS =
GATEWAY_CONFIG_FILE_PREFIX + ".read.only.override.providers";
/* Websocket defaults */
public static final boolean DEFAULT_WEBSOCKET_FEATURE_ENABLED = false;
public static final int DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE = Integer.MAX_VALUE;
public static final int DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE = Integer.MAX_VALUE;
public static final int DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE = 32768;
public static final int DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE = 32768;
public static final int DEFAULT_WEBSOCKET_INPUT_BUFFER_SIZE = 4096;
public static final int DEFAULT_WEBSOCKET_ASYNC_WRITE_TIMEOUT = 60000;
public static final int DEFAULT_WEBSOCKET_IDLE_TIMEOUT = 300000;
public static final int DEFAULT_WEBSOCKET_MAX_WAIT_BUFFER_COUNT = 100;
public static final boolean DEFAULT_WEBSHELL_FEATURE_ENABLED = false;
public static final boolean DEFAULT_WEBSHELL_AUDIT_LOGGING_ENABLED = false;
public static final int DEFAULT_WEBSHELL_MAX_CONCURRENT_SESSIONS = 3;
public static final int DEFAULT_WEBSHELL_READ_BUFFER_SIZE = 1024;
public static final boolean DEFAULT_GATEWAY_PORT_MAPPING_ENABLED = true;
public static final boolean DEFAULT_REMOTE_ALIAS_SERVICE_ENABLED = true;
public static final boolean DEFAULT_STRICT_TOPOLOGY_VALIDATION = false;
public static final String COOKIE_SCOPING_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".scope.cookies.feature.enabled";
public static final boolean DEFAULT_COOKIE_SCOPING_FEATURE_ENABLED = false;
private static final String CRYPTO_ALGORITHM = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.algorithm";
private static final String CRYPTO_PBE_ALGORITHM = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.pbe.algorithm";
private static final String CRYPTO_TRANSFORMATION = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.transformation";
private static final String CRYPTO_SALTSIZE = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.salt.size";
private static final String CRYPTO_ITERATION_COUNT = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.iteration.count";
private static final String CRYPTO_KEY_LENGTH = GATEWAY_CONFIG_FILE_PREFIX + ".crypto.key.length";
public static final String SERVER_HEADER_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".server.header.enabled";
/* @since 0.15 Remote configuration monitoring */
static final String CONFIG_REGISTRY_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".remote.config.registry";
static final String REMOTE_CONFIG_MONITOR_CLIENT_NAME = GATEWAY_CONFIG_FILE_PREFIX + ".remote.config.monitor.client";
static final String REMOTE_CONFIG_MONITOR_CLIENT_ALLOW_READ_ACCESS =
REMOTE_CONFIG_MONITOR_CLIENT_NAME + ".allowUnauthenticatedReadAccess";
private static final String REMOTE_CONFIG_MONITOR_DB_POLLING_INTERVAL_SECONDS = GATEWAY_CONFIG_FILE_PREFIX + ".remote.config.monitor.db.poll.interval.seconds";
private static final long REMOTE_CONFIG_MONITOR_DB_POLLING_INTERVAL_SECONDS_DEFAULT = 30;
private static final String REMOTE_CONFIG_MONITOR_DB_POLLING_CLEANUP_INTERVAL_SECONDS = GATEWAY_CONFIG_FILE_PREFIX + ".remote.config.monitor.db.cleanup.interval.seconds";
private static final int REMOTE_CONFIG_MONITOR_DB_POLLING_CLEANUP_INTERVAL_DEFAULT = 3 * 60 * 60;
/* @since 1.1.0 Default discovery configuration */
static final String DEFAULT_DISCOVERY_ADDRESS = GATEWAY_CONFIG_FILE_PREFIX + ".discovery.default.address";
static final String DEFAULT_DISCOVERY_CLUSTER = GATEWAY_CONFIG_FILE_PREFIX + ".discovery.default.cluster";
static final String KNOX_ADMIN_GROUPS = GATEWAY_CONFIG_FILE_PREFIX + ".knox.admin.groups";
static final String KNOX_ADMIN_USERS = GATEWAY_CONFIG_FILE_PREFIX + ".knox.admin.users";
/* property that specifies custom header name to be added to outgoing federated request */
static final String CUSTOM_FEDERATION_HEADER_NAME = GATEWAY_CONFIG_FILE_PREFIX + ".custom.federation.header.name";
/* Default federated header name, see HeaderPreAuthFederationFilter.headerName */
static final String DEFAULT_FEDERATION_HEADER_NAME = "SM_USER";
static final String AUTO_DEPLOY_TOPOLOGIES = GATEWAY_CONFIG_FILE_PREFIX + ".auto.deploy.topologies";
static final String DEFAULT_AUTO_DEPLOY_TOPOLOGIES = "manager,admin";
static final String DISPATCH_HOST_WHITELIST = GATEWAY_CONFIG_FILE_PREFIX + ".dispatch.whitelist";
static final String DISPATCH_HOST_WHITELIST_SERVICES = DISPATCH_HOST_WHITELIST + ".services";
static final String REMOTE_ALIAS_SERVICE_CONFIG_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".remote.alias.service.config.prefix";
static final String REMOTE_ALIAS_SERVICE_CONFIG_PREFIX_DEFAULT = GATEWAY_CONFIG_FILE_PREFIX + ".remote.alias.service.config.";
private static final List DEFAULT_GLOBAL_RULES_SERVICES = Arrays.asList(
"NAMENODE", "JOBTRACKER", "WEBHDFS", "WEBHCAT",
"OOZIE", "WEBHBASE", "HIVE", "RESOURCEMANAGER",
"RESOURCEMANAGERAPI");
/* property that specifies list of services for which we need to append service name to the X-Forward-Context header */
public static final String X_FORWARD_CONTEXT_HEADER_APPEND_SERVICES = GATEWAY_CONFIG_FILE_PREFIX + ".xforwarded.header.context.append.servicename";
private static final String TOKEN_STATE_SERVER_MANAGED = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.exp.server-managed";
private static final String CLOUDERA_MANAGER_DESCRIPTORS_MONITOR_INTERVAL = GATEWAY_CONFIG_FILE_PREFIX + ".cloudera.manager.descriptors.monitor.interval";
private static final String CLOUDERA_MANAGER_ADVANCED_SERVICE_DISCOVERY_CONF_MONITOR_INTERVAL = GATEWAY_CONFIG_FILE_PREFIX + ".cloudera.manager.advanced.service.discovery.config.monitor.interval";
private static final String CLOUDERA_MANAGER_SERVICE_DISCOVERY_REPOSITORY_CACHE_ENTRY_TTL = GATEWAY_CONFIG_FILE_PREFIX + ".cloudera.manager.service.discovery.repository.cache.entry.ttl";
private static final String CLOUDERA_MANAGER_SERVICE_DISCOVERY_MAX_RETRY_ATTEMPS = GATEWAY_CONFIG_FILE_PREFIX + ".cloudera.manager.service.discovery.maximum.retry.attemps";
private static final String KNOX_TOKEN_EVICTION_INTERVAL = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.eviction.interval";
private static final String KNOX_TOKEN_EVICTION_GRACE_PERIOD = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.eviction.grace.period";
private static final String KNOX_TOKEN_ALIAS_PERSISTENCE_INTERVAL = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.state.alias.persistence.interval";
private static final String KNOX_TOKEN_PERMISSIVE_VALIDATION_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.permissive.validation";
private static final String KNOX_TOKEN_HASH_ALGORITHM = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.hash.algorithm";
public static final String KNOX_TOKEN_USER_LIMIT = GATEWAY_CONFIG_FILE_PREFIX + ".knox.token.limit.per.user";
private static final long KNOX_TOKEN_EVICTION_INTERVAL_DEFAULT = TimeUnit.MINUTES.toSeconds(5);
private static final long KNOX_TOKEN_EVICTION_GRACE_PERIOD_DEFAULT = TimeUnit.HOURS.toSeconds(24);
private static final long KNOX_TOKEN_ALIAS_PERSISTENCE_INTERVAL_DEFAULT = TimeUnit.SECONDS.toSeconds(15);
public static final int KNOX_TOKEN_USER_LIMIT_DEFAULT = 10;
private static final boolean KNOX_TOKEN_PERMISSIVE_VALIDATION_ENABLED_DEFAULT = false;
private static final String KNOX_HOMEPAGE_PROFILE_PREFIX = "knox.homepage.profile.";
private static final String KNOX_HOMEPAGE_PINNED_TOPOLOGIES = "knox.homepage.pinned.topologies";
private static final String KNOX_HOMEPAGE_HIDDEN_TOPOLOGIES = "knox.homepage.hidden.topologies";
private static final Set KNOX_HOMEPAGE_HIDDEN_TOPOLOGIES_DEFAULT = new HashSet<>(Arrays.asList("admin", "manager", "knoxsso", "metadata", "homepage"));
private static final String KNOX_HOMEPAGE_LOGOUT_ENABLED = "knox.homepage.logout.enabled";
private static final String GLOBAL_LOGOUT_PAGE_URL = "knox.global.logout.page.url";
private static final String KNOX_INCOMING_XFORWARDED_ENABLED = "gateway.incoming.xforwarded.enabled";
//Gateway Database related properties
private static final String GATEWAY_DATABASE_TYPE = GATEWAY_CONFIG_FILE_PREFIX + ".database.type";
private static final String GATEWAY_DATABASE_CONN_URL = GATEWAY_CONFIG_FILE_PREFIX + ".database.connection.url";
private static final String GATEWAY_DATABASE_HOST = GATEWAY_CONFIG_FILE_PREFIX + ".database.host";
private static final String GATEWAY_DATABASE_PORT = GATEWAY_CONFIG_FILE_PREFIX + ".database.port";
private static final String GATEWAY_DATABASE_NAME = GATEWAY_CONFIG_FILE_PREFIX + ".database.name";
private static final String GATEWAY_DATABASE_SSL_ENABLED = GATEWAY_CONFIG_FILE_PREFIX + ".database.ssl.enabled";
private static final String GATEWAY_DATABASE_VERIFY_SERVER_CERT = GATEWAY_CONFIG_FILE_PREFIX + ".database.ssl.verify.server.cert";
private static final String GATEWAY_DATABASE_TRUSTSTORE_FILE = GATEWAY_CONFIG_FILE_PREFIX + ".database.ssl.truststore.file";
// Concurrent session properties
private static final String GATEWAY_SESSION_VERIFICATION_PREFIX = GATEWAY_CONFIG_FILE_PREFIX + ".session.verification";
private static final String GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USER_LIMIT = GATEWAY_SESSION_VERIFICATION_PREFIX + ".privileged.user.limit";
private static final String GATEWAY_SESSION_VERIFICATION_NON_PRIVILEGED_USER_LIMIT = GATEWAY_SESSION_VERIFICATION_PREFIX + ".non.privileged.user.limit";
private static final int GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USER_LIMIT_DEFAULT = 3;
private static final int GATEWAY_SESSION_VERIFICATION_NON_PRIVILEGED_USER_LIMIT_DEFAULT = 2;
private static final String GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USERS = GATEWAY_SESSION_VERIFICATION_PREFIX + ".privileged.users";
private static final String GATEWAY_SESSION_VERIFICATION_UNLIMITED_USERS = GATEWAY_SESSION_VERIFICATION_PREFIX + ".unlimited.users";
private static final String GATEWAY_SESSION_VERIFICATION_EXPIRED_TOKENS_CLEANING_PERIOD = GATEWAY_SESSION_VERIFICATION_PREFIX + ".expired.tokens.cleaning.period";
private static final long GATEWAY_SESSION_VERIFICATION_EXPIRED_TOKENS_CLEANING_PERIOD_DEFAULT = TimeUnit.MINUTES.toSeconds(30);
private static final String GATEWAY_SERVLET_ASYNC_SUPPORTED = GATEWAY_CONFIG_FILE_PREFIX + ".servlet.async.supported";
private static final boolean GATEWAY_SERVLET_ASYNC_SUPPORTED_DEFAULT = false;
public GatewayConfigImpl() {
init();
}
private String getVar( String variableName, String defaultValue ) {
String value = get( variableName );
if( value == null ) {
value = System.getProperty( variableName );
}
if( value == null ) {
value = System.getenv( variableName );
}
if( value == null ) {
value = defaultValue;
}
return value;
}
private String getGatewayHomeDir() {
return get(GATEWAY_HOME_VAR, System.getProperty(GATEWAY_HOME_VAR, System.getenv(GATEWAY_HOME_VAR)));
}
// directory for saving the PIDs spawned by knox
@Override
public String getGatewayPIDDir(){
String pidDir = getGatewayHomeDir() + File.separator + "pids";
return FilenameUtils.normalize(pidDir);
}
@Override
public String getGatewayConfDir() {
// 1st try: using the old style environment/system property name
@SuppressWarnings("deprecation")
String configDir = System.getProperty(GATEWAY_CONF_HOME_VAR, System.getenv(GATEWAY_CONF_HOME_VAR));
// 2nd try: using the new style environment/system property name or use the default value (relative to the GATEWAY_HOME)
if (StringUtils.isBlank(configDir)) {
configDir = getVar(KNOX_GATEWAY_CONF_DIR_VAR, getGatewayHomeDir() + File.separator + "conf");
}
return FilenameUtils.normalize(configDir);
}
@Override
public String getGatewayDataDir() {
// 1st try: using the old style environment/system property name
@SuppressWarnings("deprecation")
String dataDir = System.getProperty(GATEWAY_DATA_HOME_VAR, System.getenv(GATEWAY_DATA_HOME_VAR));
// 2nd try: using the new style environment/system property name
if (StringUtils.isBlank(dataDir)) {
dataDir = System.getProperty(KNOX_GATEWAY_DATA_DIR, System.getenv(KNOX_GATEWAY_DATA_DIR));
}
// 3rd try: fetching it from gateway-[default|site].xml or use the default value (relative to the GATEWAY_HOME)
if (StringUtils.isBlank(dataDir)) {
dataDir = get(DATA_DIR, getGatewayHomeDir() + File.separator + DEFAULT_DATA_DIR);
}
return FilenameUtils.normalize(dataDir);
}
@Override
public String getGatewayServicesDir() {
return get(STACKS_SERVICES_DIR, getGatewayDataDir() + File.separator + DEFAULT_STACKS_SERVICES_DIR);
}
@Override
public String getGatewayApplicationsDir() {
return get(APPLICATIONS_DIR, getGatewayDataDir() + File.separator + DEFAULT_APPLICATIONS_DIR);
}
@Override
public String getHadoopConfDir() {
return get( HADOOP_CONF_DIR );
}
private void init() {
// Load environment variables.
for( Map.Entry e : System.getenv().entrySet() ) {
set( "env." + e.getKey(), e.getValue() );
}
// Load system properties.
for( Map.Entry p : System.getProperties().entrySet() ) {
set( "sys." + p.getKey().toString(), p.getValue().toString() );
}
URL lastFileUrl = null;
for (String fileName : GATEWAY_CONFIG_FILENAMES) {
lastFileUrl = loadConfig(fileName);
}
initGatewayHomeDir( lastFileUrl );
// log whether the scoping cookies to the gateway.path feature is enabled
log.cookieScopingFeatureEnabled(isCookieScopingToPathEnabled());
}
private void initGatewayHomeDir( URL lastFileUrl ) {
String home = System.getProperty( GATEWAY_HOME_VAR );
if( home != null ) {
set( GATEWAY_HOME_VAR, home );
log.settingGatewayHomeDir( "system property", home );
return;
}
home = System.getenv( GATEWAY_HOME_VAR );
if( home != null ) {
set( GATEWAY_HOME_VAR, home );
log.settingGatewayHomeDir( "environment variable", home );
return;
}
if( lastFileUrl != null ) {
File file = new File( lastFileUrl.getFile() ).getAbsoluteFile();
File dir = file.getParentFile().getParentFile(); // Move up two levels to get to parent of conf.
if (dir.exists() && dir.canRead()) {
home = dir.getAbsolutePath();
}
set( GATEWAY_HOME_VAR, home );
log.settingGatewayHomeDir( "configuration file location", home );
return;
}
home = System.getProperty( "user.dir" );
if( home != null ) {
set( GATEWAY_HOME_VAR, home );
log.settingGatewayHomeDir( "user.dir system property", home );
}
}
// 1. Pre-defined configuration directory
// 2. GATEWAY_HOME system property
// 3. GATEWAY_HOME environment variable
// 4. user.dir system property
// 5. class path
private URL loadConfig( String fileName) {
URL configFileUrl = loadConfigFile(getGatewayConfDir(), fileName);
if (configFileUrl == null ) {
configFileUrl = loadConfigFile( System.getProperty( GATEWAY_HOME_VAR ), GATEWAY_CONFIG_DIR_PREFIX + File.separator + fileName );
}
if( configFileUrl == null ) {
configFileUrl = loadConfigFile( System.getenv( GATEWAY_HOME_VAR ), GATEWAY_CONFIG_DIR_PREFIX + File.separator + fileName );
}
if( configFileUrl == null ) {
configFileUrl = loadConfigFile( System.getProperty( "user.dir" ), GATEWAY_CONFIG_DIR_PREFIX + File.separator + fileName );
}
if( configFileUrl == null ) {
configFileUrl = loadConfigResource( GATEWAY_CONFIG_DIR_PREFIX + File.separator + fileName );
}
if( configFileUrl != null && !"file".equals( configFileUrl.getProtocol() ) ) {
configFileUrl = null;
}
return configFileUrl;
}
private URL loadConfigFile( String dir, String file ) {
URL url = null;
if( dir != null ) {
File f = new File( dir, file );
if( f.exists() ) {
String path = f.getAbsolutePath();
try {
url = f.toURI().toURL();
addResource( new Path( path ) );
log.loadingConfigurationFile( path );
} catch ( MalformedURLException e ) {
log.failedToLoadConfig( path, e );
}
}
}
return url;
}
private URL loadConfigResource( String file ) {
URL url = getResource( file );
if( url != null ) {
log.loadingConfigurationResource( url.toExternalForm() );
addResource( url );
}
return url;
}
@Override
public List getGatewayHost() {
String hosts = get( HTTP_HOST, "0.0.0.0" );
String[] hostArray = hosts.split(",");
List hostIps = new ArrayList<>();
for (String host : hostArray) {
hostIps.add(host.trim());
}
return hostIps;
}
@Override
public int getGatewayPort() {
return Integer.parseInt( get( HTTP_PORT, DEFAULT_HTTP_PORT ) );
}
@Override
public String getGatewayPath() {
return get( HTTP_PATH, DEFAULT_HTTP_PATH );
}
@Override
public String getGatewayProvidersConfigDir() {
return getGatewayConfDir() + File.separator + PROVIDERCONFIG_DIR_NAME;
}
@Override
public String getGatewayDescriptorsDir() {
return getGatewayConfDir() + File.separator + DESCRIPTORS_DIR_NAME;
}
@Override
public String getGatewayTopologyDir() {
return getGatewayConfDir() + File.separator + "topologies";
}
@Override
public String getGatewayDeploymentDir() {
return get(DEPLOYMENT_DIR, getGatewayDataDir() + File.separator + DEFAULT_DEPLOYMENT_DIR);
}
@Override
public String getGatewaySecurityDir() {
return get(SECURITY_DIR, getGatewayDataDir() + File.separator + DEFAULT_SECURITY_DIR);
}
@Override
public String getGatewayKeystoreDir() {
return Paths.get(getGatewaySecurityDir(), "keystores").toAbsolutePath().toString();
}
@Override
public List getGatewayAddress() throws UnknownHostException {
List hostIps = getGatewayHost();
int port = getGatewayPort();
List socketAddressList = new ArrayList<>();
for (String host : hostIps) {
socketAddressList.add(new InetSocketAddress( host, port ));
}
return socketAddressList;
}
@Override
public boolean isSSLEnabled() {
return Boolean.parseBoolean(get( SSL_ENABLED, "true" ));
}
@Override
public boolean isHadoopKerberosSecured() {
return Boolean.parseBoolean(get( HADOOP_KERBEROS_SECURED, "false" ));
}
@Override
public String getKerberosConfig() {
return get( KRB5_CONFIG ) ;
}
@Override
public boolean isKerberosDebugEnabled() {
return Boolean.parseBoolean(get( KRB5_DEBUG, "false" ));
}
@Override
public String getKerberosLoginConfig() {
return get( KRB5_LOGIN_CONFIG );
}
@Override
public String getDefaultTopologyName() {
String name = get(GATEWAY_DEFAULT_TOPOLOGY_NAME_PARAM);
return name != null ? name : GATEWAY_DEFAULT_TOPOLOGY_NAME;
}
@Override
public String getDefaultAppRedirectPath() {
String defTopo = getDefaultTopologyName();
if( defTopo == null ) {
return null;
} else {
return "/" + getGatewayPath() + "/" + defTopo;
}
}
@Override
public String getFrontendUrl() {
return get( FRONTEND_URL, null );
}
@Override
public Set getIncludedSSLProtocols() {
final Collection includedSslProtocols = getTrimmedStringCollection(SSL_INCLUDE_PROTOCOLS);
return includedSslProtocols == null ? Collections.emptySet() : new HashSet<>(includedSslProtocols);
}
@Override
public List getExcludedSSLProtocols() {
List protocols = null;
String value = get(SSL_EXCLUDE_PROTOCOLS);
if (!"none".equals(value)) {
protocols = Arrays.asList(value.split("\\s*,\\s*"));
}
return protocols;
}
@Override
public List getIncludedSSLCiphers() {
List list = null;
String value = get(SSL_INCLUDE_CIPHERS);
if (value != null && !value.isEmpty() && !"none".equalsIgnoreCase(value.trim())) {
list = Arrays.asList(value.trim().split("\\s*,\\s*"));
}
return list;
}
@Override
public List getExcludedSSLCiphers() {
List list = null;
String value = get(SSL_EXCLUDE_CIPHERS);
if (value != null && !value.isEmpty() && !"none".equalsIgnoreCase(value.trim())) {
list = Arrays.asList(value.trim().split("\\s*,\\s*"));
}
return list;
}
@Override
public boolean isSSLRenegotiationAllowed() {
return getBoolean(SSL_RENEGOTIATION, true);
}
@Override
public boolean isClientAuthNeeded() {
return Boolean.parseBoolean(get( CLIENT_AUTH_NEEDED, "false" ));
}
@Override
public boolean isClientAuthWanted() {
return Boolean.parseBoolean(get( CLIENT_AUTH_WANTED, "false" ));
}
@Override
public String getTruststorePath() {
return get( GATEWAY_TRUSTSTORE_PATH, null);
}
@Override
public boolean getTrustAllCerts() {
return Boolean.parseBoolean(get( TRUST_ALL_CERTS, "false" ));
}
@Override
public String getTruststoreType() {
return get( GATEWAY_TRUSTSTORE_TYPE, DEFAULT_GATEWAY_TRUSTSTORE_TYPE);
}
@Override
public String getTruststorePasswordAlias() {
return get( GATEWAY_TRUSTSTORE_PASSWORD_ALIAS, DEFAULT_GATEWAY_TRUSTSTORE_PASSWORD_ALIAS);
}
@Override
public String getKeystoreType() {
return get( KEYSTORE_TYPE, KeyStore.getDefaultType());
}
@Override
public boolean isXForwardedEnabled() {
return Boolean.parseBoolean(get( XFORWARDED_ENABLED, "true" ));
}
@Override
public String getEphemeralDHKeySize() {
return get( EPHEMERAL_DH_KEY_SIZE, "2048");
}
@Override
public int getHttpClientMaxConnections() {
return getInt( HTTP_CLIENT_MAX_CONNECTION, 32 );
}
@Override
public int getHttpClientConnectionTimeout() {
int t = -1;
String s = get( HTTP_CLIENT_CONNECTION_TIMEOUT, String.valueOf(TimeUnit.SECONDS.toMillis(20)));
if ( s != null ) {
try {
t = (int)parseNetworkTimeout( s );
} catch ( Exception e ) {
// Ignore it and use the default.
}
}
return t;
}
@Override
public int getHttpClientSocketTimeout() {
int t = -1;
String s = get( HTTP_CLIENT_SOCKET_TIMEOUT, String.valueOf(TimeUnit.SECONDS.toMillis(20)) );
if ( s != null ) {
try {
t = (int)parseNetworkTimeout( s );
} catch ( Exception e ) {
// Ignore it and use the default.
}
}
return t;
}
@Override
public String getHttpClientTruststorePath() {
return get(HTTP_CLIENT_TRUSTSTORE_PATH);
}
@Override
public String getHttpClientTruststoreType() {
return get(HTTP_CLIENT_TRUSTSTORE_TYPE, DEFAULT_HTTP_CLIENT_TRUSTSTORE_TYPE);
}
@Override
public String getHttpClientTruststorePasswordAlias() {
return get(HTTP_CLIENT_TRUSTSTORE_PASSWORD_ALIAS, DEFAULT_HTTP_CLIENT_TRUSTSTORE_PASSWORD_ALIAS);
}
@Override
public String getCredentialStoreAlgorithm() {
return get(CREDENTIAL_STORE_ALG, DEFAULT_CREDENTIAL_STORE_ALG);
}
@Override
public String getCredentialStoreType() {
return get(CREDENTIAL_STORE_TYPE, DEFAULT_CREDENTIAL_STORE_TYPE);
}
@Override
public int getThreadPoolMax() {
int i = getInt( THREAD_POOL_MAX, 254 );
// Testing has shown that a value lower than 5 prevents Jetty from servicing request.
if( i < 5 ) {
i = 5;
}
return i;
}
@Override
public int getHttpServerRequestBuffer() {
return getInt( HTTP_SERVER_REQUEST_BUFFER, 16 * 1024 );
}
@Override
public int getHttpServerRequestHeaderBuffer() {
return getInt( HTTP_SERVER_REQUEST_HEADER_BUFFER, 8 * 1024 );
}
@Override
public int getHttpServerResponseBuffer() {
return getInt( HTTP_SERVER_RESPONSE_BUFFER, 32 * 1024 );
}
@Override
public int getHttpServerResponseHeaderBuffer() {
return getInt( HTTP_SERVER_RESPONSE_HEADER_BUFFER, 8 * 1024 );
}
@Override
public int getGatewayDeploymentsBackupVersionLimit() {
int i = getInt( DEPLOYMENTS_BACKUP_VERSION_LIMIT, 5 );
if( i < 0 ) {
i = -1;
}
return i;
}
@Override
public long getGatewayIdleTimeout() {
return getLong(GATEWAY_IDLE_TIMEOUT, 300000L);
}
@Override
public long getGatewayDeploymentsBackupAgeLimit() {
PeriodFormatter f = new PeriodFormatterBuilder().appendDays().toFormatter();
String s = get( DEPLOYMENTS_BACKUP_AGE_LIMIT, "-1" );
long d;
try {
Period p = Period.parse( s, f );
d = p.toStandardDuration().getMillis();
if( d < 0 ) {
d = -1;
}
} catch( Exception e ) {
d = -1;
}
return d;
}
@Override
public String getIdentityKeystorePath() {
String keystorePath = get(IDENTITY_KEYSTORE_PATH);
if(StringUtils.isEmpty(keystorePath)) {
keystorePath = Paths.get(getGatewayKeystoreDir(), DEFAULT_GATEWAY_KEYSTORE_NAME).toAbsolutePath().toString();
}
return keystorePath;
}
@Override
public String getIdentityKeystoreType() {
return get(IDENTITY_KEYSTORE_TYPE, DEFAULT_IDENTITY_KEYSTORE_TYPE);
}
@Override
public String getIdentityKeystorePasswordAlias() {
return get(IDENTITY_KEYSTORE_PASSWORD_ALIAS, DEFAULT_IDENTITY_KEYSTORE_PASSWORD_ALIAS);
}
@Override
public String getIdentityKeyAlias() {
return get(IDENTITY_KEY_ALIAS, DEFAULT_IDENTITY_KEY_ALIAS);
}
@Override
public String getIdentityKeyPassphraseAlias() {
return get(IDENTITY_KEY_PASSPHRASE_ALIAS, DEFAULT_IDENTITY_KEY_PASSPHRASE_ALIAS);
}
@Override
public String getSigningKeystoreName() {
return get(SIGNING_KEYSTORE_NAME);
}
@Override
public String getSigningKeystorePath() {
if (getSigningKeystoreName() == null) {
return getIdentityKeystorePath();
} else {
return Paths.get(getGatewayKeystoreDir(), getSigningKeystoreName()).toAbsolutePath().toString();
}
}
@Override
public String getSigningKeystoreType() {
if (getSigningKeystoreName() == null) {
return getIdentityKeystoreType();
} else {
return get(SIGNING_KEYSTORE_TYPE, DEFAULT_SIGNING_KEYSTORE_TYPE);
}
}
@Override
public String getSigningKeyAlias() {
if (getSigningKeystoreName() == null) {
return getIdentityKeyAlias();
} else {
return get(SIGNING_KEY_ALIAS, DEFAULT_SIGNING_KEY_ALIAS);
}
}
@Override
public String getSigningKeystorePasswordAlias() {
if (getSigningKeystoreName() == null) {
return getIdentityKeystorePasswordAlias();
} else {
return get(SIGNING_KEYSTORE_PASSWORD_ALIAS, DEFAULT_SIGNING_KEYSTORE_PASSWORD_ALIAS);
}
}
@Override
public String getSigningKeyPassphraseAlias() {
if (getSigningKeystoreName() == null) {
return getIdentityKeyPassphraseAlias();
} else {
return get(SIGNING_KEY_PASSPHRASE_ALIAS, DEFAULT_SIGNING_KEY_PASSPHRASE_ALIAS);
}
}
@Override
public List getGlobalRulesServices() {
String value = get( GLOBAL_RULES_SERVICES );
if ( value != null && !value.isEmpty() && !"none".equalsIgnoreCase(value.trim()) ) {
return Arrays.asList( value.trim().split("\\s*,\\s*") );
}
return DEFAULT_GLOBAL_RULES_SERVICES;
}
@Override
public boolean isMetricsEnabled() {
return Boolean.parseBoolean(get( METRICS_ENABLED, "false" ));
}
@Override
public boolean isJmxMetricsReportingEnabled() {
return Boolean.parseBoolean(get( JMX_METRICS_REPORTING_ENABLED, "false" ));
}
@Override
public boolean isGraphiteMetricsReportingEnabled() {
return Boolean.parseBoolean(get( GRAPHITE_METRICS_REPORTING_ENABLED, "false" ));
}
@Override
public String getGraphiteHost() {
return get( GRAPHITE_METRICS_REPORTING_HOST, "localhost" );
}
@Override
public int getGraphitePort() {
return getInt( GRAPHITE_METRICS_REPORTING_PORT, 32772 );
}
@Override
public int getGraphiteReportingFrequency() {
return getInt( GRAPHITE_METRICS_REPORTING_FREQUENCY, 1 );
}
@Override
public boolean isWebsocketEnabled() {
return getBoolean(WEBSOCKET_FEATURE_ENABLED, DEFAULT_WEBSOCKET_FEATURE_ENABLED);
}
@Override
public boolean isWebShellEnabled() {
return getBoolean(WEBSHELL_FEATURE_ENABLED, DEFAULT_WEBSHELL_FEATURE_ENABLED);
}
@Override
public boolean isWebShellAuditLoggingEnabled(){
return getBoolean(WEBSHELL_AUDIT_LOGGING_ENABLED, DEFAULT_WEBSHELL_AUDIT_LOGGING_ENABLED);
}
@Override
public int getMaximumConcurrentWebshells(){
return getInt( WEBSHELL_MAX_CONCURRENT_SESSIONS, DEFAULT_WEBSHELL_MAX_CONCURRENT_SESSIONS);
}
@Override
public int getWebShellReadBufferSize(){
return getInt( WEBSHELL_READ_BUFFER_SIZE, DEFAULT_WEBSHELL_READ_BUFFER_SIZE);
}
@Override
public int getWebsocketMaxTextMessageSize() {
return getInt( WEBSOCKET_MAX_TEXT_MESSAGE_SIZE, DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE);
}
@Override
public int getWebsocketMaxBinaryMessageSize() {
return getInt( WEBSOCKET_MAX_BINARY_MESSAGE_SIZE, DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE);
}
@Override
public int getWebsocketMaxTextMessageBufferSize() {
return getInt( WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE, DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE);
}
@Override
public int getWebsocketMaxBinaryMessageBufferSize() {
return getInt( WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE, DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE);
}
@Override
public int getWebsocketInputBufferSize() {
return getInt( WEBSOCKET_INPUT_BUFFER_SIZE, DEFAULT_WEBSOCKET_INPUT_BUFFER_SIZE);
}
@Override
public int getWebsocketAsyncWriteTimeout() {
return getInt( WEBSOCKET_ASYNC_WRITE_TIMEOUT, DEFAULT_WEBSOCKET_ASYNC_WRITE_TIMEOUT);
}
@Override
public int getWebsocketIdleTimeout() {
return getInt( WEBSOCKET_IDLE_TIMEOUT, DEFAULT_WEBSOCKET_IDLE_TIMEOUT);
}
@Override
public int getWebsocketMaxWaitBufferCount() {
return getInt( WEBSOCKET_MAX_WAIT_BUFFER_COUNT, DEFAULT_WEBSOCKET_MAX_WAIT_BUFFER_COUNT);
}
@Override
public Map getGatewayPortMappings() {
final Map result = new ConcurrentHashMap<>();
final Map properties = getValByRegex(GATEWAY_PORT_MAPPING_REGEX);
// Convert port no. from string to int
for(final Map.Entry e : properties.entrySet()) {
// ignore the GATEWAY_PORT_MAPPING_ENABLED property
if(!e.getKey().equalsIgnoreCase(GATEWAY_PORT_MAPPING_ENABLED)) {
// extract the topology name and use it as a key
result.put(StringUtils.substringAfter(e.getKey(), GATEWAY_PORT_MAPPING_PREFIX), Integer.parseInt(e.getValue()) );
}
}
return Collections.unmodifiableMap(result);
}
@Override
public boolean isGatewayPortMappingEnabled() {
final String result = get( GATEWAY_PORT_MAPPING_ENABLED, Boolean.toString(DEFAULT_GATEWAY_PORT_MAPPING_ENABLED));
return Boolean.parseBoolean(result);
}
private static long parseNetworkTimeout(String s ) {
PeriodFormatter f = new PeriodFormatterBuilder()
.appendMinutes().appendSuffix("m"," min")
.appendSeconds().appendSuffix("s"," sec")
.appendMillis().toFormatter();
Period p = Period.parse( s, f );
return p.toStandardDuration().getMillis();
}
@Override
public boolean isCookieScopingToPathEnabled() {
return Boolean.parseBoolean(get(COOKIE_SCOPING_ENABLED,
Boolean.toString(DEFAULT_COOKIE_SCOPING_FEATURE_ENABLED)));
}
@Override
public String getHeaderNameForRemoteAddress() {
return getVar(REMOTE_IP_HEADER_NAME, "X-Forwarded-For");
}
@Override
public String getAlgorithm() {
return getVar(CRYPTO_ALGORITHM, null);
}
@Override
public String getPBEAlgorithm() {
return getVar(CRYPTO_PBE_ALGORITHM, null);
}
@Override
public String getTransformation() {
return getVar(CRYPTO_TRANSFORMATION, null);
}
@Override
public String getSaltSize() {
return getVar(CRYPTO_SALTSIZE, null);
}
@Override
public String getIterationCount() {
return getVar(CRYPTO_ITERATION_COUNT, null);
}
@Override
public String getKeyLength() {
return getVar(CRYPTO_KEY_LENGTH, null);
}
@Override
public boolean isGatewayServerHeaderEnabled() {
return Boolean.parseBoolean(getVar(SERVER_HEADER_ENABLED, "false"));
}
@Override
public String getDefaultDiscoveryAddress() {
return getVar(DEFAULT_DISCOVERY_ADDRESS, null);
}
@Override
public String getDefaultDiscoveryCluster() {
return getVar(DEFAULT_DISCOVERY_CLUSTER, null);
}
@Override
public int getClusterMonitorPollingInterval(String type) {
return getInt(CLUSTER_CONFIG_MONITOR_PREFIX + type.toLowerCase(Locale.ROOT) + CLUSTER_CONFIG_MONITOR_INTERVAL_SUFFIX, -1);
}
@Override
public boolean isClusterMonitorEnabled(String type) {
return getBoolean(CLUSTER_CONFIG_MONITOR_PREFIX + type.toLowerCase(Locale.ROOT) + CLUSTER_CONFIG_MONITOR_ENABLED_SUFFIX, false);
}
@Override
public List getRemoteRegistryConfigurationNames() {
List result = new ArrayList<>();
// Iterate over all the properties in this configuration
for (Map.Entry entry : this) {
String propertyName = entry.getKey();
// Search for all the remote config registry properties
if (propertyName.startsWith(CONFIG_REGISTRY_PREFIX)) {
String registryName = propertyName.substring(CONFIG_REGISTRY_PREFIX.length() + 1);
result.add(registryName);
}
}
return result;
}
@Override
public String getRemoteRegistryConfiguration(String name) {
return get(CONFIG_REGISTRY_PREFIX + "." + name );
}
@Override
public String getRemoteConfigurationMonitorClientName() {
return get(REMOTE_CONFIG_MONITOR_CLIENT_NAME);
}
@Override
public boolean allowUnauthenticatedRemoteRegistryReadAccess() {
return Boolean.parseBoolean(get(REMOTE_CONFIG_MONITOR_CLIENT_ALLOW_READ_ACCESS, String.valueOf(false)));
}
@Override
public boolean isRemoteAliasServiceEnabled() {
return getBoolean( REMOTE_ALIAS_SERVICE_ENABLED, DEFAULT_REMOTE_ALIAS_SERVICE_ENABLED);
}
@Override
public String getRemoteAliasServiceConfigurationPrefix() {
return get(REMOTE_ALIAS_SERVICE_CONFIG_PREFIX, REMOTE_ALIAS_SERVICE_CONFIG_PREFIX_DEFAULT);
}
@Override
public Map getRemoteAliasServiceConfiguration() {
final Map remoteAliasServiceConfiguration = getPropsWithPrefix(getRemoteAliasServiceConfigurationPrefix());
//in case the remote alias service configuration type is not set we default to zookeeper
if (!remoteAliasServiceConfiguration.containsKey(REMOTE_ALIAS_SERVICE_TYPE)) {
remoteAliasServiceConfiguration.put(REMOTE_ALIAS_SERVICE_TYPE, ZookeeperRemoteAliasService.TYPE);
}
return remoteAliasServiceConfiguration;
}
@Override
public List getReadOnlyOverrideTopologyNames() {
List topologyNames = new ArrayList<>();
String value = get(READ_ONLY_OVERRIDE_TOPOLOGIES);
if (value != null && !value.isEmpty()) {
topologyNames.addAll(Arrays.asList(value.trim().split("\\s*,\\s*")));
}
return topologyNames;
}
@Override
public List getReadOnlyOverrideProviderNames() {
List topologyNames = new ArrayList<>();
String value = get(READ_ONLY_OVERRIDE_PROVIDERS);
if (value != null && !value.isEmpty()) {
topologyNames.addAll(Arrays.asList(value.trim().split("\\s*,\\s*")));
}
return topologyNames;
}
@Override
public String getKnoxAdminGroups() {
return get(KNOX_ADMIN_GROUPS, null);
}
@Override
public String getKnoxAdminUsers() {
return get(KNOX_ADMIN_USERS, null);
}
@Override
public String getFederationHeaderName() {
return get(CUSTOM_FEDERATION_HEADER_NAME, DEFAULT_FEDERATION_HEADER_NAME);
}
@Override
public List getAutoDeployTopologyNames() {
String value = get(AUTO_DEPLOY_TOPOLOGIES);
if (value == null) {
value = DEFAULT_AUTO_DEPLOY_TOPOLOGIES;
}
return new ArrayList<>(Arrays.asList(value.trim().split("\\s*,\\s*")));
}
@Override
public String getDispatchWhitelist() {
return get(DISPATCH_HOST_WHITELIST);
}
@Override
public List getDispatchWhitelistServices() {
List result = new ArrayList<>();
String serviceList = get(DISPATCH_HOST_WHITELIST_SERVICES);
if (serviceList != null) {
for (String service : serviceList.split(",")) {
result.add(service.trim());
}
}
return result;
}
@Override
public boolean isTopologyValidationEnabled() {
final String result = get(STRICT_TOPOLOGY_VALIDATION, Boolean.toString(DEFAULT_STRICT_TOPOLOGY_VALIDATION));
return Boolean.parseBoolean(result);
}
@Override
public boolean topologyRedeploymentRequiresChanges() {
return getBoolean(TOPOLOGY_REDEPLOYMENT_REQUIRES_CHANGES, false);
}
@Override
public List getXForwardContextAppendServices() {
String value = get( X_FORWARD_CONTEXT_HEADER_APPEND_SERVICES );
if ( value != null && !value.isEmpty() && !"none".equalsIgnoreCase(value.trim()) ) {
return Arrays.asList( value.trim().split("\\s*,\\s*") );
} else {
return new ArrayList<>();
}
}
@Override
public Set getServicesToIgnoreDoAs() {
Set set = new HashSet<>();
String value = get( PROXYUSER_SERVICES_IGNORE_DOAS );
if (value != null) {
set.addAll(Arrays.asList(value.trim().toLowerCase(Locale.ROOT).split("\\s*,\\s*")));
}
return set;
}
@Override
public long getClouderaManagerDescriptorsMonitoringInterval() {
return getLong(CLOUDERA_MANAGER_DESCRIPTORS_MONITOR_INTERVAL, -1L);
}
@Override
public long getClouderaManagerAdvancedServiceDiscoveryConfigurationMonitoringInterval() {
return getLong(CLOUDERA_MANAGER_ADVANCED_SERVICE_DISCOVERY_CONF_MONITOR_INTERVAL, -1L);
}
@Override
public long getClouderaManagerServiceDiscoveryRepositoryEntryTTL() {
return getLong(CLOUDERA_MANAGER_SERVICE_DISCOVERY_REPOSITORY_CACHE_ENTRY_TTL, DEFAULT_CM_SERVICE_DISCOVERY_CACHE_ENTRY_TTL);
}
@Override
public int getClouderaManagerServiceDiscoveryMaximumRetryAttempts() {
return getInt(CLOUDERA_MANAGER_SERVICE_DISCOVERY_MAX_RETRY_ATTEMPS, DEFAULT_CM_SERVICE_DISCOVERY_MAX_RETRY_ATTEMPTS);
}
@Override
public boolean isServerManagedTokenStateEnabled() {
return getBoolean(TOKEN_STATE_SERVER_MANAGED, false);
}
@Override
public long getKnoxTokenEvictionInterval() {
return getLong(KNOX_TOKEN_EVICTION_INTERVAL, KNOX_TOKEN_EVICTION_INTERVAL_DEFAULT);
}
@Override
public long getKnoxTokenEvictionGracePeriod() {
return getLong(KNOX_TOKEN_EVICTION_GRACE_PERIOD, KNOX_TOKEN_EVICTION_GRACE_PERIOD_DEFAULT);
}
@Override
public long getKnoxTokenStateAliasPersistenceInterval() {
return getLong(KNOX_TOKEN_ALIAS_PERSISTENCE_INTERVAL, KNOX_TOKEN_ALIAS_PERSISTENCE_INTERVAL_DEFAULT);
}
@Override
public String getKnoxTokenHashAlgorithm() {
return get(KNOX_TOKEN_HASH_ALGORITHM, HmacAlgorithms.HMAC_SHA_256.getName());
}
@Override
public int getMaximumNumberOfTokensPerUser() {
return getInt(KNOX_TOKEN_USER_LIMIT, KNOX_TOKEN_USER_LIMIT_DEFAULT);
}
@Override
public Set getHiddenTopologiesOnHomepage() {
final Set hiddenTopologies = new HashSet<>(getTrimmedStringCollection(KNOX_HOMEPAGE_HIDDEN_TOPOLOGIES));
return hiddenTopologies == null || hiddenTopologies.isEmpty() ? KNOX_HOMEPAGE_HIDDEN_TOPOLOGIES_DEFAULT : hiddenTopologies;
}
@Override
public Set getPinnedTopologiesOnHomepage() {
final Collection pinnedTopologies = getTrimmedStringCollection(KNOX_HOMEPAGE_PINNED_TOPOLOGIES);
return pinnedTopologies == null ? Collections.emptySet() : new HashSet<>(pinnedTopologies);
}
/**
* @return returns whether know token permissive failure is enabled
*/
@Override
public boolean isKnoxTokenPermissiveValidationEnabled() {
return getBoolean(KNOX_TOKEN_PERMISSIVE_VALIDATION_ENABLED,
KNOX_TOKEN_PERMISSIVE_VALIDATION_ENABLED_DEFAULT);
}
@Override
public String getServiceParameter(String service, String parameter) {
return get(GATEWAY_SERVICE_PREFIX + service + "." + parameter, "");
}
@Override
public boolean homePageLogoutEnabled() {
return getBoolean(KNOX_HOMEPAGE_LOGOUT_ENABLED, false);
}
@Override
public String getGlobalLogoutPageUrl() {
return get(GLOBAL_LOGOUT_PAGE_URL);
}
@Override
public long getKeystoreCacheSizeLimit() {
return getLong(KEYSTORE_CACHE_LIMIT, DEFAULT_KEYSTORE_CACHE_LIMIT);
}
@Override
public long getKeystoreCacheEntryTimeToLiveInMinutes() {
return getLong(KEYSTORE_CACHE_ENTRY_TTL, DEFAULT_KEYSTORE_CACHE_ENTRY_TTL);
}
@Override
public boolean isGatewayServerIncomingXForwardedSupportEnabled() {
return getBoolean(KNOX_INCOMING_XFORWARDED_ENABLED, true);
}
@Override
public Map> getHomePageProfiles() {
final Map> profiles = getPreConfiguredProfiles(); // pre-configured profiles might be overwritten
this.forEach(config -> {
if (config.getKey().startsWith(KNOX_HOMEPAGE_PROFILE_PREFIX)) {
profiles.put(config.getKey().substring(KNOX_HOMEPAGE_PROFILE_PREFIX.length()).toLowerCase(Locale.getDefault()), getTrimmedStringCollection(config.getKey()));
}
});
return profiles;
}
private Map> getPreConfiguredProfiles() {
final Map> profiles = new HashMap<>();
profiles.put("full", HomePageProfile.getFullProfileElements());
profiles.put("thin", HomePageProfile.getThinProfileElemens());
profiles.put("token", HomePageProfile.getTokenProfileElements());
return profiles;
}
@Override
public String getDatabaseType() {
return get(GATEWAY_DATABASE_TYPE, "none");
}
@Override
public String getDatabaseConnectionUrl() {
return get(GATEWAY_DATABASE_CONN_URL);
}
@Override
public String getDatabaseHost() {
return get(GATEWAY_DATABASE_HOST);
}
@Override
public int getDatabasePort() {
return getInt(GATEWAY_DATABASE_PORT, 0);
}
@Override
public String getDatabaseName() {
return get(GATEWAY_DATABASE_NAME, "GATEWAY_DATABASE");
}
@Override
public boolean isDatabaseSslEnabled() {
return getBoolean(GATEWAY_DATABASE_SSL_ENABLED, false);
}
@Override
public boolean verifyDatabaseSslServerCertificate() {
return getBoolean(GATEWAY_DATABASE_VERIFY_SERVER_CERT, true);
}
@Override
public String getDatabaseSslTruststoreFileName() {
return get(GATEWAY_DATABASE_TRUSTSTORE_FILE);
}
@Override
public int getJettyMaxFormContentSize() {
return getInt(JETTY_MAX_FORM_CONTENT_SIZE, ContextHandler.DEFAULT_MAX_FORM_CONTENT_SIZE);
}
@Override
public int getJettyMaxFormKeys() {
return getInt(JETTY_MAX_FORM_KEYS, ContextHandler.DEFAULT_MAX_FORM_KEYS);
}
@Override
public int getPrivilegedUsersConcurrentSessionLimit() {
return getInt(GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USER_LIMIT, GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USER_LIMIT_DEFAULT);
}
@Override
public int getNonPrivilegedUsersConcurrentSessionLimit() {
return getInt(GATEWAY_SESSION_VERIFICATION_NON_PRIVILEGED_USER_LIMIT, GATEWAY_SESSION_VERIFICATION_NON_PRIVILEGED_USER_LIMIT_DEFAULT);
}
@Override
public Set getSessionVerificationPrivilegedUsers() {
final Collection privilegedUsers = getTrimmedStringCollection(GATEWAY_SESSION_VERIFICATION_PRIVILEGED_USERS);
return privilegedUsers == null ? Collections.emptySet() : new HashSet<>(privilegedUsers);
}
@Override
public Set getSessionVerificationUnlimitedUsers() {
final Collection nonPrivilegedUsers = getTrimmedStringCollection(GATEWAY_SESSION_VERIFICATION_UNLIMITED_USERS);
return nonPrivilegedUsers == null ? Collections.emptySet() : new HashSet<>(nonPrivilegedUsers);
}
@Override
public long getDbRemoteConfigMonitorPollingInterval() {
return getLong(REMOTE_CONFIG_MONITOR_DB_POLLING_INTERVAL_SECONDS, REMOTE_CONFIG_MONITOR_DB_POLLING_INTERVAL_SECONDS_DEFAULT);
}
@Override
public int getDbRemoteConfigMonitorCleanUpInterval() {
return getInt(REMOTE_CONFIG_MONITOR_DB_POLLING_CLEANUP_INTERVAL_SECONDS, REMOTE_CONFIG_MONITOR_DB_POLLING_CLEANUP_INTERVAL_DEFAULT);
}
@Override
public long getConcurrentSessionVerifierExpiredTokensCleaningPeriod() {
return getLong(GATEWAY_SESSION_VERIFICATION_EXPIRED_TOKENS_CLEANING_PERIOD, GATEWAY_SESSION_VERIFICATION_EXPIRED_TOKENS_CLEANING_PERIOD_DEFAULT);
}
@Override
public boolean isAsyncSupported() {
return getBoolean(GATEWAY_SERVLET_ASYNC_SUPPORTED, GATEWAY_SERVLET_ASYNC_SUPPORTED_DEFAULT);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy