Skip to content

Commit 9ea6743

Browse files
shivangdoshi07shivangdoshi07
committed
Minor fixes in tests, sample config and flag update
1 parent 55a7ee1 commit 9ea6743

File tree

10 files changed

+53
-54
lines changed

10 files changed

+53
-54
lines changed

‎securityconfig/elasticsearch.yml.example‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@
77

88
############## Common configuration settings ##############
99

10-
# Enable or disable the Open Distro Security enterprise modules
11-
# By default enterprise modules are enabled. If you use any of the modules in production you need
12-
# to obtain a license. If you want to use the free Community Edition, you can switch
13-
# all enterprise features off by setting the following key to false
14-
opendistro_security.enterprise_modules_enabled: true
10+
# Enable or disable the Open Distro Security advanced modules
11+
# By default advanced modules are enabled, you can switch
12+
# all advanced features off by setting the following key to false
13+
opendistro_security.advanced_modules_enabled: true
1514

1615
# Specify a list of DNs which denote the other nodes in the cluster.
1716
# This settings support wildcards and regular expressions

‎src/main/java/com/amazon/opendistroforelasticsearch/security/OpenDistroSecurityPlugin.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ public final class OpenDistroSecurityPlugin extends OpenDistroSecuritySSLPlugin
189189
private volatile SslExceptionHandler sslExceptionHandler;
190190
private volatile Client localClient;
191191
private final boolean disabled;
192-
private final boolean enterpriseModulesEnabled;
192+
private final boolean advancedModulesEnabled;
193193
private final boolean sslOnly;
194194
private final List<String> demoCertHashes = new ArrayList<String>(3);
195195
private volatile OpenDistroSecurityFilter odsf;
@@ -227,7 +227,7 @@ public OpenDistroSecurityPlugin(final Settings settings, final Path configPath)
227227
this.tribeNodeClient = false;
228228
this.dlsFlsAvailable = false;
229229
this.dlsFlsConstructor = null;
230-
this.enterpriseModulesEnabled = false;
230+
this.advancedModulesEnabled = false;
231231
this.sslOnly = false;
232232
complianceConfig = null;
233233
log.warn("Open Distro Security plugin installed but disabled. This can expose your configuration (including passwords) to the public.");
@@ -240,7 +240,7 @@ public OpenDistroSecurityPlugin(final Settings settings, final Path configPath)
240240
this.tribeNodeClient = false;
241241
this.dlsFlsAvailable = false;
242242
this.dlsFlsConstructor = null;
243-
this.enterpriseModulesEnabled = false;
243+
this.advancedModulesEnabled = false;
244244
complianceConfig = null;
245245
log.warn("Open Distro Security plugin run in ssl only mode. No authentication or authorization is performed");
246246
return;
@@ -279,8 +279,8 @@ public Object run() {
279279
}
280280
});
281281

282-
enterpriseModulesEnabled = settings.getAsBoolean(ConfigConstants.OPENDISTRO_SECURITY_ENTERPRISE_MODULES_ENABLED, true);
283-
ReflectionHelper.init(enterpriseModulesEnabled);
282+
advancedModulesEnabled = settings.getAsBoolean(ConfigConstants.OPENDISTRO_SECURITY_ADVANCED_MODULES_ENABLED, true);
283+
ReflectionHelper.init(advancedModulesEnabled);
284284

285285
ReflectionHelper.registerMngtRestApiHandler(settings);
286286

@@ -870,7 +870,7 @@ public List<Setting<?>> getSettings() {
870870
settings.add(Setting.intSetting(ConfigConstants.OPENDISTRO_SECURITY_CACHE_TTL_MINUTES, 60, 0, Property.NodeScope, Property.Filtered));
871871

872872
//Security
873-
settings.add(Setting.boolSetting(ConfigConstants.OPENDISTRO_SECURITY_ENTERPRISE_MODULES_ENABLED, true, Property.NodeScope, Property.Filtered));
873+
settings.add(Setting.boolSetting(ConfigConstants.OPENDISTRO_SECURITY_ADVANCED_MODULES_ENABLED, true, Property.NodeScope, Property.Filtered));
874874
settings.add(Setting.boolSetting(ConfigConstants.OPENDISTRO_SECURITY_ALLOW_UNSAFE_DEMOCERTIFICATES, false, Property.NodeScope, Property.Filtered));
875875
settings.add(Setting.boolSetting(ConfigConstants.OPENDISTRO_SECURITY_ALLOW_DEFAULT_INIT_SECURITYINDEX, false, Property.NodeScope, Property.Filtered));
876876

‎src/main/java/com/amazon/opendistroforelasticsearch/security/auth/BackendRegistry.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -740,19 +740,19 @@ private User impersonate(final RestRequest request, final User originalUser) thr
740740
private <T> T newInstance(final String clazzOrShortcut, String type, final Settings settings, final Path configPath) {
741741

742742
String clazz = clazzOrShortcut;
743-
boolean isEnterprise = false;
743+
boolean isAdvancedModule = false;
744744

745745
if(authImplMap.containsKey(clazz+"_"+type)) {
746746
clazz = authImplMap.get(clazz+"_"+type);
747747
} else {
748-
isEnterprise = true;
748+
isAdvancedModule = true;
749749
}
750750

751-
if(ReflectionHelper.isEnterpriseAAAModule(clazz)) {
752-
isEnterprise = true;
751+
if(ReflectionHelper.isAdvancedModuleAAAModule(clazz)) {
752+
isAdvancedModule = true;
753753
}
754754

755-
return ReflectionHelper.instantiateAAA(clazz, settings, configPath, isEnterprise);
755+
return ReflectionHelper.instantiateAAA(clazz, settings, configPath, isAdvancedModule);
756756
}
757757

758758
private void destroyDestroyables() {

‎src/main/java/com/amazon/opendistroforelasticsearch/security/privileges/DlsFlsEvaluator.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public PrivilegesEvaluatorResponse evaluate(final ClusterService clusterService,
103103

104104

105105
// attach dls/fls map if not already done
106-
// TODO do this only if enterprise module are loaded
106+
// TODO do this only if advanced module are loaded
107107
final Tuple<Map<String, Set<String>>, Map<String, Set<String>>> dlsFls = securityRoles.getDlsFls(user, resolver, clusterService);
108108
final Map<String, Set<String>> dlsQueries = dlsFls.v1();
109109
final Map<String, Set<String>> flsFields = dlsFls.v2();

‎src/main/java/com/amazon/opendistroforelasticsearch/security/support/ConfigConstants.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ public class ConfigConstants {
191191
public static final String OPENDISTRO_SECURITY_KERBEROS_ACCEPTOR_PRINCIPAL = "opendistro_security.kerberos.acceptor_principal";
192192
public static final String OPENDISTRO_SECURITY_CERT_OID = "opendistro_security.cert.oid";
193193
public static final String OPENDISTRO_SECURITY_CERT_INTERCLUSTER_REQUEST_EVALUATOR_CLASS = "opendistro_security.cert.intercluster_request_evaluator_class";
194-
public static final String OPENDISTRO_SECURITY_ENTERPRISE_MODULES_ENABLED = "opendistro_security.enterprise_modules_enabled";
194+
public static final String OPENDISTRO_SECURITY_ADVANCED_MODULES_ENABLED = "opendistro_security.advanced_modules_enabled";
195195
public static final String OPENDISTRO_SECURITY_NODES_DN = "opendistro_security.nodes_dn";
196196
public static final String OPENDISTRO_SECURITY_DISABLED = "opendistro_security.disabled";
197197
public static final String OPENDISTRO_SECURITY_CACHE_TTL_MINUTES = "opendistro_security.cache.ttl_minutes";

‎src/main/java/com/amazon/opendistroforelasticsearch/security/support/ModuleInfo.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public Map<String, String> getAsMap() {
9494
Map<String, String> infoMap = new HashMap<>();
9595
infoMap.put("type", moduleType.name());
9696
infoMap.put("description", moduleType.getDescription());
97-
infoMap.put("is_enterprise", moduleType.isEnterprise().toString());
97+
infoMap.put("is_advanced_module", moduleType.isAdvancedModule().toString());
9898
infoMap.put("default_implementation", moduleType.getDefaultImplClass());
9999
infoMap.put("actual_implementation", this.classname);
100100
//infoMap.put("classpath", this.classpath); //this can disclose file locations

‎src/main/java/com/amazon/opendistroforelasticsearch/security/support/ModuleType.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public enum ModuleType implements Serializable {
7474

7575
private String description;
7676
private String defaultImplClass;
77-
private Boolean isEnterprise = Boolean.TRUE;
77+
private Boolean isAdvancedModule = Boolean.TRUE;
7878
private static Map<String, ModuleType> modulesMap = new HashMap<>();
7979

8080
static{
@@ -85,10 +85,10 @@ public enum ModuleType implements Serializable {
8585
}
8686
}
8787

88-
private ModuleType(String description, String defaultImplClass, Boolean isEnterprise) {
88+
private ModuleType(String description, String defaultImplClass, Boolean isAdvancedModule) {
8989
this.description = description;
9090
this.defaultImplClass = defaultImplClass;
91-
this.isEnterprise = isEnterprise;
91+
this.isAdvancedModule = isAdvancedModule;
9292
}
9393

9494
public static ModuleType getByDefaultImplClass(Class<?> clazz) {
@@ -132,8 +132,8 @@ public String getDefaultImplClass() {
132132
return defaultImplClass;
133133
}
134134

135-
public Boolean isEnterprise() {
136-
return isEnterprise;
135+
public Boolean isAdvancedModule() {
136+
return isAdvancedModule;
137137
}
138138

139139

‎src/main/java/com/amazon/opendistroforelasticsearch/security/support/ReflectionHelper.java‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ public static Set<ModuleInfo> getModulesLoaded() {
7777
return Collections.unmodifiableSet(modulesLoaded);
7878
}
7979

80-
private static boolean enterpriseModulesDisabled() {
81-
return !enterpriseModulesEnabled;
80+
private static boolean advancedModulesDisabled() {
81+
return !advancedModulesEnabled;
8282
}
8383

8484
public static void registerMngtRestApiHandler(final Settings settings) {
8585

86-
if (enterpriseModulesDisabled()) {
86+
if (advancedModulesDisabled()) {
8787
return;
8888
}
8989

@@ -106,7 +106,7 @@ public static Collection<RestHandler> instantiateMngtRestApiHandler(final Settin
106106
final Client localClient, final AdminDNs adminDns, final IndexBaseConfigurationRepository cr, final ClusterService cs, final PrincipalExtractor principalExtractor,
107107
final PrivilegesEvaluator evaluator, final ThreadPool threadPool, final AuditLog auditlog) {
108108

109-
if (enterpriseModulesDisabled()) {
109+
if (advancedModulesDisabled()) {
110110
return Collections.emptyList();
111111
}
112112

@@ -130,7 +130,7 @@ public static Collection<RestHandler> instantiateMngtRestApiHandler(final Settin
130130
@SuppressWarnings("rawtypes")
131131
public static Constructor instantiateDlsFlsConstructor() {
132132

133-
if (enterpriseModulesDisabled()) {
133+
if (advancedModulesDisabled()) {
134134
return null;
135135
}
136136

@@ -152,7 +152,7 @@ public static Constructor instantiateDlsFlsConstructor() {
152152

153153
public static DlsFlsRequestValve instantiateDlsFlsValve() {
154154

155-
if (enterpriseModulesDisabled()) {
155+
if (advancedModulesDisabled()) {
156156
return new DlsFlsRequestValve.NoopDlsFlsRequestValve();
157157
}
158158

@@ -172,7 +172,7 @@ public static DlsFlsRequestValve instantiateDlsFlsValve() {
172172
public static AuditLog instantiateAuditLog(final Settings settings, final Path configPath, final Client localClient, final ThreadPool threadPool,
173173
final IndexNameExpressionResolver resolver, final ClusterService clusterService) {
174174

175-
if (enterpriseModulesDisabled()) {
175+
if (advancedModulesDisabled()) {
176176
return new NullAuditLog();
177177
}
178178

@@ -194,7 +194,7 @@ public static AuditLog instantiateAuditLog(final Settings settings, final Path c
194194

195195
public static ComplianceIndexingOperationListener instantiateComplianceListener(ComplianceConfig complianceConfig, AuditLog auditlog) {
196196

197-
if (enterpriseModulesDisabled()) {
197+
if (advancedModulesDisabled()) {
198198
return new ComplianceIndexingOperationListener();
199199
}
200200

@@ -226,7 +226,7 @@ public static PrivilegesInterceptor instantiatePrivilegesInterceptorImpl(final I
226226

227227
final PrivilegesInterceptor noop = new PrivilegesInterceptor(resolver, clusterService, localClient, threadPool);
228228

229-
if (enterpriseModulesDisabled()) {
229+
if (advancedModulesDisabled()) {
230230
return noop;
231231
}
232232

@@ -248,8 +248,8 @@ public static PrivilegesInterceptor instantiatePrivilegesInterceptorImpl(final I
248248
@SuppressWarnings("unchecked")
249249
public static <T> T instantiateAAA(final String clazz, final Settings settings, final Path configPath, final boolean checkEnterprise) {
250250

251-
if (checkEnterprise && enterpriseModulesDisabled()) {
252-
throw new ElasticsearchException("Can not load '{}' because enterprise modules are disabled", clazz);
251+
if (checkEnterprise && advancedModulesDisabled()) {
252+
throw new ElasticsearchException("Can not load '{}' because advanced modules are disabled", clazz);
253253
}
254254

255255
try {
@@ -301,34 +301,34 @@ public static PrincipalExtractor instantiatePrincipalExtractor(final String claz
301301
}
302302
}
303303

304-
public static boolean isEnterpriseAAAModule(final String clazz) {
305-
boolean enterpriseModuleInstalled = false;
304+
public static boolean isAdvancedModuleAAAModule(final String clazz) {
305+
boolean advancedModuleInstalled = false;
306306

307307
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.ldap.backend.LDAPAuthorizationBackend")) {
308-
enterpriseModuleInstalled = true;
308+
advancedModuleInstalled = true;
309309
}
310310

311311
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.ldap.backend.LDAPAuthenticationBackend")) {
312-
enterpriseModuleInstalled = true;
312+
advancedModuleInstalled = true;
313313
}
314314

315315
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.http.jwt.HTTPJwtAuthenticator")) {
316-
enterpriseModuleInstalled = true;
316+
advancedModuleInstalled = true;
317317
}
318318

319319
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.http.jwt.keybyoidc.HTTPJwtKeyByOpenIdConnectAuthenticator")) {
320-
enterpriseModuleInstalled = true;
320+
advancedModuleInstalled = true;
321321
}
322322

323323
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.http.kerberos.HTTPSpnegoAuthenticator")) {
324-
enterpriseModuleInstalled = true;
324+
advancedModuleInstalled = true;
325325
}
326326

327327
if (clazz.equalsIgnoreCase("com.amazon.dlic.auth.http.saml.HTTPSamlAuthenticator")) {
328-
enterpriseModuleInstalled = true;
328+
advancedModuleInstalled = true;
329329
}
330330

331-
return enterpriseModuleInstalled;
331+
return advancedModuleInstalled;
332332
}
333333

334334
public static boolean addLoadedModule(Class<?> clazz) {
@@ -339,11 +339,11 @@ public static boolean addLoadedModule(Class<?> clazz) {
339339
return modulesLoaded.add(moduleInfo);
340340
}
341341

342-
private static boolean enterpriseModulesEnabled;
342+
private static boolean advancedModulesEnabled;
343343

344344
// TODO static hack
345-
public static void init(final boolean enterpriseModulesEnabled) {
346-
ReflectionHelper.enterpriseModulesEnabled = enterpriseModulesEnabled;
345+
public static void init(final boolean advancedModulesEnabled) {
346+
ReflectionHelper.advancedModulesEnabled = advancedModulesEnabled;
347347
}
348348

349349
private static ModuleInfo getModuleInfo(final Class<?> impl) {

‎src/test/java/com/amazon/opendistroforelasticsearch/security/test/AbstractSecurityUnitTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public abstract class AbstractSecurityUnitTest {
9797

9898
//TODO Test Matrix
9999
protected boolean allowOpenSSL = false; //disabled, we test this already in SSL Plugin
100-
//enable//disable enterprise modules
100+
//enable//disable advanced modules
101101
//1node and 3 node
102102

103103
@Rule

‎src/test/java/com/amazon/opendistroforelasticsearch/security/test/SingleClusterTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,21 @@ protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig
6060
setup(initTransportClientSettings, dynamicSecuritySettings, nodeOverride, true);
6161
}
6262

63-
protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig dynamicSecuritySettings, Settings nodeOverride, boolean initSeachGuardIndex) throws Exception {
64-
setup(initTransportClientSettings, dynamicSecuritySettings, nodeOverride, initSeachGuardIndex, ClusterConfiguration.DEFAULT);
63+
protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig dynamicSecuritySettings, Settings nodeOverride, boolean initOpendistroSecurityIndex) throws Exception {
64+
setup(initTransportClientSettings, dynamicSecuritySettings, nodeOverride, initOpendistroSecurityIndex, ClusterConfiguration.DEFAULT);
6565
}
6666

67-
protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig dynamicSecuritySettings, Settings nodeOverride, boolean initSeachGuardIndex, ClusterConfiguration clusterConfiguration) throws Exception {
67+
protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig dynamicSecuritySettings, Settings nodeOverride, boolean initOpendistroSecurityIndex, ClusterConfiguration clusterConfiguration) throws Exception {
6868
clusterInfo = clusterHelper.startCluster(minimumSecuritySettings(nodeOverride), clusterConfiguration);
69-
if(initSeachGuardIndex && dynamicSecuritySettings != null) {
69+
if(initOpendistroSecurityIndex && dynamicSecuritySettings != null) {
7070
initialize(clusterInfo, initTransportClientSettings, dynamicSecuritySettings);
7171
}
7272
}
7373

7474
protected void setup(Settings initTransportClientSettings, DynamicSecurityConfig dynamicSecuritySettings, Settings nodeOverride
75-
, boolean initSeachGuardIndex, ClusterConfiguration clusterConfiguration, int timeout, Integer nodes) throws Exception {
75+
, boolean initOpendistroSecurityIndex, ClusterConfiguration clusterConfiguration, int timeout, Integer nodes) throws Exception {
7676
clusterInfo = clusterHelper.startCluster(minimumSecuritySettings(nodeOverride), clusterConfiguration, timeout, nodes);
77-
if(initSeachGuardIndex) {
77+
if(initOpendistroSecurityIndex) {
7878
initialize(clusterInfo, initTransportClientSettings, dynamicSecuritySettings);
7979
}
8080
}

0 commit comments

Comments
 (0)