| /** |
| * 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.algorithms.implementations; |
| |
| import java.io.IOException; |
| import java.security.InvalidAlgorithmParameterException; |
| import java.security.InvalidKeyException; |
| import java.security.Key; |
| import java.security.NoSuchProviderException; |
| import java.security.PrivateKey; |
| import java.security.PublicKey; |
| import java.security.SecureRandom; |
| import java.security.Signature; |
| import java.security.SignatureException; |
| import java.security.spec.AlgorithmParameterSpec; |
| |
| import org.apache.xml.security.algorithms.JCEMapper; |
| import org.apache.xml.security.algorithms.SignatureAlgorithmSpi; |
| import org.apache.xml.security.signature.XMLSignature; |
| import org.apache.xml.security.signature.XMLSignatureException; |
| import org.apache.xml.security.utils.XMLUtils; |
| |
| /** |
| * |
| */ |
| public abstract class SignatureECDSA extends SignatureAlgorithmSpi { |
| |
| private static final org.slf4j.Logger LOG = |
| org.slf4j.LoggerFactory.getLogger(SignatureECDSA.class); |
| |
| /** {@inheritDoc} */ |
| public abstract String engineGetURI(); |
| |
| /** Field algorithm */ |
| private Signature signatureAlgorithm; |
| |
| /** |
| * Converts an ASN.1 ECDSA value to a XML Signature ECDSA Value. |
| * |
| * The JAVA JCE ECDSA Signature algorithm creates ASN.1 encoded (r, s) value |
| * pairs; the XML Signature requires the core BigInteger values. |
| * |
| * @param asn1Bytes |
| * @return the decode bytes |
| * |
| * @throws IOException |
| * @see <A HREF="http://www.w3.org/TR/xmldsig-core/#dsa-sha1">6.4.1 DSA</A> |
| * @see <A HREF="ftp://ftp.rfc-editor.org/in-notes/rfc4050.txt">3.3. ECDSA Signatures</A> |
| */ |
| public static byte[] convertASN1toXMLDSIG(byte asn1Bytes[]) throws IOException { |
| return ECDSAUtils.convertASN1toXMLDSIG(asn1Bytes); |
| } |
| |
| /** |
| * Converts a XML Signature ECDSA Value to an ASN.1 DSA value. |
| * |
| * The JAVA JCE ECDSA Signature algorithm creates ASN.1 encoded (r, s) value |
| * pairs; the XML Signature requires the core BigInteger values. |
| * |
| * @param xmldsigBytes |
| * @return the encoded ASN.1 bytes |
| * |
| * @throws IOException |
| * @see <A HREF="http://www.w3.org/TR/xmldsig-core/#dsa-sha1">6.4.1 DSA</A> |
| * @see <A HREF="ftp://ftp.rfc-editor.org/in-notes/rfc4050.txt">3.3. ECDSA Signatures</A> |
| */ |
| public static byte[] convertXMLDSIGtoASN1(byte xmldsigBytes[]) throws IOException { |
| return ECDSAUtils.convertXMLDSIGtoASN1(xmldsigBytes); |
| } |
| |
| /** |
| * Constructor SignatureRSA |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSA() throws XMLSignatureException { |
| |
| String algorithmID = JCEMapper.translateURItoJCEID(this.engineGetURI()); |
| |
| LOG.debug("Created SignatureECDSA using {}", algorithmID); |
| String provider = JCEMapper.getProviderId(); |
| try { |
| if (provider == null) { |
| this.signatureAlgorithm = Signature.getInstance(algorithmID); |
| } else { |
| this.signatureAlgorithm = Signature.getInstance(algorithmID, provider); |
| } |
| } catch (java.security.NoSuchAlgorithmException ex) { |
| Object[] exArgs = { algorithmID, ex.getLocalizedMessage() }; |
| |
| throw new XMLSignatureException("algorithms.NoSuchAlgorithm", exArgs); |
| } catch (NoSuchProviderException ex) { |
| Object[] exArgs = { algorithmID, ex.getLocalizedMessage() }; |
| |
| throw new XMLSignatureException("algorithms.NoSuchAlgorithm", exArgs); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineSetParameter(AlgorithmParameterSpec params) |
| throws XMLSignatureException { |
| try { |
| this.signatureAlgorithm.setParameter(params); |
| } catch (InvalidAlgorithmParameterException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected boolean engineVerify(byte[] signature) throws XMLSignatureException { |
| try { |
| byte[] jcebytes = SignatureECDSA.convertXMLDSIGtoASN1(signature); |
| |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("Called ECDSA.verify() on " + XMLUtils.encodeToString(signature)); |
| } |
| |
| return this.signatureAlgorithm.verify(jcebytes); |
| } catch (SignatureException ex) { |
| throw new XMLSignatureException(ex); |
| } catch (IOException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineInitVerify(Key publicKey) throws XMLSignatureException { |
| |
| if (!(publicKey instanceof PublicKey)) { |
| String supplied = null; |
| if (publicKey != null) { |
| supplied = publicKey.getClass().getName(); |
| } |
| String needed = PublicKey.class.getName(); |
| Object exArgs[] = { supplied, needed }; |
| |
| throw new XMLSignatureException("algorithms.WrongKeyForThisOperation", exArgs); |
| } |
| |
| try { |
| this.signatureAlgorithm.initVerify((PublicKey) publicKey); |
| } catch (InvalidKeyException ex) { |
| // reinstantiate Signature object to work around bug in JDK |
| // see: http://bugs.sun.com/view_bug.do?bug_id=4953555 |
| Signature sig = this.signatureAlgorithm; |
| try { |
| this.signatureAlgorithm = Signature.getInstance(signatureAlgorithm.getAlgorithm()); |
| } catch (Exception e) { |
| // this shouldn't occur, but if it does, restore previous |
| // Signature |
| LOG.debug("Exception when reinstantiating Signature: {}", e); |
| this.signatureAlgorithm = sig; |
| } |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected byte[] engineSign() throws XMLSignatureException { |
| try { |
| byte jcebytes[] = this.signatureAlgorithm.sign(); |
| |
| return SignatureECDSA.convertASN1toXMLDSIG(jcebytes); |
| } catch (SignatureException ex) { |
| throw new XMLSignatureException(ex); |
| } catch (IOException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineInitSign(Key privateKey, SecureRandom secureRandom) |
| throws XMLSignatureException { |
| if (!(privateKey instanceof PrivateKey)) { |
| String supplied = null; |
| if (privateKey != null) { |
| supplied = privateKey.getClass().getName(); |
| } |
| String needed = PrivateKey.class.getName(); |
| Object exArgs[] = { supplied, needed }; |
| |
| throw new XMLSignatureException("algorithms.WrongKeyForThisOperation", exArgs); |
| } |
| |
| try { |
| if (secureRandom == null) { |
| this.signatureAlgorithm.initSign((PrivateKey) privateKey); |
| } else { |
| this.signatureAlgorithm.initSign((PrivateKey) privateKey, secureRandom); |
| } |
| } catch (InvalidKeyException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineInitSign(Key privateKey) throws XMLSignatureException { |
| engineInitSign(privateKey, (SecureRandom)null); |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineUpdate(byte[] input) throws XMLSignatureException { |
| try { |
| this.signatureAlgorithm.update(input); |
| } catch (SignatureException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineUpdate(byte input) throws XMLSignatureException { |
| try { |
| this.signatureAlgorithm.update(input); |
| } catch (SignatureException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineUpdate(byte buf[], int offset, int len) throws XMLSignatureException { |
| try { |
| this.signatureAlgorithm.update(buf, offset, len); |
| } catch (SignatureException ex) { |
| throw new XMLSignatureException(ex); |
| } |
| } |
| |
| /** {@inheritDoc} */ |
| protected String engineGetJCEAlgorithmString() { |
| return this.signatureAlgorithm.getAlgorithm(); |
| } |
| |
| /** {@inheritDoc} */ |
| protected String engineGetJCEProviderName() { |
| return this.signatureAlgorithm.getProvider().getName(); |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineSetHMACOutputLength(int HMACOutputLength) |
| throws XMLSignatureException { |
| throw new XMLSignatureException("algorithms.HMACOutputLengthOnlyForHMAC"); |
| } |
| |
| /** {@inheritDoc} */ |
| protected void engineInitSign( |
| Key signingKey, AlgorithmParameterSpec algorithmParameterSpec |
| ) throws XMLSignatureException { |
| throw new XMLSignatureException("algorithms.CannotUseAlgorithmParameterSpecOnRSA"); |
| } |
| |
| /** |
| * Class SignatureECDSASHA1 |
| * |
| */ |
| public static class SignatureECDSASHA1 extends SignatureECDSA { |
| /** |
| * Constructor SignatureECDSASHA1 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSASHA1() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_SHA1; |
| } |
| } |
| |
| /** |
| * Class SignatureECDSASHA224 |
| */ |
| public static class SignatureECDSASHA224 extends SignatureECDSA { |
| |
| /** |
| * Constructor SignatureECDSASHA224 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSASHA224() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_SHA224; |
| } |
| } |
| |
| /** |
| * Class SignatureECDSASHA256 |
| * |
| */ |
| public static class SignatureECDSASHA256 extends SignatureECDSA { |
| |
| /** |
| * Constructor SignatureECDSASHA256 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSASHA256() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_SHA256; |
| } |
| } |
| |
| /** |
| * Class SignatureECDSASHA384 |
| * |
| */ |
| public static class SignatureECDSASHA384 extends SignatureECDSA { |
| |
| /** |
| * Constructor SignatureECDSASHA384 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSASHA384() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_SHA384; |
| } |
| } |
| |
| /** |
| * Class SignatureECDSASHA512 |
| * |
| */ |
| public static class SignatureECDSASHA512 extends SignatureECDSA { |
| |
| /** |
| * Constructor SignatureECDSASHA512 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSASHA512() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_SHA512; |
| } |
| } |
| |
| /** |
| * Class SignatureECDSARIPEMD160 |
| */ |
| public static class SignatureECDSARIPEMD160 extends SignatureECDSA { |
| |
| /** |
| * Constructor SignatureECDSARIPEMD160 |
| * |
| * @throws XMLSignatureException |
| */ |
| public SignatureECDSARIPEMD160() throws XMLSignatureException { |
| super(); |
| } |
| |
| /** {@inheritDoc} */ |
| public String engineGetURI() { |
| return XMLSignature.ALGO_ID_SIGNATURE_ECDSA_RIPEMD160; |
| } |
| } |
| |
| } |