Skip to content

Validate XDH native secret derivation #1411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
taoliult wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Validate XDH native secret derivation #1411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e882f7b
Validate XDH native secret derivation
taoliult Apr 22, 2026
c05c357
Validate XDH derived secret size before allocation
taoliult Apr 29, 2026
356d07e
Remove secretBufferSize
taoliult May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 1 addition & 10 deletions src/main/java/com/ibm/crypto/plus/provider/XDHKeyAgreement.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,17 +102,8 @@ protected Key engineDoPhase(Key key, boolean lastPhase)
}

try {
int secrectBufferSize = 0;
String curveName = ((NamedParameterSpec) xdhPublicKeyImpl.getParams()).getName();
if (NamedParameterSpec.X25519.getName().equalsIgnoreCase(curveName)) {
secrectBufferSize = SECRET_BUFFER_SIZE_X25519; // X25519 secret buffer size
} else if (NamedParameterSpec.X448.getName().equalsIgnoreCase(curveName)) {
secrectBufferSize = SECRET_BUFFER_SIZE_X448; // X448 secret buffer size
} else {
secrectBufferSize = 0; // Let OCK decide the size
}
this.secret = XECKey.computeECDHSecret(genCtx,
ockXecKeyPub.getPKeyId(), ockXecKeyPriv.getPKeyId(), secrectBufferSize, provider);
ockXecKeyPub.getPKeyId(), ockXecKeyPriv.getPKeyId(), provider);
} catch (NativeException e) {
//Validate the secret value for a small order point condition.
byte orValue = (byte) 0;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/crypto/plus/provider/base/NativeInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,7 +548,7 @@ public byte[] ECKEY_computeECDHSecret(long pubEcKeyId,
long privEcKeyId) throws NativeException;

public byte[] XECKEY_computeECDHSecret(long genCtx,
long pubEcKeyId, long privEcKeyId, int secrectBufferSize) throws NativeException;
long pubEcKeyId, long privEcKeyId) throws NativeException;


public byte[] ECKEY_signDatawithECDSA(byte[] digestBytes,
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/ibm/crypto/plus/provider/base/XECKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ public static XECKey generateKeyPair(int curveNum, int pub_size, OpenJCEPlusProv
}

public static byte[] computeECDHSecret(long genCtx, long pubId,
long privId, int secrectBufferSize, OpenJCEPlusProvider provider) throws NativeException {
long privId, OpenJCEPlusProvider provider) throws NativeException {
if (pubId == 0)
throw new IllegalArgumentException("The public key parameter is not valid");
if (privId == 0)
throw new IllegalArgumentException("The private key parameter is not valid");

NativeInterface nativeInterface = provider.isFIPS() ? NativeOCKAdapterFIPS.getInstance() : NativeOCKAdapterNonFIPS.getInstance();
byte[] sharedSecretBytes = nativeInterface.XECKEY_computeECDHSecret(
genCtx, pubId, privId, secrectBufferSize);
genCtx, pubId, privId);
//OCKDebug.Msg (debPrefix, methodName, "pubId :" + pubId + " privId :" + privId + " sharedSecretBytes :", sharedSecretBytes);
return sharedSecretBytes;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/ibm/crypto/plus/provider/ock/NativeOCKAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1112,9 +1112,9 @@ public byte[] ECKEY_computeECDHSecret(long pubEcKeyId, long privEcKeyId) throws
}

@Override
public byte[] XECKEY_computeECDHSecret(long genCtx, long pubEcKeyId, long privEcKeyId, int secrectBufferSize)
public byte[] XECKEY_computeECDHSecret(long genCtx, long pubEcKeyId, long privEcKeyId)
throws OCKException {
return NativeOCKImplementation.XECKEY_computeECDHSecret(ockContext.getId(), genCtx, pubEcKeyId, privEcKeyId, secrectBufferSize);
return NativeOCKImplementation.XECKEY_computeECDHSecret(ockContext.getId(), genCtx, pubEcKeyId, privEcKeyId);
}

@Override
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/ibm/crypto/plus/provider/ock/NativeOCKImplementation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,7 +722,7 @@ static public native byte[] ECKEY_computeECDHSecret(long ockContextId, long pubE
long privEcKeyId) throws OCKException;

static public native byte[] XECKEY_computeECDHSecret(long ockContextId, long genCtx,
long pubEcKeyId, long privEcKeyId, int secrectBufferSize) throws OCKException;
long pubEcKeyId, long privEcKeyId) throws OCKException;


static public native byte[] ECKEY_signDatawithECDSA(long ockContextId, byte[] digestBytes,
Expand Down
114 changes: 74 additions & 40 deletions src/main/native/ock/ECKey.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2227,7 +2227,7 @@ Java_com_ibm_crypto_plus_provider_ock_NativeOCKImplementation_ECKEY_1computeECDH
JNIEXPORT jbyteArray JNICALL
Java_com_ibm_crypto_plus_provider_ock_NativeOCKImplementation_XECKEY_1computeECDHSecret(
JNIEnv *env, jclass thisObj, jlong ockContextId, jlong genCtx,
jlong pubXecKeyId, jlong privXecKeyId, jint secretBufferSize) {
jlong pubXecKeyId, jlong privXecKeyId) {
static const char *functionName =
"NativeInterface_XECKEY_1computeECDHSecret";

Expand All @@ -2239,6 +2239,7 @@ Java_com_ibm_crypto_plus_provider_ock_NativeOCKImplementation_XECKEY_1computeECD
jbyteArray secretBytes = NULL;
unsigned char *secretBytesNative = NULL;
jboolean isCopy = 0;
size_t required_len = 0;
size_t secret_key_len = 0;
int rc = 0;

Expand All @@ -2250,56 +2251,89 @@ Java_com_ibm_crypto_plus_provider_ock_NativeOCKImplementation_XECKEY_1computeECD
NULL); /* Set private key */
if (NULL == gen_ctx) {
throwOCKException(env, 0, "NULL from ICC_EVP_PKEY_CTX_new");
} else {
ICC_EVP_PKEY_derive_init(ockCtx, gen_ctx);
ICC_EVP_PKEY_derive_set_peer(ockCtx, gen_ctx,
ockPubXecKey); /* Set public key */
if (secretBufferSize > 0) {
secret_key_len = secretBufferSize;
} else {
ICC_EVP_PKEY_derive(ockCtx, gen_ctx, NULL,
&secret_key_len); /* Get secret key size */
}
secretBytes = (*env)->NewByteArray(
env, secret_key_len); /* Create Java secret bytes array with size */
if (NULL == secretBytes) {
throwOCKException(env, 0, "NewByteArray failed");
} else {
secretBytesNative =
(unsigned char *)((*env)->GetPrimitiveArrayCritical(
env, secretBytes, &isCopy));
if (NULL == secretBytesNative) {
throwOCKException(env, 0,
"NULL from GetPrimitiveArrayCritical");
} else {
rc = ICC_EVP_PKEY_derive(ockCtx, gen_ctx, secretBytesNative,
&secret_key_len);
if (ICC_OSSL_SUCCESS != rc) {
throwOCKException(
env, 0, "ICC_EVP_PKEY_derive failed to derive a key");
}
ICC_EVP_PKEY_CTX_free(ockCtx, gen_ctx);
(*env)->ReleasePrimitiveArrayCritical(env, secretBytes,
secretBytesNative, 0);
if (debug) {
gslogFunctionExit(functionName);
}
return secretBytes;
}
}
goto cleanup;
}

rc = ICC_EVP_PKEY_derive_init(ockCtx, gen_ctx);
if (ICC_OSSL_SUCCESS != rc) {
throwOCKException(env, 0, "ICC_EVP_PKEY_derive_init failed");
goto cleanup;
}

rc = ICC_EVP_PKEY_derive_set_peer(ockCtx, gen_ctx, ockPubXecKey); /* Set public key */
if (ICC_OSSL_SUCCESS != rc) {
throwOCKException(env, 0, "ICC_EVP_PKEY_derive_set_peer failed");
goto cleanup;
}

/*
* Always query the required secret size before deriving the secret.
* This avoids deriving into a buffer with an incorrect size.
*/
rc = ICC_EVP_PKEY_derive(ockCtx, gen_ctx, NULL, &required_len); /* Get secret key size */
if (ICC_OSSL_SUCCESS != rc) {
throwOCKException(env, 0,
"ICC_EVP_PKEY_derive failed to get secret size");
goto cleanup;
}
if (required_len == 0) {
throwOCKException(env, 0, "Derived secret size is zero");
goto cleanup;
}

secret_key_len = required_len;

secretBytes = (*env)->NewByteArray(env, secret_key_len); /* Create Java secret bytes array */
if (NULL == secretBytes) {
throwOCKException(env, 0, "NewByteArray failed");
goto cleanup;
}

secretBytesNative = (unsigned char *)(*env)->GetPrimitiveArrayCritical(
env, secretBytes, &isCopy);
if (NULL == secretBytesNative) {
throwOCKException(env, 0, "NULL from GetPrimitiveArrayCritical");
goto cleanup;
}

rc = ICC_EVP_PKEY_derive(ockCtx, gen_ctx, secretBytesNative, &secret_key_len);
if (ICC_OSSL_SUCCESS != rc) {
throwOCKException(env, 0, "ICC_EVP_PKEY_derive failed to derive a key");
goto cleanup;
}

if (secret_key_len != required_len) {
throwOCKException(env, 0,
"Derived secret size does not match required size");
goto cleanup;
}

ICC_EVP_PKEY_CTX_free(ockCtx, gen_ctx);
gen_ctx = NULL;

(*env)->ReleasePrimitiveArrayCritical(env, secretBytes, secretBytesNative, 0);
secretBytesNative = NULL;

if (debug) {
gslogFunctionExit(functionName);
}

return secretBytes;

cleanup:
if (NULL != gen_ctx) {
ICC_EVP_PKEY_CTX_free(ockCtx, gen_ctx);
gen_ctx = NULL;
}

if (NULL != secretBytesNative) {
(*env)->ReleasePrimitiveArrayCritical(env, secretBytes,
secretBytesNative, 0);
(*env)->ReleasePrimitiveArrayCritical(env, secretBytes, secretBytesNative, 0);
secretBytesNative = NULL;
}

if (NULL != secretBytes) {
(*env)->DeleteLocalRef(env, secretBytes);
secretBytes = NULL;
}

if (debug) {
Expand Down
Loading