All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.jackrabbit.oak.security.internal.SecurityProviderBuilder Maven / Gradle / Ivy

There is a newer version: 1.66.0
Show 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.jackrabbit.oak.security.internal;

import static org.apache.jackrabbit.oak.security.internal.ConfigurationInitializer.initializeConfiguration;
import static org.apache.jackrabbit.oak.security.internal.ConfigurationInitializer.initializeConfigurations;
import static org.apache.jackrabbit.oak.spi.security.ConfigurationParameters.EMPTY;

import org.apache.jackrabbit.oak.plugins.tree.RootProvider;
import org.apache.jackrabbit.oak.plugins.tree.TreeProvider;
import org.apache.jackrabbit.oak.plugins.tree.impl.RootProviderService;
import org.apache.jackrabbit.oak.plugins.tree.impl.TreeProviderService;
import org.apache.jackrabbit.oak.security.authentication.AuthenticationConfigurationImpl;
import org.apache.jackrabbit.oak.security.authentication.token.TokenConfigurationImpl;
import org.apache.jackrabbit.oak.security.authorization.AuthorizationConfigurationImpl;
import org.apache.jackrabbit.oak.security.authorization.composite.CompositeAuthorizationConfiguration;
import org.apache.jackrabbit.oak.security.authorization.restriction.RestrictionProviderImpl;
import org.apache.jackrabbit.oak.security.principal.PrincipalConfigurationImpl;
import org.apache.jackrabbit.oak.security.privilege.PrivilegeConfigurationImpl;
import org.apache.jackrabbit.oak.security.user.UserConfigurationImpl;
import org.apache.jackrabbit.oak.spi.security.ConfigurationParameters;
import org.apache.jackrabbit.oak.spi.security.SecurityProvider;
import org.apache.jackrabbit.oak.spi.security.authentication.AuthenticationConfiguration;
import org.apache.jackrabbit.oak.spi.security.authentication.token.CompositeTokenConfiguration;
import org.apache.jackrabbit.oak.spi.security.authentication.token.TokenConfiguration;
import org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration;
import org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol.AccessControlConstants;
import org.apache.jackrabbit.oak.spi.security.authorization.restriction.RestrictionProvider;
import org.apache.jackrabbit.oak.spi.security.principal.CompositePrincipalConfiguration;
import org.apache.jackrabbit.oak.spi.security.principal.PrincipalConfiguration;
import org.apache.jackrabbit.oak.spi.security.privilege.PrivilegeConfiguration;
import org.apache.jackrabbit.oak.spi.security.user.AuthorizableNodeName;
import org.apache.jackrabbit.oak.spi.security.user.UserAuthenticationFactory;
import org.apache.jackrabbit.oak.spi.security.user.UserConfiguration;
import org.apache.jackrabbit.oak.spi.security.user.UserConstants;
import org.apache.jackrabbit.oak.spi.security.user.action.AuthorizableActionProvider;
import org.apache.jackrabbit.oak.spi.security.user.action.DefaultAuthorizableActionProvider;
import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
import org.jetbrains.annotations.NotNull;

public final class SecurityProviderBuilder {

    private Whiteboard whiteboard;
    private RootProvider rootProvider;
    private TreeProvider treeProvider;

    private ConfigurationParameters authenticationParams = EMPTY;
    private AuthenticationConfiguration authenticationConfiguration;

    private ConfigurationParameters privilegeParams = EMPTY;
    private PrivilegeConfiguration privilegeConfiguration;

    private ConfigurationParameters userParams = EMPTY;
    private UserConfiguration userConfiguration;

    private ConfigurationParameters authorizationParams = EMPTY;
    private AuthorizationConfiguration authorizationConfiguration;

    private ConfigurationParameters principalParams = EMPTY;
    private PrincipalConfiguration principalConfiguration;

    private ConfigurationParameters tokenParams = EMPTY;
    private TokenConfiguration tokenConfiguration;

    private ConfigurationParameters configuration;

    @NotNull
    public static SecurityProviderBuilder newBuilder() {
        return new SecurityProviderBuilder();
    }

    private SecurityProviderBuilder() {
        this.configuration = ConfigurationParameters.EMPTY;
    }

    public SecurityProviderBuilder with(@NotNull ConfigurationParameters configuration) {
        this.configuration = configuration;

        authenticationParams = configuration.getConfigValue(AuthenticationConfiguration.NAME, EMPTY);
        privilegeParams = configuration.getConfigValue(PrivilegeConfiguration.NAME, EMPTY);

        if (configuration.contains(UserConfiguration.NAME)) {
            userParams = configuration.getConfigValue(UserConfiguration.NAME, EMPTY);
        } else {
            AuthorizableActionProvider authorizableActionProvider = new DefaultAuthorizableActionProvider();
            AuthorizableNodeName authorizableNodeName = AuthorizableNodeName.DEFAULT;
            UserAuthenticationFactory userAuthenticationFactory = UserConfigurationImpl
                    .getDefaultAuthenticationFactory();

            userParams = ConfigurationParameters.of(
                    ConfigurationParameters.of(UserConstants.PARAM_AUTHORIZABLE_ACTION_PROVIDER,
                            authorizableActionProvider),
                    ConfigurationParameters.of(UserConstants.PARAM_AUTHORIZABLE_NODE_NAME, authorizableNodeName),
                    ConfigurationParameters.of(UserConstants.PARAM_USER_AUTHENTICATION_FACTORY,
                            userAuthenticationFactory));
        }
        if (configuration.contains(AuthorizationConfiguration.NAME)) {
            authorizationParams = configuration.getConfigValue(AuthorizationConfiguration.NAME, EMPTY);
        } else {
            RestrictionProvider restrictionProvider = new RestrictionProviderImpl();
            authorizationParams = ConfigurationParameters.of(AccessControlConstants.PARAM_RESTRICTION_PROVIDER,
                    restrictionProvider);
        }
        principalParams = configuration.getConfigValue(PrincipalConfiguration.NAME, EMPTY);
        tokenParams = configuration.getConfigValue(TokenConfiguration.NAME, EMPTY);
        return this;
    }

    public SecurityProviderBuilder with(@NotNull AuthenticationConfiguration authenticationConfiguration,
            @NotNull ConfigurationParameters authenticationParams,
            @NotNull PrivilegeConfiguration privilegeConfiguration, @NotNull ConfigurationParameters privilegeParams,
            @NotNull UserConfiguration userConfiguration, @NotNull ConfigurationParameters userParams,
            @NotNull AuthorizationConfiguration authorizationConfiguration, @NotNull ConfigurationParameters authorizationParams,
            @NotNull PrincipalConfiguration principalConfiguration, @NotNull ConfigurationParameters principalParams,
            @NotNull TokenConfiguration tokenConfiguration, @NotNull ConfigurationParameters tokenParams) {

        this.authenticationConfiguration = authenticationConfiguration;
        this.authenticationParams = authenticationParams;

        this.privilegeConfiguration = privilegeConfiguration;
        this.privilegeParams = privilegeParams;

        this.userConfiguration = userConfiguration;
        this.userParams = userParams;

        this.authorizationConfiguration = authorizationConfiguration;
        this.authorizationParams = authorizationParams;

        this.principalConfiguration = principalConfiguration;
        this.principalParams = principalParams;

        this.tokenConfiguration = tokenConfiguration;
        this.tokenParams = tokenParams;

        return this;
    }

    public SecurityProvider build() {
        InternalSecurityProvider securityProvider = new InternalSecurityProvider();

        if (rootProvider == null) {
            rootProvider = new RootProviderService();
        }
        if (treeProvider == null) {
            treeProvider = new TreeProviderService();
        }

        // authentication
        if (authenticationConfiguration == null) {
            authenticationConfiguration = new AuthenticationConfigurationImpl();
        }
        securityProvider.setAuthenticationConfiguration(initializeConfiguration(authenticationConfiguration,
                securityProvider, authenticationParams, rootProvider, treeProvider));

        // privilege
        if (privilegeConfiguration == null) {
            privilegeConfiguration = new PrivilegeConfigurationImpl();
        }
        securityProvider.setPrivilegeConfiguration(initializeConfiguration(privilegeConfiguration, securityProvider,
                privilegeParams, rootProvider, treeProvider));

        // user
        if (userConfiguration == null) {
            userConfiguration = new UserConfigurationImpl();
        }
        securityProvider.setUserConfiguration(
                initializeConfiguration(userConfiguration, securityProvider, userParams, rootProvider, treeProvider));

        // authorization
        if (authorizationConfiguration == null) {
            CompositeAuthorizationConfiguration ac = new CompositeAuthorizationConfiguration();
            ac.withCompositionType(configuration.getConfigValue("authorizationCompositionType", CompositeAuthorizationConfiguration.CompositionType.AND.toString()));
            ac.setDefaultConfig(initializeConfiguration(new AuthorizationConfigurationImpl(),
                    securityProvider, rootProvider, treeProvider));
            authorizationConfiguration = ac;
        }

        if (authorizationConfiguration instanceof CompositeAuthorizationConfiguration) {
            initializeConfigurations((CompositeAuthorizationConfiguration) authorizationConfiguration, securityProvider, authorizationParams, rootProvider, treeProvider);
        } else {
            initializeConfiguration(authorizationConfiguration, securityProvider, authorizationParams, rootProvider, treeProvider);
        }
        securityProvider.setAuthorizationConfiguration(authorizationConfiguration);

        // principal
        if (principalConfiguration == null) {
            CompositePrincipalConfiguration pc = new CompositePrincipalConfiguration();
            pc.setDefaultConfig(initializeConfiguration(new PrincipalConfigurationImpl(), securityProvider, rootProvider, treeProvider));
            principalConfiguration = pc;
        }

        if (principalConfiguration instanceof CompositePrincipalConfiguration) {
            initializeConfigurations((CompositePrincipalConfiguration) principalConfiguration, securityProvider, principalParams, rootProvider, treeProvider);
        } else {
            initializeConfiguration(principalConfiguration, securityProvider, principalParams, rootProvider, treeProvider);
        }
        securityProvider.setPrincipalConfiguration(principalConfiguration);

        // token
        if (tokenConfiguration == null) {
            CompositeTokenConfiguration tc = new CompositeTokenConfiguration();
            tc.setDefaultConfig(initializeConfiguration(new TokenConfigurationImpl(), securityProvider, rootProvider, treeProvider));
            tokenConfiguration = tc;
        }

        if (tokenConfiguration instanceof CompositeTokenConfiguration) {
            initializeConfigurations((CompositeTokenConfiguration) tokenConfiguration, securityProvider, tokenParams, rootProvider, treeProvider);
        } else {
            initializeConfiguration(tokenConfiguration, securityProvider, tokenParams, rootProvider, treeProvider);
        }
        securityProvider.setTokenConfiguration(tokenConfiguration);

        // whiteboard
        if (whiteboard != null) {
            securityProvider.setWhiteboard(whiteboard);
        }

        return securityProvider;
    }

    public SecurityProviderBuilder withWhiteboard(@NotNull Whiteboard whiteboard) {
        this.whiteboard = whiteboard;
        return this;
    }

    public SecurityProviderBuilder withRootProvider(@NotNull RootProvider rootProvider) {
        this.rootProvider = rootProvider;
        return this;
    }

    public SecurityProviderBuilder withTreeProvider(@NotNull TreeProvider treeProvider) {
        this.treeProvider = treeProvider;
        return this;
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy