Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Druid basic authentication class composition config #7789

Merged
merged 7 commits into from
Jun 6, 2019
Merged

Druid basic authentication class composition config #7789

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
46c925f
Druid basic authentication class composition config.
esevastyanov May 29, 2019
1a10500
Added comments
esevastyanov May 29, 2019
ce8c150
Reduced nulls
esevastyanov May 29, 2019
f173a59
Used noop implementations to get rid of null
esevastyanov May 30, 2019
64897b3
Added docs for no-op metadata storage updaters
esevastyanov May 30, 2019
ef5cf3b
Fixed BasicAuthClassCompositionConfig javadoc
esevastyanov May 31, 2019
92a7415
Removed incorrect comments
esevastyanov Jun 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions ...curity/src/main/java/org/apache/druid/security/basic/BasicAuthClassCompositionConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
* 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.druid.security.basic;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
* Basic authentication storage/cache/resource handler config.
* BasicAuthClassCompositionConfig provides options to specify authenticator/authorizer classes.
* If a field in this class is non-null then the corresponding class is instantiated
* regardless of what type of Druid component runs it (see {@link BasicSecurityDruidModule}).
* Hence every Druid component might be a user/role manager and notify others by sending notifications.
* Every field must be a valid class name (appropriate for the corresponding goal) or null.
*/
public class BasicAuthClassCompositionConfig
{
@JsonProperty
private final String authenticatorMetadataStorageUpdater;

@JsonProperty
private final String authenticatorCacheManager;

@JsonProperty
private final String authenticatorResourceHandler;

@JsonProperty
private final String authenticatorCacheNotifier;

@JsonProperty
private final String authorizerMetadataStorageUpdater;

@JsonProperty
private final String authorizerCacheManager;

@JsonProperty
private final String authorizerResourceHandler;

@JsonProperty
private final String authorizerCacheNotifier;

@JsonCreator
public BasicAuthClassCompositionConfig(
@JsonProperty("authenticatorMetadataStorageUpdater") String authenticatorMetadataStorageUpdater,
@JsonProperty("authenticatorCacheManager") String authenticatorCacheManager,
@JsonProperty("authenticatorResourceHandler") String authenticatorResourceHandler,
@JsonProperty("authenticatorCacheNotifier") String authenticatorCacheNotifier,
@JsonProperty("authorizerMetadataStorageUpdater") String authorizerMetadataStorageUpdater,
@JsonProperty("authorizerCacheManager") String authorizerCacheManager,
@JsonProperty("authorizerResourceHandler") String authorizerResourceHandler,
@JsonProperty("authorizerCacheNotifier") String authorizerCacheNotifier
)
{
this.authenticatorMetadataStorageUpdater = authenticatorMetadataStorageUpdater;
this.authenticatorCacheManager = authenticatorCacheManager;
this.authenticatorResourceHandler = authenticatorResourceHandler;
this.authenticatorCacheNotifier = authenticatorCacheNotifier;
this.authorizerMetadataStorageUpdater = authorizerMetadataStorageUpdater;
this.authorizerCacheManager = authorizerCacheManager;
this.authorizerResourceHandler = authorizerResourceHandler;
this.authorizerCacheNotifier = authorizerCacheNotifier;
}

@JsonProperty
public String getAuthenticatorMetadataStorageUpdater()
{
return authenticatorMetadataStorageUpdater;
}

@JsonProperty
public String getAuthenticatorCacheManager()
{
return authenticatorCacheManager;
}

@JsonProperty
public String getAuthenticatorResourceHandler()
{
return authenticatorResourceHandler;
}

@JsonProperty
public String getAuthenticatorCacheNotifier()
{
return authenticatorCacheNotifier;
}

@JsonProperty
public String getAuthorizerMetadataStorageUpdater()
{
return authorizerMetadataStorageUpdater;
}

@JsonProperty
public String getAuthorizerCacheManager()
{
return authorizerCacheManager;
}

@JsonProperty
public String getAuthorizerResourceHandler()
{
return authorizerResourceHandler;
}

@JsonProperty
public String getAuthorizerCacheNotifier()
{
return authorizerCacheNotifier;
}
}
181 changes: 125 additions & 56 deletions ...asic-security/src/main/java/org/apache/druid/security/basic/BasicSecurityDruidModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,10 @@
import org.apache.druid.security.basic.authentication.db.cache.CoordinatorBasicAuthenticatorCacheNotifier;
import org.apache.druid.security.basic.authentication.db.cache.CoordinatorPollingBasicAuthenticatorCacheManager;
import org.apache.druid.security.basic.authentication.db.cache.MetadataStoragePollingBasicAuthenticatorCacheManager;
import org.apache.druid.security.basic.authentication.db.cache.NoopBasicAuthenticatorCacheNotifier;
import org.apache.druid.security.basic.authentication.db.updater.BasicAuthenticatorMetadataStorageUpdater;
import org.apache.druid.security.basic.authentication.db.updater.CoordinatorBasicAuthenticatorMetadataStorageUpdater;
import org.apache.druid.security.basic.authentication.db.updater.NoopBasicAuthenticatorMetadataStorageUpdater;
import org.apache.druid.security.basic.authentication.endpoint.BasicAuthenticatorResource;
import org.apache.druid.security.basic.authentication.endpoint.BasicAuthenticatorResourceHandler;
import org.apache.druid.security.basic.authentication.endpoint.CoordinatorBasicAuthenticatorResourceHandler;
Expand All @@ -51,8 +53,10 @@
import org.apache.druid.security.basic.authorization.db.cache.CoordinatorBasicAuthorizerCacheNotifier;
import org.apache.druid.security.basic.authorization.db.cache.CoordinatorPollingBasicAuthorizerCacheManager;
import org.apache.druid.security.basic.authorization.db.cache.MetadataStoragePollingBasicAuthorizerCacheManager;
import org.apache.druid.security.basic.authorization.db.cache.NoopBasicAuthorizerCacheNotifier;
import org.apache.druid.security.basic.authorization.db.updater.BasicAuthorizerMetadataStorageUpdater;
import org.apache.druid.security.basic.authorization.db.updater.CoordinatorBasicAuthorizerMetadataStorageUpdater;
import org.apache.druid.security.basic.authorization.db.updater.NoopBasicAuthorizerMetadataStorageUpdater;
import org.apache.druid.security.basic.authorization.endpoint.BasicAuthorizerResource;
import org.apache.druid.security.basic.authorization.endpoint.BasicAuthorizerResourceHandler;
import org.apache.druid.security.basic.authorization.endpoint.CoordinatorBasicAuthorizerResourceHandler;
Expand All @@ -62,10 +66,12 @@

public class BasicSecurityDruidModule implements DruidModule
{

@Override
public void configure(Binder binder)
{
JsonConfigProvider.bind(binder, "druid.auth.basic.common", BasicAuthCommonCacheConfig.class);
JsonConfigProvider.bind(binder, "druid.auth.basic.composition", BasicAuthClassCompositionConfig.class);

LifecycleModule.register(binder, BasicAuthenticatorMetadataStorageUpdater.class);
LifecycleModule.register(binder, BasicAuthorizerMetadataStorageUpdater.class);
Expand All @@ -76,84 +82,124 @@ public void configure(Binder binder)
Jerseys.addResource(binder, BasicAuthorizerResource.class);
}

@Provides @LazySingleton
public static BasicAuthenticatorMetadataStorageUpdater createAuthenticatorStorageUpdater(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthenticatorMetadataStorageUpdater createAuthenticatorStorageUpdater(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthenticatorMetadataStorageUpdater.class);
} else {
return null;
}
return getInstance(
injector,
config.getAuthenticatorMetadataStorageUpdater(),
CoordinatorBasicAuthenticatorMetadataStorageUpdater.class,
NoopBasicAuthenticatorMetadataStorageUpdater.class
);
}

@Provides @LazySingleton
public static BasicAuthenticatorCacheManager createAuthenticatorCacheManager(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthenticatorCacheManager createAuthenticatorCacheManager(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(MetadataStoragePollingBasicAuthenticatorCacheManager.class);
} else {
return injector.getInstance(CoordinatorPollingBasicAuthenticatorCacheManager.class);
}
return getInstance(
injector,
config.getAuthenticatorCacheManager(),
MetadataStoragePollingBasicAuthenticatorCacheManager.class,
CoordinatorPollingBasicAuthenticatorCacheManager.class
);
}

@Provides @LazySingleton
public static BasicAuthenticatorResourceHandler createAuthenticatorResourceHandler(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthenticatorResourceHandler createAuthenticatorResourceHandler(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthenticatorResourceHandler.class);
} else {
return injector.getInstance(DefaultBasicAuthenticatorResourceHandler.class);
}
return getInstance(
injector,
config.getAuthenticatorResourceHandler(),
CoordinatorBasicAuthenticatorResourceHandler.class,
DefaultBasicAuthenticatorResourceHandler.class
);
}

@Provides @LazySingleton
public static BasicAuthenticatorCacheNotifier createAuthenticatorCacheNotifier(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthenticatorCacheNotifier createAuthenticatorCacheNotifier(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthenticatorCacheNotifier.class);
} else {
return null;
}
return getInstance(
injector,
config.getAuthenticatorCacheNotifier(),
CoordinatorBasicAuthenticatorCacheNotifier.class,
NoopBasicAuthenticatorCacheNotifier.class
);
}

@Provides @LazySingleton
public static BasicAuthorizerMetadataStorageUpdater createAuthorizerStorageUpdater(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthorizerMetadataStorageUpdater createAuthorizerStorageUpdater(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthorizerMetadataStorageUpdater.class);
} else {
return null;
}
return getInstance(
injector,
config.getAuthorizerMetadataStorageUpdater(),
CoordinatorBasicAuthorizerMetadataStorageUpdater.class,
NoopBasicAuthorizerMetadataStorageUpdater.class
);
}

@Provides @LazySingleton
public static BasicAuthorizerCacheManager createAuthorizerCacheManager(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthorizerCacheManager createAuthorizerCacheManager(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(MetadataStoragePollingBasicAuthorizerCacheManager.class);
} else {
return injector.getInstance(CoordinatorPollingBasicAuthorizerCacheManager.class);
}
return getInstance(
injector,
config.getAuthorizerCacheManager(),
MetadataStoragePollingBasicAuthorizerCacheManager.class,
CoordinatorPollingBasicAuthorizerCacheManager.class
);
}

@Provides @LazySingleton
public static BasicAuthorizerResourceHandler createAuthorizerResourceHandler(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthorizerResourceHandler createAuthorizerResourceHandler(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthorizerResourceHandler.class);
} else {
return injector.getInstance(DefaultBasicAuthorizerResourceHandler.class);
}
return getInstance(
injector,
config.getAuthorizerResourceHandler(),
CoordinatorBasicAuthorizerResourceHandler.class,
DefaultBasicAuthorizerResourceHandler.class
);
}

@Provides @LazySingleton
public static BasicAuthorizerCacheNotifier createAuthorizerCacheNotifier(final Injector injector)
@Provides
@LazySingleton
public static BasicAuthorizerCacheNotifier createAuthorizerCacheNotifier(
final Injector injector,
BasicAuthClassCompositionConfig config
) throws ClassNotFoundException
{
if (isCoordinator(injector)) {
return injector.getInstance(CoordinatorBasicAuthorizerCacheNotifier.class);
} else {
return null;
}
return getInstance(
injector,
config.getAuthorizerCacheNotifier(),
CoordinatorBasicAuthorizerCacheNotifier.class,
NoopBasicAuthorizerCacheNotifier.class
);
}

@Override
Expand All @@ -168,6 +214,29 @@ public List<? extends Module> getJacksonModules()
);
}

/**
* Returns the instance provided either by a config property or coordinator-run class or default class.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the semantics of this method are too complex. Maybe you can extract a method in fewer places, but they are simpler, e. g. they accept non-null parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Config based properties might be null so anyway there will be null-checks

* The order of check corresponds to the order of method params.
*/
private static <T> T getInstance(
Injector injector,
String configClassName,
Class<? extends T> classRunByCoordinator,
Class<? extends T> defaultClass
) throws ClassNotFoundException
{
if (configClassName != null) {
// ClassCastException is thrown in case of a mismatch, configuration fix is required.
@SuppressWarnings("unchecked")
final T instance = (T) injector.getInstance(Class.forName(configClassName));
return instance;
}
if (isCoordinator(injector)) {
return injector.getInstance(classRunByCoordinator);
}
return injector.getInstance(defaultClass);
}

private static boolean isCoordinator(Injector injector)
{
final String serviceName;
Expand Down
Loading