org.wildfly.security.credential.source.CredentialStoreCredentialSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2016 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.credential.source;

import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.spec.AlgorithmParameterSpec;

import org.wildfly.common.Assert;
import org.wildfly.security.FixedSecurityFactory;
import org.wildfly.security.SecurityFactory;
import org.wildfly.security.auth.SupportLevel;
import org.wildfly.security.credential.Credential;
import org.wildfly.security.credential.store.CredentialStore;
import org.wildfly.security.credential.store.UnsupportedCredentialTypeException;

import static org.wildfly.security.credential.source.ElytronMessages.log;

/**
 * A credential source which is backed by an entry in a credential store.
 *
 * @author David M. Lloyd
 * @author Peter Skopek
 * @deprecated Use {@link org.wildfly.security.credential.source.impl.CredentialStoreCredentialSource} instead
 */
@Deprecated
public final class CredentialStoreCredentialSource implements CredentialSource {
    private final SecurityFactory credentialStoreFactory;
    private final String alias;

    /**
     * Construct a new instance.
     *
     * @param credentialStoreFactory the credential store factory (must not be {@code null})
     * @param alias the credential store factory alias (must not be {@code null})
     */
    public CredentialStoreCredentialSource(final SecurityFactory credentialStoreFactory, final String alias) {
        Assert.checkNotNullParam("credentialStoreFactory", credentialStoreFactory);
        Assert.checkNotNullParam("alias", alias);
        this.credentialStoreFactory = credentialStoreFactory;
        this.alias = alias;
    }

    /**
     * Construct a new instance.
     *
     * @param credentialStore the literal credential store (must not be {@code null})
     * @param alias the credential store factory alias (must not be {@code null})
     */
    public CredentialStoreCredentialSource(final CredentialStore credentialStore, final String alias) {
        this(new FixedSecurityFactory<>(Assert.checkNotNullParam("credentialStore", credentialStore)), alias);
    }

    public SupportLevel getCredentialAcquireSupport(final Class credentialType, final String algorithmName, final AlgorithmParameterSpec parameterSpec) throws IOException {
        Assert.checkNotNullParam("credentialType", credentialType);
        try {
            final CredentialStore credentialStore = credentialStoreFactory.create();
            return credentialStore.exists(alias, credentialType) ? SupportLevel.POSSIBLY_SUPPORTED : SupportLevel.UNSUPPORTED;
        } catch (UnsupportedCredentialTypeException e) {
            return SupportLevel.UNSUPPORTED;
        } catch (GeneralSecurityException e) {
            throw log.unableToReadCredential(e);
        }
    }

    public  C getCredential(final Class credentialType, final String algorithmName, final AlgorithmParameterSpec parameterSpec) throws IOException {
        Assert.checkNotNullParam("credentialType", credentialType);
        try {
            final CredentialStore credentialStore = credentialStoreFactory.create();
            if (log.isTraceEnabled()) {
                log.tracef("CredentialStoreCredentialSource: obtaining credential: type = %s  algorithm = %s  exists = %b", alias, credentialType, credentialStore.exists(alias, credentialType));
            }
            return credentialStore.retrieve(alias, credentialType, algorithmName, parameterSpec);
        } catch (UnsupportedCredentialTypeException e) {
            return null;
        } catch (GeneralSecurityException e) {
            throw log.unableToReadCredential(e);
        }
    }
}