org.wildfly.security.http.sfbasic.BasicMechanismFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wildfly-elytron-http-stateful-basic
WildFly Security HTTP Stateful Basic Mechanism Implementation
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2021 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.http.sfbasic;

import static org.wildfly.common.Assert.checkNotNullParam;
import static org.wildfly.security.http.HttpConstants.CONFIG_REALM;
import static org.wildfly.security.http.sfbasic.BasicAuthenticationMechanism.SILENT;

import java.security.Provider;
import java.util.Map;

import javax.security.auth.callback.CallbackHandler;

import org.kohsuke.MetaInfServices;
import org.wildfly.security.http.HttpAuthenticationException;
import org.wildfly.security.http.HttpServerAuthenticationMechanism;
import org.wildfly.security.http.HttpServerAuthenticationMechanismFactory;

/**
 * A {@link HttpServerAuthenticationMechanismFactory} implementation for the Basic HTTP authentication mechanism.
 *
 * @author Darran Lofthouse
 */
@MetaInfServices(value = HttpServerAuthenticationMechanismFactory.class)
public class BasicMechanismFactory implements HttpServerAuthenticationMechanismFactory {

    public static final String STATEFUL_BASIC_NAME = "STATEFUL_BASIC";

    public static final String COOKIE_NAME = "ELYTRON_AUTH_SESSION";

    private final IdentityManager identityManager = new IdentityManager();

    public BasicMechanismFactory() {
    }

    public BasicMechanismFactory(final Provider provider) {
    }

    public BasicMechanismFactory(final Provider... providers) {
    }

    /**
     * @see org.wildfly.security.http.HttpServerAuthenticationMechanismFactory#getMechanismNames(java.util.Map)
     */
    @Override
    public String[] getMechanismNames(Map properties) {
        return new String[] { STATEFUL_BASIC_NAME };
    }

    /* (non-Javadoc)
     * @see org.wildfly.security.http.HttpServerAuthenticationMechanismFactory#createAuthenticationMechanism(java.lang.String, java.util.Map, javax.security.auth.callback.CallbackHandler)
     */
    @Override
    public HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName,
            Map properties, CallbackHandler callbackHandler) throws HttpAuthenticationException {
        checkNotNullParam("mechanismName", mechanismName);
        checkNotNullParam("properties", properties);
        checkNotNullParam("callbackHandler", callbackHandler);

        // TODO Do we need to configure the identity manager?  We could use the properties or subset
        // of to key on the correct identity manager to use.

        if (STATEFUL_BASIC_NAME.equals(mechanismName)) {
            return new BasicAuthenticationMechanism(callbackHandler, identityManager, (String) properties.get(CONFIG_REALM),
                    Boolean.parseBoolean((String) properties.get(SILENT)), false);
        }

        return null;
    }

    @Override
    public void shutdown() {
        identityManager.shutdown();
    }

}