Skip to content

Commit

Permalink
[WFCORE-3819] custom-security-event-listener into Elytron
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Kalina committed Jul 27, 2018
1 parent 58f2bc7 commit e0d93f9
Show file tree
Hide file tree
Showing 11 changed files with 118 additions and 41 deletions.
15 changes: 15 additions & 0 deletions elytron/src/main/java/org/wildfly/extension/elytron/AuditLoggingParser.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,16 @@ class AuditLoggingParser {
.setUseElementsForGroups(false)
.addAttributes(AuditResourceDefinitions.SERVER_ADDRESS, AuditResourceDefinitions.PORT, AuditResourceDefinitions.TRANSPORT, AuditResourceDefinitions.HOST_NAME, AuditResourceDefinitions.FORMAT, AuditResourceDefinitions.SSL_CONTEXT)
.build();

private final PersistentResourceXMLDescription aggregateSecurityEventParser = builder(PathElement.pathElement(AGGREGATE_SECURITY_EVENT_LISTENER), null)
.addAttribute(AuditResourceDefinitions.REFERENCES, new AttributeParsers.NamedStringListParser(SECURITY_EVENT_LISTENER), new AttributeMarshallers.NamedStringListMarshaller(SECURITY_EVENT_LISTENER))
.build();

private final PersistentResourceXMLDescription customSecurityEventParser = builder(PathElement.pathElement(ElytronDescriptionConstants.CUSTOM_SECURITY_EVENT_LISTENER), null)
.addAttributes(CustomComponentDefinition.ATTRIBUTES)
.setUseElementsForGroups(false)
.build();

final PersistentResourceXMLDescription parser = decorator(ElytronDescriptionConstants.AUDIT_LOGGING)
.addChild(aggregateSecurityEventParser)
.addChild(fileAuditLogParser)
Expand All @@ -68,5 +75,13 @@ class AuditLoggingParser {
.addChild(syslogAuditLogParser)
.build();

final PersistentResourceXMLDescription parser4_0 = decorator(ElytronDescriptionConstants.AUDIT_LOGGING)
.addChild(aggregateSecurityEventParser)
.addChild(customSecurityEventParser) // new
.addChild(fileAuditLogParser)
.addChild(periodicRotatingFileAuditLogParser)
.addChild(sizeRotatingFileAuditLogParser)
.addChild(syslogAuditLogParser)
.build();

}
46 changes: 20 additions & 26 deletions elytron/src/main/java/org/wildfly/extension/elytron/CustomComponentDefinition.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

import static org.wildfly.extension.elytron.ClassLoadingAttributeDefinitions.CLASS_NAME;
import static org.wildfly.extension.elytron.ClassLoadingAttributeDefinitions.resolveClassLoader;
import static org.wildfly.extension.elytron.ElytronDefinition.commonDependencies;
import static org.wildfly.extension.elytron.ElytronDefinition.commonRequirements;
import static org.wildfly.extension.elytron.SecurityActions.doPrivileged;
import static org.wildfly.extension.elytron._private.ElytronSubsystemMessages.ROOT_LOGGER;

Expand All @@ -30,6 +30,7 @@
import java.util.Arrays;
import java.util.HashSet;
import java.util.Map;
import java.util.function.Function;

import org.jboss.as.controller.AbstractAddStepHandler;
import org.jboss.as.controller.AbstractWriteAttributeHandler;
Expand Down Expand Up @@ -58,7 +59,7 @@
*
* @author <a href="mailto:darran.lofthouse@jboss.com">Darran Lofthouse</a>
*/
class CustomComponentDefinition<T> extends SimpleResourceDefinition {
class CustomComponentDefinition<C, T> extends SimpleResourceDefinition {

static final SimpleAttributeDefinition MODULE = new SimpleAttributeDefinitionBuilder(ClassLoadingAttributeDefinitions.MODULE)
.setRequired(true)
Expand All @@ -70,25 +71,17 @@ class CustomComponentDefinition<T> extends SimpleResourceDefinition {
.setRestartAllServices()
.build();

private final Class<T> serviceType;
private final RuntimeCapability<?>[] runtimeCapabilities;
private final String pathKey;

static final AttributeDefinition[] ATTRIBUTES = {MODULE, CLASS_NAME, CONFIGURATION};

CustomComponentDefinition(Class<T> serviceType, String pathKey, @SuppressWarnings("rawtypes") RuntimeCapability ... runtimeCapabilities) {
CustomComponentDefinition(Class<C> serviceType, Function<C, T> wrapper, String pathKey, @SuppressWarnings("rawtypes") RuntimeCapability ... runtimeCapabilities) {
super(addAddRemoveHandlers(new Parameters(PathElement.pathElement(pathKey), ElytronExtension.getResourceDescriptionResolver(pathKey))
.setAddRestartLevel(OperationEntry.Flag.RESTART_RESOURCE_SERVICES)
.setRemoveRestartLevel(OperationEntry.Flag.RESTART_RESOURCE_SERVICES)
.setCapabilities(runtimeCapabilities), serviceType, runtimeCapabilities));

this.serviceType = serviceType;
this.runtimeCapabilities = runtimeCapabilities;
this.pathKey = pathKey;
.setCapabilities(runtimeCapabilities), serviceType, wrapper, runtimeCapabilities));
}

private static <T> Parameters addAddRemoveHandlers(Parameters parameters, Class<T> serviceType, RuntimeCapability<?> ... runtimeCapabilities) {
AbstractAddStepHandler add = new ComponentAddHandler<T>(serviceType, runtimeCapabilities);
private static <C, T> Parameters addAddRemoveHandlers(Parameters parameters, Class<C> serviceType, Function<C, T> wrapper, RuntimeCapability<?> ... runtimeCapabilities) {
AbstractAddStepHandler add = new ComponentAddHandler<>(serviceType, wrapper, runtimeCapabilities);
OperationStepHandler remove = new TrivialCapabilityServiceRemoveHandler(add, runtimeCapabilities);

parameters.setAddHandler(add);
Expand All @@ -105,15 +98,17 @@ public void registerAttributes(ManagementResourceRegistration resourceRegistrati
}
}

private static class ComponentAddHandler<T> extends BaseAddHandler {
private static class ComponentAddHandler<C, T> extends BaseAddHandler {

private final RuntimeCapability<?>[] runtimeCapabilities;
private final Class<T> serviceType;
private final Class<C> serviceType;
private final Function<C, T> wrapper;

private ComponentAddHandler(Class<T> serviceType, RuntimeCapability<?> ... runtimeCapabilities) {
super( new HashSet<RuntimeCapability>(Arrays.asList(runtimeCapabilities)), ATTRIBUTES);
private ComponentAddHandler(Class<C> serviceType, Function<C, T> wrapper, RuntimeCapability<?> ... runtimeCapabilities) {
super(new HashSet<>(Arrays.asList(runtimeCapabilities)), ATTRIBUTES);
this.runtimeCapabilities = runtimeCapabilities;
this.serviceType = serviceType;
this.wrapper = wrapper;
}

@Override
Expand All @@ -131,14 +126,13 @@ protected void performRuntime(OperationContext context, ModelNode operation, Mod
final Map<String, String> configurationMap;
configurationMap = CONFIGURATION.unwrap(context, model);

TrivialService<T> customComponentService = new TrivialService<T>(() -> createValue(module, className, configurationMap));

ServiceBuilder<T> serviceBuilder = serviceTarget.addService(primaryServiceName, customComponentService);
for (int i=1;i<runtimeCapabilities.length;i++) {
ServiceBuilder<?> serviceBuilder = serviceTarget.addService(primaryServiceName);
for (int i = 1; i < runtimeCapabilities.length; i++) {
serviceBuilder.addAliases(toServiceName(runtimeCapabilities[i], address));
}

commonDependencies(serviceBuilder)
commonRequirements(serviceBuilder)
.setInstance(new TrivialService<>(() -> createValue(module, className, configurationMap)))
.setInitialMode(Mode.ACTIVE)
.install();
}
Expand All @@ -152,9 +146,9 @@ private T createValue(String module, String className, Map<String, String> confi
try {
classLoader = doPrivileged((PrivilegedExceptionAction<ClassLoader>) () -> resolveClassLoader(module));

Class<? extends T> typeClazz = classLoader.loadClass(className).asSubclass(serviceType);
Class<? extends C> typeClazz = classLoader.loadClass(className).asSubclass(serviceType);

T component = typeClazz.getDeclaredConstructor().newInstance();
C component = typeClazz.getDeclaredConstructor().newInstance();

if (configuration != null && !configuration.isEmpty()) {
try {
Expand All @@ -165,7 +159,7 @@ private T createValue(String module, String className, Map<String, String> confi
}
}

return component;
return wrapper.apply(component);
} catch (PrivilegedActionException e) {
throw new StartException(e.getCause());
} catch (Exception e) {
Expand Down
41 changes: 29 additions & 12 deletions elytron/src/main/java/org/wildfly/extension/elytron/ElytronDefinition.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

package org.wildfly.extension.elytron;

import static org.wildfly.extension.elytron.ElytronExtension.isServerOrHostController;
import static org.wildfly.extension.elytron.Capabilities.AUTHENTICATION_CONTEXT_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.ELYTRON_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.MODIFIABLE_SECURITY_REALM_RUNTIME_CAPABILITY;
Expand All @@ -29,12 +28,16 @@
import static org.wildfly.extension.elytron.Capabilities.REALM_MAPPER_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.ROLE_DECODER_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.ROLE_MAPPER_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.SECURITY_EVENT_LISTENER_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.SECURITY_FACTORY_CREDENTIAL_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.Capabilities.SECURITY_REALM_RUNTIME_CAPABILITY;
import static org.wildfly.extension.elytron.ElytronExtension.isServerOrHostController;

import java.security.Provider;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;

import org.jboss.as.controller.AbstractBoottimeAddStepHandler;
import org.jboss.as.controller.AttributeMarshaller;
Expand Down Expand Up @@ -72,6 +75,7 @@
import org.jboss.msc.service.ServiceTarget;
import org.wildfly.extension.elytron.capabilities.CredentialSecurityFactory;
import org.wildfly.extension.elytron.capabilities.PrincipalTransformer;
import org.wildfly.extension.elytron.capabilities._private.SecurityEventListener;
import org.wildfly.security.Version;
import org.wildfly.security.auth.server.ModifiableSecurityRealm;
import org.wildfly.security.auth.server.PrincipalDecoder;
Expand Down Expand Up @@ -140,6 +144,8 @@ public void registerChildren(ManagementResourceRegistration resourceRegistration

// Audit
resourceRegistration.registerSubModel(AuditResourceDefinitions.getAggregateSecurityEventListenerDefinition());
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(Consumer.class, SecurityEventListener::from,
ElytronDescriptionConstants.CUSTOM_SECURITY_EVENT_LISTENER, SECURITY_EVENT_LISTENER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(AuditResourceDefinitions.getFileAuditLogResourceDefinition());
resourceRegistration.registerSubModel(AuditResourceDefinitions.getPeriodicRotatingFileAuditLogResourceDefinition());
resourceRegistration.registerSubModel(AuditResourceDefinitions.getSizeRotatingFileAuditLogResourceDefinition());
Expand All @@ -154,9 +160,9 @@ public void registerChildren(ManagementResourceRegistration resourceRegistration

// Security Realms
resourceRegistration.registerSubModel(new AggregateRealmDefinition());
resourceRegistration.registerSubModel(new CustomComponentDefinition<SecurityRealm>(SecurityRealm.class, ElytronDescriptionConstants.CUSTOM_REALM, SECURITY_REALM_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(ModifiableRealmDecorator.wrap(new CustomComponentDefinition<ModifiableSecurityRealm>(
ModifiableSecurityRealm.class, ElytronDescriptionConstants.CUSTOM_MODIFIABLE_REALM,
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(SecurityRealm.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_REALM, SECURITY_REALM_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(ModifiableRealmDecorator.wrap(new CustomComponentDefinition<>(
ModifiableSecurityRealm.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_MODIFIABLE_REALM,
MODIFIABLE_SECURITY_REALM_RUNTIME_CAPABILITY, SECURITY_REALM_RUNTIME_CAPABILITY)));
resourceRegistration.registerSubModel(RealmDefinitions.getIdentityRealmDefinition());
resourceRegistration.registerSubModel(new JdbcRealmDefinition());
Expand All @@ -168,11 +174,11 @@ public void registerChildren(ManagementResourceRegistration resourceRegistration
resourceRegistration.registerSubModel(new CachingRealmDefinition());

// Security Factories
resourceRegistration.registerSubModel(new CustomComponentDefinition<CredentialSecurityFactory>(CredentialSecurityFactory.class, ElytronDescriptionConstants.CUSTOM_CREDENTIAL_SECURITY_FACTORY, SECURITY_FACTORY_CREDENTIAL_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(CredentialSecurityFactory.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_CREDENTIAL_SECURITY_FACTORY, SECURITY_FACTORY_CREDENTIAL_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(KerberosSecurityFactoryDefinition.getKerberosSecurityFactoryDefinition());

// Permission Mappers
resourceRegistration.registerSubModel(new CustomComponentDefinition<PermissionMapper>(PermissionMapper.class, ElytronDescriptionConstants.CUSTOM_PERMISSION_MAPPER, PERMISSION_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(PermissionMapper.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_PERMISSION_MAPPER, PERMISSION_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(PermissionMapperDefinitions.getLogicalPermissionMapper());
resourceRegistration.registerSubModel(PermissionMapperDefinitions.getSimplePermissionMapper());
resourceRegistration.registerSubModel(PermissionMapperDefinitions.getConstantPermissionMapper());
Expand All @@ -184,33 +190,33 @@ public void registerChildren(ManagementResourceRegistration resourceRegistration
resourceRegistration.registerSubModel(PrincipalDecoderDefinitions.getAggregatePrincipalDecoderDefinition());
resourceRegistration.registerSubModel(PrincipalDecoderDefinitions.getConcatenatingPrincipalDecoder());
resourceRegistration.registerSubModel(PrincipalDecoderDefinitions.getConstantPrincipalDecoder());
resourceRegistration.registerSubModel(new CustomComponentDefinition<PrincipalDecoder>(PrincipalDecoder.class, ElytronDescriptionConstants.CUSTOM_PRINCIPAL_DECODER, PRINCIPAL_DECODER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(PrincipalDecoder.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_PRINCIPAL_DECODER, PRINCIPAL_DECODER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(PrincipalDecoderDefinitions.getX500AttributePrincipalDecoder());

// Principal Transformers
resourceRegistration.registerSubModel(PrincipalTransformerDefinitions.getAggregatePrincipalTransformerDefinition());
resourceRegistration.registerSubModel(PrincipalTransformerDefinitions.getChainedPrincipalTransformerDefinition());
resourceRegistration.registerSubModel(PrincipalTransformerDefinitions.getConstantPrincipalTransformerDefinition());
resourceRegistration.registerSubModel(new CustomComponentDefinition<PrincipalTransformer>(PrincipalTransformer.class, ElytronDescriptionConstants.CUSTOM_PRINCIPAL_TRANSFORMER, PRINCIPAL_TRANSFORMER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(PrincipalTransformer.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_PRINCIPAL_TRANSFORMER, PRINCIPAL_TRANSFORMER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(PrincipalTransformerDefinitions.getRegexPrincipalTransformerDefinition());
resourceRegistration.registerSubModel(PrincipalTransformerDefinitions.getRegexValidatingPrincipalTransformerDefinition());

// Realm Mappers
resourceRegistration.registerSubModel(RealmMapperDefinitions.getConstantRealmMapper());
resourceRegistration.registerSubModel(new CustomComponentDefinition<RealmMapper>(RealmMapper.class, ElytronDescriptionConstants.CUSTOM_REALM_MAPPER, REALM_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(RealmMapper.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_REALM_MAPPER, REALM_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(RealmMapperDefinitions.getMappedRegexRealmMapper());
resourceRegistration.registerSubModel(RealmMapperDefinitions.getSimpleRegexRealmMapperDefinition());

// Role Decoders
resourceRegistration.registerSubModel(new CustomComponentDefinition<RoleDecoder>(RoleDecoder.class, ElytronDescriptionConstants.CUSTOM_ROLE_DECODER, ROLE_DECODER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(RoleDecoder.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_ROLE_DECODER, ROLE_DECODER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(RoleDecoderDefinitions.getSimpleRoleDecoderDefinition());

// Role Mappers
resourceRegistration.registerSubModel(RoleMapperDefinitions.getAddSuffixRoleMapperDefinition());
resourceRegistration.registerSubModel(RoleMapperDefinitions.getAddPrefixRoleMapperDefinition());
resourceRegistration.registerSubModel(RoleMapperDefinitions.getAggregateRoleMapperDefinition());
resourceRegistration.registerSubModel(RoleMapperDefinitions.getConstantRoleMapperDefinition());
resourceRegistration.registerSubModel(new CustomComponentDefinition<RoleMapper>(RoleMapper.class, ElytronDescriptionConstants.CUSTOM_ROLE_MAPPER, ROLE_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(new CustomComponentDefinition<>(RoleMapper.class, Function.identity(), ElytronDescriptionConstants.CUSTOM_ROLE_MAPPER, ROLE_MAPPER_RUNTIME_CAPABILITY));
resourceRegistration.registerSubModel(RoleMapperDefinitions.getLogicalRoleMapperDefinition());
resourceRegistration.registerSubModel(RoleMapperDefinitions.getMappedRoleMapperDefinition());

Expand Down Expand Up @@ -278,17 +284,28 @@ protected void revertUpdateToRuntime(OperationContext context, ModelNode operati
resourceRegistration.registerReadWriteAttribute(SECURITY_PROPERTIES, null, new SecurityPropertiesWriteHandler(SECURITY_PROPERTIES));
}


@Deprecated
static <T> ServiceBuilder<T> commonDependencies(ServiceBuilder<T> serviceBuilder) {
return commonDependencies(serviceBuilder, true, true);
}

@Deprecated
static <T> ServiceBuilder<T> commonDependencies(ServiceBuilder<T> serviceBuilder, boolean dependOnProperties, boolean dependOnProviderRegistration) {
if (dependOnProperties) serviceBuilder.addDependencies(SecurityPropertyService.SERVICE_NAME);
if (dependOnProviderRegistration) serviceBuilder.addDependencies(ProviderRegistrationService.SERVICE_NAME);
return serviceBuilder;
}

static <T> ServiceBuilder<T> commonRequirements(ServiceBuilder<T> serviceBuilder) {
return commonRequirements(serviceBuilder, true, true);
}

static <T> ServiceBuilder<T> commonRequirements(ServiceBuilder<T> serviceBuilder, boolean dependOnProperties, boolean dependOnProviderRegistration) {
if (dependOnProperties) serviceBuilder.requires(SecurityPropertyService.SERVICE_NAME);
if (dependOnProviderRegistration) serviceBuilder.requires(ProviderRegistrationService.SERVICE_NAME);
return serviceBuilder;
}

private static void installService(ServiceName serviceName, Service<?> service, ServiceTarget serviceTarget) {
serviceTarget.addService(serviceName, service)
.setInitialMode(Mode.ACTIVE)
Expand Down
Loading

0 comments on commit e0d93f9

Please sign in to comment.