org.wildfly.security.sasl.util.SSLSaslClientFactory 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 static org.wildfly.common.Assert.checkNotNullParam;
import static org.wildfly.common.math.HashMath.multiHashOrdered;

import java.util.Map;
import java.util.Objects;
import java.util.function.Supplier;

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

import org.wildfly.security.ssl.SSLConnection;

/**
 * A SASL client factory which provides information about the security layer of the connection to the callback handler.
 *
 * @author David M. Lloyd
 */
public final class SSLSaslClientFactory extends AbstractDelegatingSaslClientFactory implements SaslClientFactory {
    private final Supplier sslConnectionSupplier;

    /**
     * Construct a new instance.
     *
     * @param sslConnectionSupplier supplier of the current SSL connection
     * @param delegate the delegate SASL client factory
     */
    public SSLSaslClientFactory(final Supplier sslConnectionSupplier, final SaslClientFactory delegate) {
       super(delegate);
       this.sslConnectionSupplier = checkNotNullParam("sslConnectionSupplier", sslConnectionSupplier);
    }

    /**
     * Construct a new instance.
     *
     * @param delegate the delegate SASL client factory
     * @param sslSession supplier of the current SSLSession
     * @deprecated Use {@link #SSLSaslClientFactory(Supplier, SaslClientFactory)} to avoid problems where a TLS client is acting as a SASL server.
     */
    public SSLSaslClientFactory(final SaslClientFactory delegate, final Supplier sslSession) {
       this(() -> SSLConnection.forSession(sslSession.get(), true), delegate);
    }

    public SaslClient createSaslClient(final String[] mechanisms, final String authorizationId, final String protocol, final String serverName, final Map props, final CallbackHandler cbh) throws SaslException {
        final SSLQueryCallbackHandler newHandler = new SSLQueryCallbackHandler(cbh, sslConnectionSupplier);
        SaslClient saslClient = super.createSaslClient(mechanisms, authorizationId, protocol, serverName, props, newHandler);
        newHandler.activate();

        return saslClient;
    }

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

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

    @SuppressWarnings("checkstyle:equalshashcode")
    public boolean equals(final SSLSaslClientFactory other) {
        return super.equals(other) && Objects.equals(sslConnectionSupplier, other.sslConnectionSupplier);
    }

    protected int calculateHashCode() {
        return multiHashOrdered(multiHashOrdered(super.calculateHashCode(), getClass().hashCode()), Objects.hashCode(sslConnectionSupplier));
    }
}