org.wildfly.security.auth.realm.jdbc.KeyMapper Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
*
* Copyright 2015 Red Hat, Inc. and/or its affiliates.
*
* 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.auth.realm.jdbc;
import java.security.Provider;
import java.security.spec.AlgorithmParameterSpec;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.function.Supplier;
import org.wildfly.security.auth.SupportLevel;
import org.wildfly.security.credential.Credential;
import org.wildfly.security.credential.PasswordCredential;
import org.wildfly.security.evidence.Evidence;
import org.wildfly.security.evidence.PasswordGuessEvidence;
/**
* A key mapper is responsible to map data from a column in a table to a specific credential type.
*
* @author Pedro Igor
*/
public interface KeyMapper extends ColumnMapper {
/**
* Determine whether a credential of the given type and algorithm is definitely obtainable, possibly obtainable (for]
* some identities), or definitely not obtainable.
*
* @param credentialType the exact credential type (must not be {@code null})
* @param algorithmName the algorithm name, or {@code null} if any algorithm is acceptable or the credential type does
* not support algorithm names
* @param parameterSpec the algorithm parameters to match, or {@code null} if any parameters are acceptable or the credential type
* does not support algorithm parameters
* @return the level of support for this credential
*/
SupportLevel getCredentialAcquireSupport(Class credentialType, String algorithmName, AlgorithmParameterSpec parameterSpec);
/**
* Determine whether a given type of evidence is definitely verifiable, possibly verifiable (for some identities),
* or definitely not verifiable.
*
* @param evidenceType the type of evidence to be verified (must not be {@code null})
* @param algorithmName the algorithm name, or {@code null} if any algorithm is acceptable or the evidence type does
* not support algorithm names
* @return the level of support for this evidence type
*/
default SupportLevel getEvidenceVerifySupport(Class evidenceType, String algorithmName) {
if (PasswordGuessEvidence.class.isAssignableFrom(evidenceType)) {
return getCredentialAcquireSupport(PasswordCredential.class, null, null);
}
return SupportLevel.UNSUPPORTED;
}
Credential map(ResultSet resultSet, Supplier providers) throws SQLException;
}