Add ML-DSA (FIPS 204) post-quantum signature support #651
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| /** | ||
| * 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.lang.System.Logger; | ||
| import java.lang.System.Logger.Level; | ||
| import java.security.InvalidAlgorithmParameterException; | ||
| import java.security.Key; | ||
| import java.security.NoSuchAlgorithmException; | ||
| import java.security.NoSuchProviderException; | ||
| import java.security.Provider; | ||
| 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; | ||
|
|
||
| /** | ||
| * ML-DSA (FIPS 204) signature algorithm implementation for XML-Dsig. | ||
| * Supports ML-DSA-44 (NIST security level 2), ML-DSA-65 (level 3), | ||
| * and ML-DSA-87 (level 5). Requires BouncyCastle 1.81+ as the JCA provider. | ||
| */ | ||
| public abstract class SignatureMLDSA extends SignatureAlgorithmSpi { | ||
|
Member
There was a problem hiding this comment. draft-eastlake-rfc9231bis (3.3.15) allows an optional |
||
|
|
||
| private static final Logger LOG = System.getLogger(SignatureMLDSA.class.getName()); | ||
|
|
||
| private final Signature signatureAlgorithm; | ||
|
|
||
| public SignatureMLDSA() throws XMLSignatureException { | ||
| this(null); | ||
| } | ||
|
|
||
| public SignatureMLDSA(Provider provider) throws XMLSignatureException { | ||
| String algorithmID = JCEMapper.translateURItoJCEID(this.engineGetURI()); | ||
| LOG.log(Level.DEBUG, "Created SignatureMLDSA using {0}", algorithmID); | ||
|
|
||
| try { | ||
| if (provider == null) { | ||
| String providerId = JCEMapper.getProviderId(); | ||
| if (providerId == null) { | ||
| this.signatureAlgorithm = Signature.getInstance(algorithmID); | ||
|
Member
There was a problem hiding this comment. I think you can dismiss all these alerts. |
||
| } else { | ||
| this.signatureAlgorithm = Signature.getInstance(algorithmID, providerId); | ||
|
|
||
| } | ||
| } else { | ||
| this.signatureAlgorithm = Signature.getInstance(algorithmID, provider); | ||
|
|
||
| } | ||
| } catch (NoSuchAlgorithmException | NoSuchProviderException ex) { | ||
| Object[] exArgs = { algorithmID, ex.getLocalizedMessage() }; | ||
| throw new XMLSignatureException("algorithms.NoSuchAlgorithm", exArgs); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineSetParameter(AlgorithmParameterSpec params) throws XMLSignatureException { | ||
| try { | ||
| this.signatureAlgorithm.setParameter(params); | ||
| } catch (InvalidAlgorithmParameterException ex) { | ||
| throw new XMLSignatureException(ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean engineVerify(byte[] signature) throws XMLSignatureException { | ||
| try { | ||
| LOG.log(Level.DEBUG, () -> "Called SignatureMLDSA.verify() on " + XMLUtils.encodeToString(signature)); | ||
| return this.signatureAlgorithm.verify(signature); | ||
| } catch (SignatureException ex) { | ||
| throw new XMLSignatureException(ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineInitVerify(Key publicKey) throws XMLSignatureException { | ||
| engineInitVerify(publicKey, signatureAlgorithm); | ||
| } | ||
|
|
||
| @Override | ||
| protected byte[] engineSign() throws XMLSignatureException { | ||
| try { | ||
| return this.signatureAlgorithm.sign(); | ||
| } catch (SignatureException ex) { | ||
| throw new XMLSignatureException(ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineInitSign(Key privateKey, SecureRandom secureRandom) | ||
| throws XMLSignatureException { | ||
| engineInitSign(privateKey, secureRandom, this.signatureAlgorithm); | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineInitSign(Key privateKey) throws XMLSignatureException { | ||
| engineInitSign(privateKey, (SecureRandom) null); | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineUpdate(byte[] input) throws XMLSignatureException { | ||
| try { | ||
| this.signatureAlgorithm.update(input); | ||
| } catch (SignatureException ex) { | ||
| throw new XMLSignatureException(ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineUpdate(byte input) throws XMLSignatureException { | ||
| try { | ||
| this.signatureAlgorithm.update(input); | ||
| } catch (SignatureException ex) { | ||
| throw new XMLSignatureException(ex); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| 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); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected String engineGetJCEAlgorithmString() { | ||
| return this.signatureAlgorithm.getAlgorithm(); | ||
| } | ||
|
|
||
| @Override | ||
| protected String engineGetJCEProviderName() { | ||
| return this.signatureAlgorithm.getProvider().getName(); | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineSetHMACOutputLength(int HMACOutputLength) throws XMLSignatureException { | ||
| throw new XMLSignatureException("algorithms.HMACOutputLengthOnlyForHMAC"); | ||
| } | ||
|
|
||
| @Override | ||
| protected void engineInitSign(Key signingKey, AlgorithmParameterSpec algorithmParameterSpec) | ||
| throws XMLSignatureException { | ||
| throw new XMLSignatureException("algorithms.CannotUseAlgorithmParameterSpecOnEdDSA"); | ||
| } | ||
|
|
||
| /** ML-DSA-44 — NIST security level 2. */ | ||
| public static class SignatureMLDSA44 extends SignatureMLDSA { | ||
| public SignatureMLDSA44() throws XMLSignatureException { | ||
| super(); | ||
| } | ||
| public SignatureMLDSA44(Provider provider) throws XMLSignatureException { | ||
| super(provider); | ||
| } | ||
| @Override | ||
| public String engineGetURI() { | ||
| return XMLSignature.ALGO_ID_SIGNATURE_MLDSA_44; | ||
| } | ||
| } | ||
|
|
||
| /** ML-DSA-65 — NIST security level 3. */ | ||
| public static class SignatureMLDSA65 extends SignatureMLDSA { | ||
| public SignatureMLDSA65() throws XMLSignatureException { | ||
| super(); | ||
| } | ||
| public SignatureMLDSA65(Provider provider) throws XMLSignatureException { | ||
| super(provider); | ||
| } | ||
| @Override | ||
| public String engineGetURI() { | ||
| return XMLSignature.ALGO_ID_SIGNATURE_MLDSA_65; | ||
| } | ||
| } | ||
|
|
||
| /** ML-DSA-87 — NIST security level 5. */ | ||
| public static class SignatureMLDSA87 extends SignatureMLDSA { | ||
| public SignatureMLDSA87() throws XMLSignatureException { | ||
| super(); | ||
| } | ||
| public SignatureMLDSA87(Provider provider) throws XMLSignatureException { | ||
| super(provider); | ||
| } | ||
| @Override | ||
| public String engineGetURI() { | ||
| return XMLSignature.ALGO_ID_SIGNATURE_MLDSA_87; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Draft 9 is now using
xmldsig-moreinstead oftbdso you may as well go ahead and use that, as that will probably be the final URI.