Refactoring in tls around ML-KEM changes

Author: peterdettman

tls/src/main/java/org/bouncycastle/tls/TlsUtils.java

@@ -5316,7 +5316,7 @@ static Hashtable addKeyShareToClientHello(TlsClientContext clientContext, TlsCli
         Hashtable clientAgreements = new Hashtable(3);
         Vector clientShares = new Vector(2);
 
-        collectKeyShares(clientContext, supportedGroups, keyShareGroups, clientAgreements, clientShares);
+        collectKeyShares(clientContext.getCrypto(), supportedGroups, keyShareGroups, clientAgreements, clientShares);
 
         // TODO[tls13-psk] When clientShares empty, consider not adding extension if pre_shared_key in use
         TlsExtensionsUtils.addKeyShareClientHello(clientExtensions, clientShares);
@@ -5332,7 +5332,7 @@ static Hashtable addKeyShareToClientHelloRetry(TlsClientContext clientContext, H
         Hashtable clientAgreements = new Hashtable(1, 1.0f);
         Vector clientShares = new Vector(1);
 
-        collectKeyShares(clientContext, supportedGroups, keyShareGroups, clientAgreements, clientShares);
+        collectKeyShares(clientContext.getCrypto(), supportedGroups, keyShareGroups, clientAgreements, clientShares);
 
         TlsExtensionsUtils.addKeyShareClientHello(clientExtensions, clientShares);
 
@@ -5345,10 +5345,9 @@ static Hashtable addKeyShareToClientHelloRetry(TlsClientContext clientContext, H
         return clientAgreements;
     }
 
-    private static void collectKeyShares(TlsClientContext clientContext, int[] supportedGroups, Vector keyShareGroups,
+    private static void collectKeyShares(TlsCrypto crypto, int[] supportedGroups, Vector keyShareGroups,
         Hashtable clientAgreements, Vector clientShares) throws IOException
     {
-        TlsCrypto crypto = clientContext.getCrypto();
         if (isNullOrEmpty(supportedGroups))
         {
             return;
@@ -5444,14 +5443,12 @@ static KeyShareEntry selectKeyShare(TlsCrypto crypto, ProtocolVersion negotiated
                     continue;
                 }
 
-                if ((NamedGroup.refersToAnECDHCurve(group) && !crypto.hasECDHAgreement()) ||
-                    (NamedGroup.refersToASpecificFiniteField(group) && !crypto.hasDHAgreement()) ||
-                    (NamedGroup.refersToASpecificKem(group) && !crypto.hasKemAgreement()))
+                if ((NamedGroup.refersToAnECDHCurve(group) && crypto.hasECDHAgreement()) ||
+                    (NamedGroup.refersToASpecificFiniteField(group) && crypto.hasDHAgreement()) ||
+                    (NamedGroup.refersToASpecificKem(group) && crypto.hasKemAgreement()))
                 {
-                    continue;
+                    return clientShare;
                 }
-
-                return clientShare;
             }
         }
         return null;
@@ -5481,14 +5478,12 @@ static int selectKeyShareGroup(TlsCrypto crypto, ProtocolVersion negotiatedVersi
                     continue;
                 }
 
-                if ((NamedGroup.refersToAnECDHCurve(group) && !crypto.hasECDHAgreement()) ||
-                    (NamedGroup.refersToASpecificFiniteField(group) && !crypto.hasDHAgreement()) ||
-                    (NamedGroup.refersToASpecificKem(group) && !crypto.hasKemAgreement()))
+                if ((NamedGroup.refersToAnECDHCurve(group) && crypto.hasECDHAgreement()) ||
+                    (NamedGroup.refersToASpecificFiniteField(group) && crypto.hasDHAgreement()) ||
+                    (NamedGroup.refersToASpecificKem(group) && crypto.hasKemAgreement()))
                 {
-                    continue;
+                    return group;
                 }
-
-                return group;
             }
         }
         return -1;

tls/src/main/java/org/bouncycastle/tls/crypto/TlsCrypto.java

@@ -69,13 +69,6 @@ public interface TlsCrypto
      */
     boolean hasECDHAgreement();
 
-    /**
-     * Return true if this TlsCrypto can support KEM key agreement.
-     *
-     * @return true if this instance can support KEM key agreement, false otherwise.
-     */
-    boolean hasKemAgreement();
-
     /**
      * Return true if this TlsCrypto can support the passed in block/stream encryption algorithm.
      *
@@ -92,6 +85,13 @@ public interface TlsCrypto
      */
     boolean hasHKDFAlgorithm(int cryptoHashAlgorithm);
 
+    /**
+     * Return true if this TlsCrypto can support KEM key agreement.
+     *
+     * @return true if this instance can support KEM key agreement, false otherwise.
+     */
+    boolean hasKemAgreement();
+
     /**
      * Return true if this TlsCrypto can support the passed in MAC algorithm.
      *

tls/src/main/java/org/bouncycastle/tls/crypto/impl/bc/BcTlsCrypto.java

@@ -316,11 +316,6 @@ public boolean hasECDHAgreement()
         return true;
     }
 
-    public boolean hasKemAgreement()
-    {
-        return true;
-    }
-
     public boolean hasEncryptionAlgorithm(int encryptionAlgorithm)
     {
         switch (encryptionAlgorithm)
@@ -379,6 +374,11 @@ public boolean hasHKDFAlgorithm(int cryptoHashAlgorithm)
         }
     }
 
+    public boolean hasKemAgreement()
+    {
+        return true;
+    }
+
     public boolean hasMacAlgorithm(int macAlgorithm)
     {
         switch (macAlgorithm)

tls/src/main/java/org/bouncycastle/tls/crypto/impl/jcajce/JcaTlsCrypto.java

@@ -582,11 +582,6 @@ public boolean hasECDHAgreement()
     {
         return true;
     }
-    
-    public boolean hasKemAgreement()
-    {
-        return true;
-    }
 
     public boolean hasEncryptionAlgorithm(int encryptionAlgorithm)
     {
@@ -636,6 +631,11 @@ public boolean hasHKDFAlgorithm(int cryptoHashAlgorithm)
         }
     }
 
+    public boolean hasKemAgreement()
+    {
+        return true;
+    }
+
     public boolean hasMacAlgorithm(int macAlgorithm)
     {
         switch (macAlgorithm)

tls/src/test/java/org/bouncycastle/tls/test/MockTlsKemClient.java

@@ -33,10 +33,17 @@
 import org.bouncycastle.util.encoders.Hex;
 
 class MockTlsKemClient
-        extends DefaultTlsClient
+    extends DefaultTlsClient
 {
     TlsSession session;
 
+    int[] namedGroups = new int[]
+    {
+        NamedGroup.MLKEM512,
+        NamedGroup.MLKEM768,
+        NamedGroup.MLKEM1024,
+    };
+
     MockTlsKemClient(TlsSession session)
     {
         super(new BcTlsCrypto());
@@ -52,25 +59,19 @@ protected Vector getProtocolNames()
         return protocolNames;
     }
 
-    public int[] supportedGroups = new int[] {
-        NamedGroup.MLKEM512,
-        NamedGroup.MLKEM768,
-        NamedGroup.MLKEM1024,
-    };
-
-    public void setSupportedGroups(int[] supportedGroups)
+    void setNamedGroups(int[] namedGroups)
     {
-        this.supportedGroups = supportedGroups;
+        this.namedGroups = namedGroups;
     }
 
     protected Vector getSupportedGroups(Vector namedGroupRoles) {
         TlsCrypto crypto = getCrypto();
         Vector supportedGroups = new Vector();
 
-        if (namedGroupRoles.contains(Integers.valueOf(NamedGroupRole.kem))) {
-            TlsUtils.addIfSupported(supportedGroups, crypto,
-                    this.supportedGroups);
-        };
+        if (namedGroupRoles.contains(Integers.valueOf(NamedGroupRole.kem)))
+        {
+            TlsUtils.addIfSupported(supportedGroups, crypto, this.namedGroups);
+        }
         return supportedGroups;
     }
 
@@ -82,8 +83,8 @@ public TlsSession getSessionToResume()
     public void notifyAlertRaised(short alertLevel, short alertDescription, String message, Throwable cause)
     {
         PrintStream out = (alertLevel == AlertLevel.fatal) ? System.err : System.out;
-        out.println("TLS client raised alert: " + AlertLevel.getText(alertLevel)
-                + ", " + AlertDescription.getText(alertDescription));
+        out.println("TLS KEM client raised alert: " + AlertLevel.getText(alertLevel)
+            + ", " + AlertDescription.getText(alertDescription));
         if (message != null)
         {
             out.println("> " + message);
@@ -98,7 +99,7 @@ public void notifyAlertReceived(short alertLevel, short alertDescription)
     {
         PrintStream out = (alertLevel == AlertLevel.fatal) ? System.err : System.out;
         out.println("TLS KEM client received alert: " + AlertLevel.getText(alertLevel)
-                + ", " + AlertDescription.getText(alertDescription));
+            + ", " + AlertDescription.getText(alertDescription));
     }
 
     public Hashtable getClientExtensions() throws IOException
@@ -141,24 +142,24 @@ public void notifyServerCertificate(TlsServerCertificate serverCertificate) thro
                     Certificate entry = Certificate.getInstance(chain[i].getEncoded());
                     // TODO Create fingerprint based on certificate signature algorithm digest
                     System.out.println("    fingerprint:SHA-256 " + TlsTestUtils.fingerprint(entry) + " ("
-                            + entry.getSubject() + ")");
+                        + entry.getSubject() + ")");
                 }
 
                 boolean isEmpty = serverCertificate == null || serverCertificate.getCertificate() == null
-                        || serverCertificate.getCertificate().isEmpty();
+                    || serverCertificate.getCertificate().isEmpty();
 
                 if (isEmpty)
                 {
                     throw new TlsFatalAlert(AlertDescription.bad_certificate);
                 }
 
                 String[] trustedCertResources = new String[]{ "x509-server-dsa.pem", "x509-server-ecdh.pem",
-                        "x509-server-ecdsa.pem", "x509-server-ed25519.pem", "x509-server-ed448.pem",
-                        "x509-server-rsa_pss_256.pem", "x509-server-rsa_pss_384.pem", "x509-server-rsa_pss_512.pem",
-                        "x509-server-rsa-enc.pem", "x509-server-rsa-sign.pem" };
+                    "x509-server-ecdsa.pem", "x509-server-ed25519.pem", "x509-server-ed448.pem",
+                    "x509-server-rsa_pss_256.pem", "x509-server-rsa_pss_384.pem", "x509-server-rsa_pss_512.pem",
+                    "x509-server-rsa-enc.pem", "x509-server-rsa-sign.pem" };
 
                 TlsCertificate[] certPath = TlsTestUtils.getTrustedCertPath(context.getCrypto(), chain[0],
-                        trustedCertResources);
+                    trustedCertResources);
 
                 if (null == certPath)
                 {
@@ -177,7 +178,7 @@ public TlsCredentials getClientCredentials(CertificateRequest certificateRequest
                 }
 
                 return TlsTestUtils.loadSignerCredentials(context, certificateRequest.getSupportedSignatureAlgorithms(),
-                        SignatureAlgorithm.rsa, "x509-client-rsa.pem", "x509-client-key-rsa.pem");
+                    SignatureAlgorithm.rsa, "x509-client-rsa.pem", "x509-client-key-rsa.pem");
             }
         };
     }
@@ -189,7 +190,7 @@ public void notifyHandshakeComplete() throws IOException
         ProtocolName protocolName = context.getSecurityParametersConnection().getApplicationProtocol();
         if (protocolName != null)
         {
-            System.out.println("KEM Client ALPN: " + protocolName.getUtf8Decoding());
+            System.out.println("Client ALPN: " + protocolName.getUtf8Decoding());
         }
 
         TlsSession newSession = context.getSession();
@@ -202,11 +203,11 @@ public void notifyHandshakeComplete() throws IOException
 
                 if (this.session != null && Arrays.areEqual(this.session.getSessionID(), newSessionID))
                 {
-                    System.out.println("KEM Client resumed session: " + hex);
+                    System.out.println("Client resumed session: " + hex);
                 }
                 else
                 {
-                    System.out.println("KEM Client established session: " + hex);
+                    System.out.println("Client established session: " + hex);
                 }
 
                 this.session = newSession;
@@ -215,14 +216,14 @@ public void notifyHandshakeComplete() throws IOException
             byte[] tlsServerEndPoint = context.exportChannelBinding(ChannelBinding.tls_server_end_point);
             if (null != tlsServerEndPoint)
             {
-                System.out.println("KEM Client 'tls-server-end-point': " + hex(tlsServerEndPoint));
+                System.out.println("Client 'tls-server-end-point': " + hex(tlsServerEndPoint));
             }
 
             byte[] tlsUnique = context.exportChannelBinding(ChannelBinding.tls_unique);
-            System.out.println("KEM Client 'tls-unique': " + hex(tlsUnique));
+            System.out.println("Client 'tls-unique': " + hex(tlsUnique));
 
             byte[] tlsExporter = context.exportChannelBinding(ChannelBinding.tls_exporter);
-            System.out.println("KEM Client 'tls-exporter': " + hex(tlsExporter));
+            System.out.println("Client 'tls-exporter': " + hex(tlsExporter));
         }
     }
 
@@ -240,4 +241,5 @@ protected String hex(byte[] data)
     {
         return data == null ? "(null)" : Hex.toHexString(data);
     }
-}
+}
+