| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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.apache.xml.security.keys.keyresolver.implementations; |
| |
| import java.security.Key; |
| import java.security.KeyStore; |
| import java.security.PrivateKey; |
| import java.security.PublicKey; |
| import java.security.cert.X509Certificate; |
| import javax.crypto.SecretKey; |
| import org.apache.xml.security.keys.keyresolver.KeyResolverException; |
| import org.apache.xml.security.keys.keyresolver.KeyResolverSpi; |
| import org.apache.xml.security.keys.storage.StorageResolver; |
| import org.apache.xml.security.utils.Constants; |
| import org.apache.xml.security.utils.XMLUtils; |
| import org.w3c.dom.Element; |
| |
| /** |
| * Resolves a SecretKey within a KeyStore based on the KeyName. |
| * The KeyName is the key entry alias within the KeyStore. |
| */ |
| public class SecretKeyResolver extends KeyResolverSpi |
| { |
| private static final org.slf4j.Logger LOG = |
| org.slf4j.LoggerFactory.getLogger(SecretKeyResolver.class); |
| |
| private KeyStore keyStore; |
| private char[] password; |
| |
| /** |
| * Constructor. |
| */ |
| public SecretKeyResolver(KeyStore keyStore, char[] password) { |
| this.keyStore = keyStore; |
| this.password = password; |
| } |
| |
| /** |
| * This method returns whether the KeyResolverSpi is able to perform the requested action. |
| * |
| * @param element |
| * @param baseURI |
| * @param storage |
| * @return whether the KeyResolverSpi is able to perform the requested action. |
| */ |
| public boolean engineCanResolve(Element element, String baseURI, StorageResolver storage) { |
| return XMLUtils.elementIsInSignatureSpace(element, Constants._TAG_KEYNAME); |
| } |
| |
| /** |
| * Method engineLookupAndResolvePublicKey |
| * |
| * @param element |
| * @param baseURI |
| * @param storage |
| * @return null if no {@link PublicKey} could be obtained |
| * @throws KeyResolverException |
| */ |
| public PublicKey engineLookupAndResolvePublicKey( |
| Element element, String baseURI, StorageResolver storage |
| ) throws KeyResolverException { |
| return null; |
| } |
| |
| /** |
| * Method engineResolveX509Certificate |
| * {@inheritDoc} |
| * @param element |
| * @param baseURI |
| * @param storage |
| * @throws KeyResolverException |
| */ |
| public X509Certificate engineLookupResolveX509Certificate( |
| Element element, String baseURI, StorageResolver storage |
| ) throws KeyResolverException { |
| return null; |
| } |
| |
| /** |
| * Method engineResolveSecretKey |
| * |
| * @param element |
| * @param baseURI |
| * @param storage |
| * @return resolved SecretKey key or null if no {@link SecretKey} could be obtained |
| * |
| * @throws KeyResolverException |
| */ |
| public SecretKey engineResolveSecretKey( |
| Element element, String baseURI, StorageResolver storage |
| ) throws KeyResolverException { |
| LOG.debug("Can I resolve {}?", element.getTagName()); |
| |
| if (XMLUtils.elementIsInSignatureSpace(element, Constants._TAG_KEYNAME)) { |
| String keyName = element.getFirstChild().getNodeValue(); |
| try { |
| Key key = keyStore.getKey(keyName, password); |
| if (key instanceof SecretKey) { |
| return (SecretKey) key; |
| } |
| } catch (Exception e) { |
| LOG.debug("Cannot recover the key", e); |
| } |
| } |
| |
| LOG.debug("I can't"); |
| return null; |
| } |
| |
| /** |
| * Method engineResolvePrivateKey |
| * {@inheritDoc} |
| * @param element |
| * @param baseURI |
| * @param storage |
| * @return resolved PrivateKey key or null if no {@link PrivateKey} could be obtained |
| * @throws KeyResolverException |
| */ |
| public PrivateKey engineLookupAndResolvePrivateKey( |
| Element element, String baseURI, StorageResolver storage |
| ) throws KeyResolverException { |
| return null; |
| } |
| } |