org.wildfly.security.sasl.util.MechanismProviderFilteringSaslClientFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron
WildFly Security SPIs
There is a newer version: 2.4.1.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2015 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.wildfly.security.sasl.util;

import java.security.Provider;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiPredicate;

import javax.security.auth.callback.CallbackHandler;
import javax.security.sasl.SaslException;
import javax.security.sasl.SaslClient;
import javax.security.sasl.SaslClientFactory;

import org.wildfly.common.Assert;
import org.wildfly.common.math.HashMath;

/**
 * A SASL client factory which filters mechanisms based on the combination of mechanism name and security provider.
 * Mechanisms which do not come from a security provider are not filtered.
 *
 * @author David M. Lloyd
 */
public final class MechanismProviderFilteringSaslClientFactory extends AbstractDelegatingSaslClientFactory {
    private final BiPredicate predicate;

    /**
     * Construct a new instance.
     *
     * @param delegate the delegate factory
     * @param predicate the predicate to execute
     */
    public MechanismProviderFilteringSaslClientFactory(final SaslClientFactory delegate, final BiPredicate predicate) {
        super(delegate);
        Assert.checkNotNullParam("predicate", predicate);
        this.predicate = predicate;
    }

    @SuppressWarnings("unchecked")
    public SaslClient createSaslClient(final String[] mechanisms, final String authorizationId, final String protocol, final String serverName, final Map props, final CallbackHandler cbh) throws SaslException {
        BiPredicate existing = SaslFactories.getProviderFilterPredicate(props);
        final HashMap newProps = new HashMap(props);
        if (existing != null) {
            newProps.put(SaslFactories.PROVIDER_FILTER_KEY, predicate.and(existing));
        } else {
            newProps.put(SaslFactories.PROVIDER_FILTER_KEY, predicate);
        }
        return super.createSaslClient(mechanisms, authorizationId, protocol, serverName, newProps, cbh);
    }

    public String[] getMechanismNames(final Map props) {
        BiPredicate existing = SaslFactories.getProviderFilterPredicate(props);
        final HashMap newProps = new HashMap(props);
        if (existing != null) {
            newProps.put(SaslFactories.PROVIDER_FILTER_KEY, predicate.and(existing));
        } else {
            newProps.put(SaslFactories.PROVIDER_FILTER_KEY, predicate);
        }
        return super.getMechanismNames(newProps);
    }

    @SuppressWarnings("checkstyle:equalshashcode")
    public boolean equals(final Object other) {
        return other instanceof MechanismProviderFilteringSaslClientFactory && equals((MechanismProviderFilteringSaslClientFactory) other);
    }

    @SuppressWarnings("checkstyle:equalshashcode")
    public boolean equals(final AbstractDelegatingSaslClientFactory other) {
        return other instanceof MechanismProviderFilteringSaslClientFactory && equals((MechanismProviderFilteringSaslClientFactory) other);
    }

    @SuppressWarnings("checkstyle:equalshashcode")
    public boolean equals(final MechanismProviderFilteringSaslClientFactory other) {
        return super.equals(other) && predicate.equals(other.predicate);
    }

    protected int calculateHashCode() {
        return HashMath.multiHashOrdered(HashMath.multiHashOrdered(super.calculateHashCode(), getClass().hashCode()), predicate.hashCode());
    }
}