Skip to content

Commit

Permalink
TKSS-1089: EC key pair generation based on OpenSSL
Browse files Browse the repository at this point in the history
  • Loading branch information
johnshajiang committed Jan 24, 2025
1 parent 39ffc99 commit 67f7d3c
Show file tree
Hide file tree
Showing 20 changed files with 1,038 additions and 18 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* Copyright (C) 2025, THL A29 Limited, a Tencent company. 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.
*/

package com.tencent.kona.crypto.perf;

import com.tencent.kona.crypto.TestUtils;
import org.openjdk.jmh.annotations.*;

import java.security.KeyPair;
import java.security.KeyPairGenerator;
import java.security.spec.ECGenParameterSpec;
import java.util.concurrent.TimeUnit;

/**
* The JMH-based performance test for SM2 key pair generation.
*/
@Warmup(iterations = 5, time = 5)
@Measurement(iterations = 5, time = 5)
@Fork(value = 2, jvmArgsAppend = {"-server", "-Xms2048M", "-Xmx2048M", "-XX:+UseG1GC"})
@Threads(1)
@BenchmarkMode(Mode.Throughput)
@OutputTimeUnit(TimeUnit.SECONDS)
public class ECKeyPairGenPerfTest {

static {
TestUtils.addProviders();
}

@State(Scope.Benchmark)
public static class KeyPairGenHolder {

@Param({"SunEC", "KonaCrypto-Native", "KonaCrypto-NativeOneShot"})
String provider;

@Param({"secp256r1", "secp384r1", "secp521r1"})
String curve;

KeyPairGenerator keyPairGenerator;

@Setup
public void setup() throws Exception {
keyPairGenerator = KeyPairGenerator.getInstance("EC", provider);
keyPairGenerator.initialize(new ECGenParameterSpec(curve));
}
}

@Benchmark
public KeyPair genKeyPair(KeyPairGenHolder holder) {
return holder.keyPairGenerator.generateKeyPair();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,14 @@ private static void putEntries(Provider provider) {
KonaCryptoProvider.putSMPBES2Entries(provider);
KonaCryptoProvider.putECEntries(provider);
SunRsaSignEntries.putEntries(provider);
putECEntries(provider);
}

private static void putSMEntries(Provider provider) {
provider.put("Cipher.SM4 SupportedPaddings", "NOPADDING|PKCS7PADDING");
provider.put("Cipher.SM4 SupportedModes", "CBC|CTR|ECB|GCM");
provider.put("Cipher.SM4",
"com.tencent.kona.crypto.provider.nativeImpl.SM4Cipher$NativeOneShot");;
"com.tencent.kona.crypto.provider.nativeImpl.SM4Cipher$NativeOneShot");
provider.put("AlgorithmParameters.SM4",
"com.tencent.kona.crypto.provider.SM4Parameters");
provider.put("AlgorithmParameterGenerator.SM4",
Expand Down Expand Up @@ -91,6 +92,11 @@ private static void putSMEntries(Provider provider) {
provider.put("KeyFactory.SM2", "com.tencent.kona.crypto.provider.SM2KeyFactory");
}

private static void putECEntries(Provider provider) {
provider.put("KeyPairGenerator.EC",
"com.tencent.kona.crypto.provider.nativeImpl.KonaOneShotECKeyPairGenerator");
}

public static KonaCryptoNativeOneShotProvider instance() {
if (instance == null) {
instance = new KonaCryptoNativeOneShotProvider();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ private static void putEntries(Provider provider) {
KonaCryptoProvider.putSMPBES2Entries(provider);
KonaCryptoProvider.putECEntries(provider);
SunRsaSignEntries.putEntries(provider);
putECEntries(provider);
}

private static void putSMEntries(Provider provider) {
Expand Down Expand Up @@ -91,6 +92,11 @@ private static void putSMEntries(Provider provider) {
provider.put("KeyFactory.SM2", "com.tencent.kona.crypto.provider.SM2KeyFactory");
}

private static void putECEntries(Provider provider) {
provider.put("KeyPairGenerator.EC",
"com.tencent.kona.crypto.provider.nativeImpl.KonaECKeyPairGenerator");
}

public static KonaCryptoNativeProvider instance() {
if (instance == null) {
instance = new KonaCryptoNativeProvider();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
/*
* Copyright (c) 2009, 2024, 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* 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.
*/

package com.tencent.kona.crypto.provider.nativeImpl;

import com.tencent.kona.crypto.util.Constants;
import com.tencent.kona.crypto.util.Sweeper;
import com.tencent.kona.sun.security.ec.ECPrivateKeyImpl;
import com.tencent.kona.sun.security.ec.ECPublicKeyImpl;
import com.tencent.kona.sun.security.jca.JCAUtil;
import com.tencent.kona.sun.security.util.ECUtil;
import com.tencent.kona.sun.security.util.SecurityProviderConstants;

import java.math.BigInteger;
import java.security.*;
import java.security.spec.*;
import java.util.*;

import static com.tencent.kona.crypto.util.Constants.*;

/**
* EC keypair generator.
* Standard algorithm, minimum key length is 112 bits, maximum is 571 bits.
*
* @since 1.7
*/
public final class KonaECKeyPairGenerator extends KeyPairGeneratorSpi {

private static final int KEY_SIZE_MIN = 112; // min bits (see ecc_impl.h)
private static final int KEY_SIZE_MAX = 571; // max bits (see ecc_impl.h)

// used to seed the keypair generator
private SecureRandom random;

// size of the key to generate, KEY_SIZE_MIN <= keySize <= KEY_SIZE_MAX
private int keySize;

// parameters specified via init, if any
private AlgorithmParameterSpec params = null;

private static final Sweeper SWEEPER = Sweeper.instance();
private NativeECKeyPairGen keyPairGen = null;

/**
* Constructs a new ECKeyPairGenerator.
*/
public KonaECKeyPairGenerator() {
// initialize to default in case the app does not call initialize()
initialize(SecurityProviderConstants.DEF_EC_KEY_SIZE, null);
}

// initialize the generator. See JCA doc
@Override
public void initialize(int keySize, SecureRandom random) {
keyPairGen = null;

checkKeySize(keySize);
this.params = ECUtil.getECParameterSpec(keySize);
if (params == null) {
throw new InvalidParameterException(
"No EC parameters available for key size " + keySize + " bits");
}
this.random = random;

byte[] encodedParams = ECUtil.encodeECParameterSpec((ECParameterSpec) params);
int curveNID = Constants.getNID(encodedParams);
keyPairGen = new NativeECKeyPairGen(curveNID);
SWEEPER.register(this, new SweepNativeRef(keyPairGen));
}

// second initialize method. See JCA doc
@Override
public void initialize(AlgorithmParameterSpec params, SecureRandom random)
throws InvalidAlgorithmParameterException {
keyPairGen = null;

ECParameterSpec ecSpec = null;

if (params instanceof ECParameterSpec) {
ECParameterSpec ecParams = (ECParameterSpec) params;
ecSpec = ECUtil.getECParameterSpec(ecParams);
if (ecSpec == null) {
throw new InvalidAlgorithmParameterException(
"Curve not supported: " + params);
}
} else if (params instanceof ECGenParameterSpec) {
String name = ((ECGenParameterSpec) params).getName();
ecSpec = ECUtil.getECParameterSpec(name);
if (ecSpec == null) {
throw new InvalidAlgorithmParameterException(
"Unknown curve name: " + name);
}
} else {
throw new InvalidAlgorithmParameterException(
"ECParameterSpec or ECGenParameterSpec required for EC");
}

// Not all known curves are supported by the native implementation
byte[] encodedParams = ECUtil.encodeECParameterSpec(ecSpec);
int curveNID = ensureCurveIsSupported(encodedParams, ecSpec);

keyPairGen = new NativeECKeyPairGen(curveNID);
SWEEPER.register(this, new SweepNativeRef(keyPairGen));
this.params = ecSpec;

this.keySize = ecSpec.getCurve().getField().getFieldSize();
this.random = random;
}

private static int ensureCurveIsSupported(
byte[] encodedParams, ECParameterSpec ecSpec)
throws InvalidAlgorithmParameterException {

int curveNID = Constants.getNID(encodedParams);
if (curveNID == -1) {
throw new InvalidAlgorithmParameterException(
"Curve not supported: " + ecSpec.toString());
}

// Check if ecSpec is a valid curve
AlgorithmParameters ecParams = ECUtil.getECParameters();
try {
ecParams.init(ecSpec);
} catch (InvalidParameterSpecException ex) {
throw new InvalidAlgorithmParameterException(
"Curve not supported: " + ecSpec.toString());
}

return curveNID;
}

// generate the keypair. See JCA doc
@Override
public KeyPair generateKeyPair() {

if (random == null) {
random = JCAUtil.getSecureRandom();
}

try {
Optional<KeyPair> kp = generateKeyPairImpl(random);
if (kp.isPresent()) {
return kp.get();
}
} catch (Exception ex) {
throw new ProviderException(ex);
}
throw new ProviderException("Curve not supported: " +
params.toString());
}

private Optional<KeyPair> generateKeyPairImpl(SecureRandom random)
throws Exception {
Object[] keyBytes = keyPairGen.genKeyPair();

ECParameterSpec ecParams = (ECParameterSpec) params;

BigInteger s = new BigInteger(1, (byte[]) keyBytes[0]);
PrivateKey privateKey = new ECPrivateKeyImpl(s, ecParams);

byte[] pubKey = (byte[]) keyBytes[1];
ECPoint w = ECUtil.decodePoint(pubKey, ecParams.getCurve());
PublicKey publicKey = new ECPublicKeyImpl(w, ecParams);

return Optional.of(new KeyPair(publicKey, privateKey));
}

private void checkKeySize(int keySize) throws InvalidParameterException {
if (keySize < KEY_SIZE_MIN) {
throw new InvalidParameterException
("Key size must be at least " + KEY_SIZE_MIN + " bits");
}
if (keySize > KEY_SIZE_MAX) {
throw new InvalidParameterException
("Key size must be at most " + KEY_SIZE_MAX + " bits");
}
this.keySize = keySize;
}
}
Loading

0 comments on commit 67f7d3c

Please sign in to comment.