8308711: Develop additional Tests for KEM implementation

Reviewed-by: weijun
This commit is contained in:
Sibabrata Sahoo 2023-06-02 08:13:12 +00:00
parent dcd9590fed
commit aeb53e67f9
3 changed files with 542 additions and 0 deletions

View File

@ -0,0 +1,83 @@
/*
* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8297878
* @summary Generate large number of Secret Keys using same KEM
* @library /test/lib
* @run main/othervm -Djava.security.egd=file:/dev/urandom GenLargeNumberOfKeys
*/
import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.util.Arrays;
import javax.crypto.KEM;
import javax.crypto.SecretKey;
import java.security.spec.ECGenParameterSpec;
import jdk.test.lib.Asserts;
public class GenLargeNumberOfKeys {
private static final int COUNT = 1000;
public static void main(String[] args) throws Exception {
KEM kem = KEM.getInstance("DHKEM");
testAlgo(kem, "X448", null);
testAlgo(kem, "EC", "secp521r1");
}
private static void testAlgo(KEM kem, String algo, String curveId) throws Exception {
KeyPair kp = genKeyPair(algo, curveId);
KEM.Encapsulator e = kem.newEncapsulator(kp.getPublic());
KEM.Decapsulator d = kem.newDecapsulator(kp.getPrivate());
for (int i = 0; i < COUNT; i++) {
test(e, d);
}
System.out.println(algo + ": test Successful");
}
private static KeyPair genKeyPair(String algo, String curveId) throws Exception {
KeyPairGenerator kpg = KeyPairGenerator.getInstance(algo);
if (curveId != null) {
kpg.initialize(new ECGenParameterSpec(curveId));
}
return kpg.generateKeyPair();
}
private static void test(KEM.Encapsulator e, KEM.Decapsulator d)
throws Exception {
KEM.Encapsulated enc = e.encapsulate();
SecretKey sk = enc.key();
Asserts.assertEQ(d.encapsulationSize(), enc.encapsulation().length);
Asserts.assertEQ(d.secretSize(), enc.key().getEncoded().length);
Asserts.assertTrue(Arrays.equals(d.decapsulate(enc.encapsulation()).getEncoded(),
sk.getEncoded()));
// Repeated calls to encapsulation() on Encapsulated object don't change anything
Asserts.assertTrue(Arrays.equals(d.decapsulate(enc.encapsulation()).getEncoded(),
sk.getEncoded()));
Asserts.assertTrue(Arrays.equals(d.decapsulate(enc.encapsulation()).getEncoded(),
enc.key().getEncoded()));
}
}

View File

@ -0,0 +1,140 @@
/*
* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8297878
* @summary KEM using KeyPair generated through SunPKCS11 provider using NSS
* @library /test/lib ../../../sun/security/pkcs11
*/
import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.security.NoSuchAlgorithmException;
import java.security.Provider;
import java.security.PublicKey;
import java.security.SecureRandom;
import java.security.spec.ECGenParameterSpec;
import java.util.Arrays;
import javax.crypto.KEM;
import javax.crypto.SecretKey;
import jdk.test.lib.Asserts;
public class KemInterop extends PKCS11Test {
public static void main(String[] args) throws Exception {
main(new KemInterop(), args);
}
@Override
public void main(Provider p) throws Exception {
test("EC", "secp256r1", p);
test("EC", "secp384r1", p);
test("EC", "secp521r1", p);
test("X25519", null, p);
test("X448", null, p);
test("XDH", null, p);
}
private static void test(String algo, String curveId, Provider p) throws Exception {
@FunctionalInterface
interface KemTest<KP, SR> {
void test(KP kp, SR scr);
}
KemTest<KeyPair, SecureRandom> kemWithPKCSKeys = (kpr, scr) -> {
try {
KEM kem = KEM.getInstance("DHKEM", "SunJCE");
KEM.Encapsulator encT = encapsulator(kem, kpr.getPublic(), scr);
KEM.Encapsulator encT1 = encapsulator(kem, kpr.getPublic(), scr);
KEM.Encapsulated enc = encT.encapsulate();
KEM.Encapsulated enc1 = encT.encapsulate();
KEM.Encapsulated enc2 = encT1.encapsulate();
Asserts.assertTrue(Arrays.equals(enc.key().getEncoded(), enc.key().getEncoded()));
Asserts.assertTrue(Arrays.equals(enc.encapsulation(), enc.encapsulation()));
Asserts.assertFalse(Arrays.equals(enc.key().getEncoded(), enc1.key().getEncoded()));
Asserts.assertFalse(Arrays.equals(enc.encapsulation(), enc1.encapsulation()));
Asserts.assertFalse(Arrays.equals(enc.key().getEncoded(), enc2.key().getEncoded()));
Asserts.assertFalse(Arrays.equals(enc.encapsulation(), enc2.encapsulation()));
KEM.Decapsulator decT = kem.newDecapsulator(kpr.getPrivate());
SecretKey dsk = decT.decapsulate(enc.encapsulation());
Asserts.assertTrue(Arrays.equals(dsk.getEncoded(), enc.key().getEncoded()));
Asserts.assertEQ(encT.encapsulationSize(), enc.encapsulation().length);
Asserts.assertEQ(encT.encapsulationSize(), decT.encapsulationSize());
Asserts.assertEQ(encT.secretSize(), enc.key().getEncoded().length);
Asserts.assertEQ(encT.secretSize(), decT.secretSize());
Asserts.assertEQ(decT.secretSize(), dsk.getEncoded().length);
Asserts.assertEQ(decT.secretSize(),
decT.decapsulate(enc.encapsulation()).getEncoded().length);
Asserts.assertEQ(decT.decapsulate(enc.encapsulation()).getEncoded().length,
enc.key().getEncoded().length);
KEM.Encapsulated enc3 = encT.encapsulate(0, encT.secretSize(), "AES");
KEM.Decapsulator decT1 = kem.newDecapsulator(kpr.getPrivate());
SecretKey dsk1 = decT1.decapsulate(enc3.encapsulation(), 0, decT1.secretSize(), "AES");
Asserts.assertTrue(Arrays.equals(dsk1.getEncoded(), enc3.key().getEncoded()));
} catch (Exception e) {
throw new RuntimeException(e);
}
System.out.println("Success");
};
KeyPair kp = null;
SecureRandom sr = null;
try {
System.out.print("Algo-" + algo + ":" + "Curve-" + curveId + ":");
KeyPairGenerator kpg = KeyPairGenerator.getInstance(algo, p);
try {
sr = SecureRandom.getInstance("PKCS11");
} catch (NoSuchAlgorithmException e) {
// Get default SecureRandom incase PKCS11 not found
sr = new SecureRandom();
}
if (curveId != null) {
kpg.initialize(new ECGenParameterSpec(curveId), sr);
}
kp = kpg.generateKeyPair();
} catch (NoSuchAlgorithmException e) {
System.out.println("Unsupported. Test execution Ignored");
return;
}
kemWithPKCSKeys.test(kp, null);
kemWithPKCSKeys.test(kp, sr);
}
private static KEM.Encapsulator encapsulator(KEM kem, PublicKey pk, SecureRandom sr)
throws Exception {
if (sr == null) {
return kem.newEncapsulator(pk);
} else {
return kem.newEncapsulator(pk, sr);
}
}
}

View File

@ -0,0 +1,319 @@
/*
* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8297878
* @summary KEM API test
* @library /test/lib
* @run main/othervm -Djava.security.egd=file:/dev/urandom KemTest
*/
import java.security.InvalidAlgorithmParameterException;
import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.security.NoSuchAlgorithmException;
import java.security.spec.ECGenParameterSpec;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CompletionService;
import java.util.concurrent.ExecutorCompletionService;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import javax.crypto.KEM;
import javax.crypto.SecretKey;
import javax.crypto.DecapsulateException;
import jdk.test.lib.Asserts;
public class KemTest {
private static final int THREAD_COUNT = 100;
private static final int THREAD_POOL_SIZE = 20;
private static final String ALGO = "DHKEM";
private static final String PROVIDER = "SunJCE";
public static void main(String[] args) throws Exception {
KEM kem = KEM.getInstance(ALGO, PROVIDER);
Asserts.assertEQ(kem.getAlgorithm(), ALGO);
testSize(kem);
testParallelEncapsulator(kem, "EC", "secp256r1");
testParallelEncapsulate(kem, "EC", "secp256r1");
testParallelDecapsulator(kem, "EC", "secp256r1");
testParallelDecapsulate(kem, "EC", "secp256r1");
}
@FunctionalInterface
interface GenKeyPair<A, C, K> {
K gen(A a, C c);
}
private static final GenKeyPair<String, String, KeyPair> keyPair = (algo, curveId) -> {
try {
KeyPairGenerator kpg = KeyPairGenerator.getInstance(algo);
if (curveId != null) {
kpg.initialize(new ECGenParameterSpec(curveId));
}
return kpg.generateKeyPair();
} catch (InvalidAlgorithmParameterException | NoSuchAlgorithmException e) {
throw new RuntimeException(e);
}
};
/*
* As per https://www.rfc-editor.org/rfc/rfc9180#name-key-encapsulation-mechanism
* Nsecret: The length in bytes of a KEM shared secret produced by this KEM.
* Nenc: The length in bytes of an encapsulated key produced by this KEM.
*/
private static void testSize(KEM kem) throws Exception {
@FunctionalInterface
interface LengthTest<A, C, S, E> {
void test(A a, C c, S s, E e);
}
LengthTest<String, String, Integer, Integer> secretLen = (algo, curveId, nSecret, nEnc) -> {
try {
KeyPair kp = keyPair.gen(algo, curveId);
KEM.Encapsulator encT = kem.newEncapsulator(kp.getPublic());
Asserts.assertEQ(encT.providerName(), PROVIDER);
KEM.Encapsulated enc = encT.encapsulate();
KEM.Encapsulated enc1 = encT.encapsulate();
KEM kem1 = KEM.getInstance(ALGO, PROVIDER);
KEM.Encapsulator encT2 = kem1.newEncapsulator(kp.getPublic());
KEM.Encapsulated enc2 = encT2.encapsulate();
Asserts.assertEQ(enc.key().getEncoded().length, nSecret);
Asserts.assertEQ(enc.encapsulation().length, nEnc);
Asserts.assertTrue(Arrays.equals(enc.key().getEncoded(), enc.key().getEncoded()));
Asserts.assertTrue(Arrays.equals(enc.encapsulation(), enc.encapsulation()));
Asserts.assertFalse(Arrays.equals(enc.key().getEncoded(), enc1.key().getEncoded()));
Asserts.assertFalse(Arrays.equals(enc.encapsulation(), enc1.encapsulation()));
Asserts.assertFalse(Arrays.equals(enc.key().getEncoded(), enc2.key().getEncoded()));
Asserts.assertFalse(Arrays.equals(enc.encapsulation(), enc2.encapsulation()));
SecretKey sk = enc.key();
KEM.Decapsulator decT = kem.newDecapsulator(kp.getPrivate());
SecretKey dsk = decT.decapsulate(enc.encapsulation());
Asserts.assertEQ(decT.providerName(), PROVIDER);
Asserts.assertTrue(Arrays.equals(sk.getEncoded(), dsk.getEncoded()));
Asserts.assertTrue(Arrays.equals(sk.getEncoded(),
decT.decapsulate(enc.encapsulation()).getEncoded()));
Asserts.assertTrue(Arrays.equals(enc.key().getEncoded(),
decT.decapsulate(enc.encapsulation()).getEncoded()));
Asserts.assertEQ(encT.encapsulationSize(), enc.encapsulation().length);
Asserts.assertEQ(encT.encapsulationSize(), decT.encapsulationSize());
Asserts.assertEQ(encT.secretSize(), enc.key().getEncoded().length);
Asserts.assertEQ(encT.secretSize(), decT.secretSize());
Asserts.assertEQ(decT.secretSize(), dsk.getEncoded().length);
Asserts.assertEQ(decT.secretSize(),
decT.decapsulate(enc.encapsulation()).getEncoded().length);
Asserts.assertEQ(decT.decapsulate(enc.encapsulation()).getEncoded().length,
enc.key().getEncoded().length);
KEM.Encapsulated enc3 = encT.encapsulate(0, encT.secretSize(), "AES");
KEM.Decapsulator decT1 = kem.newDecapsulator(kp.getPrivate());
SecretKey dsk1 = decT1.decapsulate(
enc3.encapsulation(), 0, decT1.secretSize(), "AES");
Asserts.assertTrue(Arrays.equals(dsk1.getEncoded(), enc3.key().getEncoded()));
try {
decT.decapsulate(new byte[enc.encapsulation().length]);
throw new RuntimeException("Shouldn't reach here");
} catch (DecapsulateException de) {
//de.printStackTrace();
System.out.println("Expected Failure: mismatched encapsulation");
}
System.out.println("KEM Secret length:" + algo + ":" + curveId
+ ":nSecret:" + nSecret + ":nEnc:" + nEnc);
} catch (Exception e) {
throw new RuntimeException(e);
}
};
// Secret length in bytes.
secretLen.test("EC", "secp256r1", 32, 65);
secretLen.test("EC", "secp384r1", 48, 97);
secretLen.test("EC", "secp521r1", 64, 133);
secretLen.test("X25519", null, 32, 32);
secretLen.test("X448", null, 64, 56);
secretLen.test("XDH", null, 32, 32);
try {
secretLen.test("Ed25519", null, 32, 32);
} catch (Exception e) {
if (!e.getMessage().contains("java.security.InvalidKeyException")) {
throw e;
}
System.out.println("Expected Exception: Bad Key type: Ed25519");
}
try {
secretLen.test("RSA", null, 256, 256);
} catch (Exception e) {
if (!e.getMessage().contains("java.security.InvalidKeyException")) {
throw e;
}
System.out.println("Expected Exception: Bad Key type: RSA");
}
}
/*
* As per JavaDoc API,
* A KEM object is immutable. It is safe to call multiple newEncapsulator and
* newDecapsulator methods on the same KEM object at the same time.
*/
private static void testParallelEncapsulator(KEM kem, String algo, String curveId)
throws Exception {
KeyPair kp = keyPair.gen(algo, curveId);
ExecutorService executor = null;
try {
executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
CompletionService<KEM.Encapsulator> cs = new ExecutorCompletionService<>(executor);
List<Future<KEM.Encapsulator>> futures = new ArrayList<>();
for (int i = 0; i < THREAD_COUNT; i++) {
Callable<KEM.Encapsulator> task = () -> kem.newEncapsulator(kp.getPublic());
futures.add(cs.submit(task));
}
KEM.Decapsulator decT = kem.newDecapsulator(kp.getPrivate());
for (Future<KEM.Encapsulator> future : futures) {
KEM.Encapsulated enc = future.get().encapsulate();
Asserts.assertTrue(Arrays.equals(
decT.decapsulate(enc.encapsulation()).getEncoded(),
enc.key().getEncoded()));
}
} finally {
if (executor != null) {
executor.shutdown();
}
}
System.out.println("Parallel Encapsulator Test: Success");
}
/*
* As per JavaDoc API,
* Encapsulator and Decapsulator objects are also immutable.
* It is safe to invoke multiple encapsulate and decapsulate methods on the same
* Encapsulator or Decapsulator object at the same time.
*/
private static void testParallelEncapsulate(KEM kem, String algo, String curveId)
throws Exception {
KeyPair kp = keyPair.gen(algo, curveId);
ExecutorService executor = null;
try {
executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
CompletionService<KEM.Encapsulated> cs = new ExecutorCompletionService<>(executor);
List<Future<KEM.Encapsulated>> futures = new ArrayList<>();
KEM.Encapsulator encT = kem.newEncapsulator(kp.getPublic());
for (int i = 0; i < THREAD_COUNT; i++) {
Callable<KEM.Encapsulated> task = () -> encT.encapsulate();
futures.add(cs.submit(task));
}
KEM.Decapsulator decT = kem.newDecapsulator(kp.getPrivate());
for (Future<KEM.Encapsulated> future : futures) {
Asserts.assertTrue(Arrays.equals(
decT.decapsulate(future.get().encapsulation()).getEncoded(),
future.get().key().getEncoded()));
}
} finally {
if (executor != null) {
executor.shutdown();
}
}
System.out.println("Parallel Encapsulate Test: Success");
}
/*
* As per JavaDoc API,
* Encapsulator and Decapsulator objects are also immutable.
* It is safe to invoke multiple encapsulate and decapsulate methods on the same
* Encapsulator or Decapsulator object at the same time.
*/
private static void testParallelDecapsulator(KEM kem, String algo, String curveId)
throws Exception {
KeyPair kp = keyPair.gen(algo, curveId);
ExecutorService executor = null;
try {
executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
CompletionService<KEM.Decapsulator> cs = new ExecutorCompletionService<>(executor);
List<Future<KEM.Decapsulator>> futures = new ArrayList<>();
for (int i = 0; i < THREAD_COUNT; i++) {
Callable<KEM.Decapsulator> task = () -> kem.newDecapsulator(kp.getPrivate());
futures.add(cs.submit(task));
}
KEM.Encapsulated enc = kem.newEncapsulator(kp.getPublic()).encapsulate();
for (Future<KEM.Decapsulator> decT : futures) {
Asserts.assertTrue(Arrays.equals(
decT.get().decapsulate(enc.encapsulation()).getEncoded(),
enc.key().getEncoded()));
}
} finally {
if (executor != null) {
executor.shutdown();
}
}
System.out.println("Parallel Decapsulator Test: Success");
}
/*
* As per JavaDoc API,
* Encapsulator and Decapsulator objects are also immutable.
* It is safe to invoke multiple encapsulate and decapsulate methods on the same
* Encapsulator or Decapsulator object at the same time.
*/
private static void testParallelDecapsulate(KEM kem, String algo, String curveId)
throws Exception {
KeyPair kp = keyPair.gen(algo, curveId);
ExecutorService executor = null;
try {
executor = Executors.newFixedThreadPool(THREAD_POOL_SIZE);
CompletionService<SecretKey> cs = new ExecutorCompletionService<>(executor);
KEM.Encapsulator encT = kem.newEncapsulator(kp.getPublic());
KEM.Encapsulated enc = encT.encapsulate();
KEM.Decapsulator decT = kem.newDecapsulator(kp.getPrivate());
List<Future<SecretKey>> futures = new ArrayList<>();
for (int i = 0; i < THREAD_COUNT; i++) {
Callable<SecretKey> task = () -> decT.decapsulate(enc.encapsulation());
futures.add(cs.submit(task));
}
for (Future<SecretKey> future : futures) {
Asserts.assertTrue(Arrays.equals(future.get().getEncoded(),
enc.key().getEncoded()));
}
} finally {
if (executor != null) {
executor.shutdown();
}
}
System.out.println("Parallel Decapsulate Test: Success");
}
}