/*
* Copyright [2007] [University Corporation for Advanced Internet Development, Inc.]
*
* 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.opensaml.xml.security.keyinfo.provider;
import java.security.KeyException;
import java.security.PublicKey;
import java.util.Collection;
import org.opensaml.xml.XMLObject;
import org.opensaml.xml.security.CriteriaSet;
import org.opensaml.xml.security.SecurityException;
import org.opensaml.xml.security.credential.BasicCredential;
import org.opensaml.xml.security.credential.Credential;
import org.opensaml.xml.security.credential.CredentialContext;
import org.opensaml.xml.security.criteria.KeyAlgorithmCriteria;
import org.opensaml.xml.security.keyinfo.KeyInfoCredentialResolver;
import org.opensaml.xml.security.keyinfo.KeyInfoHelper;
import org.opensaml.xml.security.keyinfo.KeyInfoProvider;
import org.opensaml.xml.security.keyinfo.KeyInfoResolutionContext;
import org.opensaml.xml.signature.DSAKeyValue;
import org.opensaml.xml.signature.KeyValue;
import org.opensaml.xml.util.LazySet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Implementation of {@link KeyInfoProvider} which supports {@link DSAKeyValue}.
*/
public class DSAKeyValueProvider extends AbstractKeyInfoProvider {
/** Class logger. */
private final Logger log = LoggerFactory.getLogger(DSAKeyValueProvider.class);
/** {@inheritDoc} */
public boolean handles(XMLObject keyInfoChild) {
return getDSAKeyValue(keyInfoChild) != null;
}
/** {@inheritDoc} */
public Collection<Credential> process(KeyInfoCredentialResolver resolver, XMLObject keyInfoChild,
CriteriaSet criteriaSet, KeyInfoResolutionContext kiContext) throws SecurityException {
DSAKeyValue keyValue = getDSAKeyValue(keyInfoChild);
if (keyValue == null) {
return null;
}
KeyAlgorithmCriteria algorithmCriteria = criteriaSet.get(KeyAlgorithmCriteria.class);
if (algorithmCriteria != null
&& algorithmCriteria.getKeyAlgorithm() != null
&& ! algorithmCriteria.getKeyAlgorithm().equals("DSA")) {
log.debug("Criteria specified non-DSA key algorithm, skipping");
return null;
}
log.debug("Attempting to extract credential from a DSAKeyValue");
PublicKey pubKey = null;
try {
//TODO deal with case of incomplete DSAParams, need hook to resolve those
pubKey = KeyInfoHelper.getDSAKey(keyValue);
} catch (KeyException e) {
log.error("Error extracting DSA key value", e);
throw new SecurityException("Error extracting DSA key value", e);
}
BasicCredential cred = new BasicCredential();
cred.setPublicKey(pubKey);
if (kiContext != null) {
cred.getKeyNames().addAll(kiContext.getKeyNames());
}
CredentialContext credContext = buildCredentialContext(kiContext);
if (credContext != null) {
cred.getCredentalContextSet().add(credContext);
}
log.debug("Credential successfully extracted from DSAKeyValue");
LazySet<Credential> credentialSet = new LazySet<Credential>();
credentialSet.add(cred);
return credentialSet;
}
/**
* Get the DSAKeyValue from the passed XML object.
*
* @param xmlObject an XML object, presumably either a {@link KeyValue} or an {@link DSAKeyValue}
* @return the DSAKeyValue which was found, or null if none
*/
protected DSAKeyValue getDSAKeyValue(XMLObject xmlObject) {
if (xmlObject == null) {return null; }
if (xmlObject instanceof DSAKeyValue) {
return (DSAKeyValue) xmlObject;
}
if (xmlObject instanceof KeyValue) {
return ((KeyValue) xmlObject).getDSAKeyValue();
}
return null;
}
}