Set a "noop" illegal callback

The default "illegal" callback calls abort, which will crash the JVM or native app. We check arguments before calling secp256k1 so it should never happen, except when trying to create a partial musig2 signature with an secret nonce that does not match the private key. Methods that could be used to verify that the secret nonce does match the private key are not exported, hence the choice to set a custom callback.
Build a universal JNI binary for macos (#106 )
2024-04-15 19:35:39 +02:00 · 2024-03-12 10:09:34 +01:00 · 2024-03-04 19:29:52 +01:00 · 2024-03-04 17:58:20 +01:00 · 2024-02-14 18:28:19 +01:00
15 changed files with 136 additions and 54 deletions
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -22,7 +22,7 @@ buildscript {

 allprojects {
    group = "fr.acinq.secp256k1"
-    version = "0.14.0"
+    version = "0.16.0-SNAPSHOT"

    repositories {
        google()
@@ -58,6 +58,14 @@ kotlin {
        secp256k1CInterop("host")
    }

+    macosX64 {
+        secp256k1CInterop("host")
+    }
+
+    macosArm64 {
+        secp256k1CInterop("host")
+    }
+
    iosX64 {
        secp256k1CInterop("ios")
    }
--- a/gradle.properties
+++ b/gradle.properties
@@ -6,6 +6,7 @@ org.gradle.parallel = true
 kotlin.code.style = official
 kotlin.native.ignoreDisabledTargets = true
 kotlin.mpp.enableCInteropCommonization=true
+kotlin.native.cacheKind.macosArm64=none

 # Android
 android.useAndroidX = true
--- a/jni/c/src/fr_acinq_secp256k1_Secp256k1CFunctions.c
+++ b/jni/c/src/fr_acinq_secp256k1_Secp256k1CFunctions.c
@@ -44,6 +44,11 @@ void JNI_ThrowByName(JNIEnv *penv, const char *name, const char *msg)
    }                                                                          \
  }

+static void secp256k1_noop_illegal_callback_fn(const char* str, void* data) {
+   (void)str;
+   (void)data;
+}
+
 /*
 * Class:     fr_acinq_bitcoin_Secp256k1Bindings
 * Method:    secp256k1_context_create
@@ -51,7 +56,9 @@ void JNI_ThrowByName(JNIEnv *penv, const char *name, const char *msg)
 */
 JNIEXPORT jlong JNICALL Java_fr_acinq_secp256k1_Secp256k1CFunctions_secp256k1_1context_1create(JNIEnv *penv, jclass clazz, jint flags)
 {
-  return (jlong)secp256k1_context_create(flags);
+  jlong ctx = (jlong)secp256k1_context_create(flags);
+  secp256k1_context_set_illegal_callback(ctx, &secp256k1_noop_illegal_callback_fn, NULL);
+  return ctx;
 }

 /*
--- a/jni/jvm/build.sh
+++ b/jni/jvm/build.sh
@@ -17,6 +17,7 @@ if [ "$TARGET" == "linux" ]; then
  CC_OPTS="-fPIC"
 elif [ "$TARGET" == "darwin" ]; then
  OUTFILE=libsecp256k1-jni.dylib
+  CC_OPTS="-arch arm64 -arch x86_64"
 elif [ "$TARGET" == "mingw" ]; then
  OUTFILE=secp256k1-jni.dll
  CC=x86_64-w64-mingw32-gcc
--- a/jni/jvm/darwin/build.gradle.kts
+++ b/jni/jvm/darwin/build.gradle.kts
@@ -12,12 +12,8 @@ dependencies {
 val copyJni by tasks.creating(Sync::class) {
    onlyIf { org.gradle.internal.os.OperatingSystem.current().isMacOsX }
    dependsOn(":jni:jvm:buildNativeHost")
-    val arch = when (System.getProperty("os.arch")) {
-        "aarch64" -> "aarch64"
-        else -> "x86_64"
-    }
    from(rootDir.resolve("jni/jvm/build/darwin/libsecp256k1-jni.dylib"))
-    into(buildDir.resolve("jniResources/fr/acinq/secp256k1/jni/native/darwin-$arch"))
+    into(buildDir.resolve("jniResources/fr/acinq/secp256k1/jni/native/darwin"))
 }

 (tasks["processResources"] as ProcessResources).apply {
--- a/jni/jvm/src/main/kotlin/fr/acinq/secp256k1/jni/OSInfo.kt
+++ b/jni/jvm/src/main/kotlin/fr/acinq/secp256k1/jni/OSInfo.kt
@@ -19,7 +19,8 @@ internal object OSInfo {
   private const val PPC = "ppc"
   private const val PPC64 = "ppc64"

-   @JvmStatic val nativeSuffix: String get() = "$os-$arch"
+    // on macos we build a universal library that contains arm64 and x64 binaries
+   @JvmStatic val nativeSuffix: String get() = if (os == "darwin") os else "$os-$arch"

   @JvmStatic val os: String get() = translateOSName(System.getProperty("os.name"))

--- a/native/build.sh
+++ b/native/build.sh
@@ -12,18 +12,20 @@ cd "$(dirname "$0")"
 cd secp256k1

 if [ "$TARGET" == "mingw" ]; then
-  CONF_OPTS="CFLAGS=-fPIC --host=x86_64-w64-mingw32"
+  CFLAGS="-fPIC"
+  CONF_OPTS=" --host=x86_64-w64-mingw32"
 elif [ "$TARGET" == "linux" ]; then
-  CONF_OPTS="CFLAGS=-fPIC"
+  CFLAGS="-fPIC"
 elif [ "$TARGET" == "darwin" ]; then
-  CONF_OPTS=""
+  CFLAGS="-arch arm64 -arch x86_64"
+  LDFLAGS="-arch arm64 -arch x86_64"
 else
  echo "Unknown TARGET=$TARGET"
  exit 1
 fi

 ./autogen.sh
-./configure $CONF_OPTS --enable-experimental --enable-module_ecdh --enable-module-recovery --enable-module-schnorrsig --enable-module-musig --enable-benchmark=no --enable-shared=no --enable-exhaustive-tests=no --enable-tests=no
+CFLAGS="$CFLAGS" LDFLAGS="$LDFLAGS" ./configure $CONF_OPTS --enable-experimental --enable-module_ecdh --enable-module-recovery --enable-module-schnorrsig --enable-module-musig --enable-benchmark=no --enable-shared=no --enable-exhaustive-tests=no --enable-tests=no
 make clean
 make

--- a/publishing/secp256k1-kmp-add-darwinaarch64.sh
+++ b/publishing/secp256k1-kmp-add-darwinaarch64.sh
@@ -1,5 +1,10 @@
 #!/bin/bash -x

+if [[ -z "${VERSION}" ]]; then
+  echo "VERSION is not defined"
+  exit 1
+fi
+
 if [ $# -eq 0 ]
  then
    echo "specify either snapshot or release"
--- a/publishing/secp256k1-kmp-add-linuxarm64.sh
+++ b/publishing/secp256k1-kmp-add-linuxarm64.sh
@@ -1,5 +1,10 @@
 #!/bin/bash -x

+if [[ -z "${VERSION}" ]]; then
+  echo "VERSION is not defined"
+  exit 1
+fi
+
 if [ $# -eq 0 ]
  then
    echo "specify either snapshot or release"
--- a/publishing/secp256k1-kmp-snapshot-deploy.sh
+++ b/publishing/secp256k1-kmp-snapshot-deploy.sh
@@ -21,45 +21,52 @@ mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/conte
  -Djavadoc=$ARTIFACT_ID_BASE-$VERSION-javadoc.jar
 popd
 pushd .
-for i in iosarm64 iossimulatorarm64 iosx64 jni-android jni-common jni-jvm-darwin jni-jvm-extract jni-jvm-linux jni-jvm-mingw jni-jvm jvm linuxx64; do
+for i in iosarm64 iossimulatorarm64 iosx64 macosarm64 macosx64 jni-android jni-common jni-jvm-darwin jni-jvm-extract jni-jvm-linux jni-jvm-mingw jni-jvm jvm linuxx64; do
  cd fr/acinq/secp256k1/secp256k1-kmp-$i/$VERSION
-  if [ $i == iosarm64 ] || [ $i == iossimulatorarm64 ] || [ $i == iosx64 ]; then
-    mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
-      -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
-      -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.klib \
-      -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION-metadata.jar,$ARTIFACT_ID_BASE-$i-$VERSION.module,$ARTIFACT_ID_BASE-$i-$VERSION-cinterop-libsecp256k1.klib \
-      -Dtypes=jar,module,klib \
-      -Dclassifiers=metadata,,cinterop-libsecp256k1 \
-      -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
-      -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
-  elif [ $i == linuxx64 ]; then
-    mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
-      -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
-      -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.klib \
-      -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module,$ARTIFACT_ID_BASE-$i-$VERSION-cinterop-libsecp256k1.klib \
-      -Dtypes=module,klib \
-      -Dclassifiers=,cinterop-libsecp256k1 \
-      -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
-      -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
-  elif [ $i == jni-android ]; then
-    mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
-      -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
-      -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.aar \
-      -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module \
-      -Dtypes=module \
-      -Dclassifiers= \
-      -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
-      -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
-  else
-    mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
-      -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
-      -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.jar \
-      -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module \
-      -Dtypes=module \
-      -Dclassifiers= \
-      -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
-      -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
-  fi
+
+  case $i in
+    iosarm64 | iossimulatorarm64 | iosx64 | macosarm64 | macosx64)
+          mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
+            -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
+            -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.klib \
+            -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION-metadata.jar,$ARTIFACT_ID_BASE-$i-$VERSION.module,$ARTIFACT_ID_BASE-$i-$VERSION-cinterop-libsecp256k1.klib \
+            -Dtypes=jar,module,klib \
+            -Dclassifiers=metadata,,cinterop-libsecp256k1 \
+            -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
+            -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
+          ;;
+    linuxx64)
+      mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
+        -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
+        -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.klib \
+        -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module,$ARTIFACT_ID_BASE-$i-$VERSION-cinterop-libsecp256k1.klib \
+        -Dtypes=module,klib \
+        -Dclassifiers=,cinterop-libsecp256k1 \
+        -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
+        -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
+      ;;
+    jni-android)
+      mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
+        -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
+        -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.aar \
+        -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module \
+        -Dtypes=module \
+        -Dclassifiers= \
+        -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
+        -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
+      ;;
+    *)
+      mvn deploy:deploy-file -DrepositoryId=ossrh -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
+        -DpomFile=$ARTIFACT_ID_BASE-$i-$VERSION.pom \
+        -Dfile=$ARTIFACT_ID_BASE-$i-$VERSION.jar \
+        -Dfiles=$ARTIFACT_ID_BASE-$i-$VERSION.module \
+        -Dtypes=module \
+        -Dclassifiers= \
+        -Dsources=$ARTIFACT_ID_BASE-$i-$VERSION-sources.jar \
+        -Djavadoc=$ARTIFACT_ID_BASE-$i-$VERSION-javadoc.jar
+      ;;
+  esac
+
  popd
  pushd .
 done
--- a/publishing/secp256k1-kmp-staging-upload.sh
+++ b/publishing/secp256k1-kmp-staging-upload.sh
@@ -3,9 +3,22 @@
 # first you must sign all files:
 # find release -type f -print -exec gpg -ab {} \;

-VERSION=0.6.2
+if [[ -z "${VERSION}" ]]; then
+  echo "VERSION is not defined"
+  exit 1
+fi
+
+if [[ -z "${OSS_USER}" ]]; then
+  echo "OSS_USER is not defined"
+  exit 1
+fi
+
+read -p "Password : " -s OSS_PASSWORD
+
+
 for i in 	secp256k1-kmp \
 		secp256k1-kmp-iosarm64 \
+		secp256k1-kmp-iossimulatorarm64 \
 		secp256k1-kmp-iosx64 \
 		secp256k1-kmp-jni-android \
 		secp256k1-kmp-jni-common \
@@ -15,14 +28,14 @@ for i in 	secp256k1-kmp \
 		secp256k1-kmp-jni-jvm-linux \
 		secp256k1-kmp-jni-jvm-mingw \
 		secp256k1-kmp-jvm \
-		secp256k1-kmp-linux
+		secp256k1-kmp-linuxx64
 do
 	pushd .
 	cd release/fr/acinq/secp256k1/$i/$VERSION
 	pwd
 	jar -cvf bundle.jar *
 	# use correct sonatype credentials here
-  curl -v -XPOST -u USER:PASSWORD --upload-file bundle.jar https://oss.sonatype.org/service/local/staging/bundle_upload
+  curl -v -XPOST -u $OSS_USER:$OSS_PASSWORD --upload-file bundle.jar https://oss.sonatype.org/service/local/staging/bundle_upload
  popd
 done

--- a/src/nativeInterop/cinterop/libsecp256k1.def
+++ b/src/nativeInterop/cinterop/libsecp256k1.def
@@ -7,6 +7,14 @@ staticLibraries.linux = libsecp256k1.a
 libraryPaths.linux = c/secp256k1/build/linux/ native/build/linux/ native/build/darwin/
 linkerOpts.linux = -L/usr/lib64 -L/usr/lib/x86_64-linux-gnu -L/usr/local/lib

+staticLibraries.macos_x64 = libsecp256k1.a
+libraryPaths.macos_x64 = c/secp256k1/build/darwin/ native/build/darwin/
+linkerOpts.macos_x64 = -framework Security -framework Foundation
+
+staticLibraries.macos_arm64 = libsecp256k1.a
+libraryPaths.macos_arm64 = c/secp256k1/build/darwin/ native/build/darwin/
+linkerOpts.macos_arm64 = -framework Security -framework Foundation
+
 staticLibraries.ios = libsecp256k1.a
 libraryPaths.ios_x64 = c/secp256k1/build/ios/ /usr/local/lib native/build/ios/
 libraryPaths.ios_arm64 = c/secp256k1/build/ios/ /usr/local/lib native/build/ios/
--- a/src/nativeMain/kotlin/fr/acinq/secp256k1/Secp256k1Native.kt
+++ b/src/nativeMain/kotlin/fr/acinq/secp256k1/Secp256k1Native.kt
@@ -9,8 +9,11 @@ import secp256k1.*
 public object Secp256k1Native : Secp256k1 {

    private val ctx: CPointer<secp256k1_context> by lazy {
-        secp256k1_context_create((SECP256K1_FLAGS_TYPE_CONTEXT or SECP256K1_FLAGS_BIT_CONTEXT_SIGN or SECP256K1_FLAGS_BIT_CONTEXT_VERIFY).toUInt())
+        val c = secp256k1_context_create((SECP256K1_FLAGS_TYPE_CONTEXT or SECP256K1_FLAGS_BIT_CONTEXT_SIGN or SECP256K1_FLAGS_BIT_CONTEXT_VERIFY).toUInt())
            ?: error("Could not create secp256k1 context")
+        val callback = staticCFunction { _: CPointer<ByteVar>?, _: COpaquePointer? -> }
+        secp256k1_context_set_illegal_callback(c, callback, null)
+        c
    }

    private fun Int.requireSuccess(message: String): Int = if (this != 1) throw Secp256k1Exception(message) else this
--- a/tests/build.gradle.kts
+++ b/tests/build.gradle.kts
@@ -57,6 +57,8 @@ kotlin {
    }

    linuxX64()
+    macosX64()
+    macosArm64()
    iosX64()
    iosArm64()
    iosSimulatorArm64()
--- a/tests/src/commonTest/kotlin/fr/acinq/secp256k1/Secp256k1Test.kt
+++ b/tests/src/commonTest/kotlin/fr/acinq/secp256k1/Secp256k1Test.kt
@@ -520,6 +520,29 @@ class Secp256k1Test {
                -1
            )
        }
+        assertFails {
+            val privkeys = listOf(
+                "0101010101010101010101010101010101010101010101010101010101010101",
+                "0202020202020202020202020202020202020202020202020202020202020202",
+            ).map { Hex.decode(it) }.toTypedArray()
+            val pubkeys = privkeys.map { Secp256k1.pubkeyCreate(it) }
+
+            val sessionId = Hex.decode("0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F0F")
+            val nonces = pubkeys.map { Secp256k1.musigNonceGen(sessionId, null, it, null, null, null) }
+            val secnonces = nonces.map { it.copyOfRange(0, 132) }
+            val pubnonces = nonces.map { it.copyOfRange(132, 132 + 66) }
+            val aggnonce = Secp256k1.musigNonceAgg(pubnonces.toTypedArray())
+
+            val keyaggCaches = (0 until 2).map { ByteArray(Secp256k1.MUSIG2_PUBLIC_KEYAGG_CACHE_SIZE) }
+            val aggpubkey = Secp256k1.musigPubkeyAgg(pubkeys.toTypedArray(), keyaggCaches[0])
+            assertContentEquals(aggpubkey, Secp256k1.musigPubkeyAgg(pubkeys.toTypedArray(), keyaggCaches[1]))
+            assertContentEquals(keyaggCaches[0], keyaggCaches[1])
+            val msg32 = Hex.decode("0303030303030303030303030303030303030303030303030303030303030303")
+            val sessions = (0 until 2).map { Secp256k1.musigNonceProcess(aggnonce, msg32, keyaggCaches[it]) }
+
+            // we sign with the wrong secret nonce. it should fail (i.e. trigger an exception) but not crash the JVM
+            Secp256k1.musigPartialSign(secnonces[1], privkeys[0], keyaggCaches[0], sessions[0])
+        }
    }

    @Test
Author	SHA1	Message	Date
sstone	61df0e8a9a	Set a "noop" illegal callback The default "illegal" callback calls abort, which will crash the JVM or native app. We check arguments before calling secp256k1 so it should never happen, except when trying to create a partial musig2 signature with an secret nonce that does not match the private key. Methods that could be used to verify that the secret nonce does match the private key are not exported, hence the choice to set a custom callback.	2024-04-15 19:35:39 +02:00
Fabrice Drouin	eb92fccbd6	Build a universal JNI binary for macos (#106 ) Universal libraries embed both arm64 and x64 binaries.	2024-03-12 10:09:34 +01:00
Fabrice Drouin	d30e2a1b59	Set version to 0.15.0 (#105 )	2024-03-04 19:29:52 +01:00
Fabrice Drouin	bae4744bcb	Add macos build targets (#104 ) * Add macos build targets * Update snapshot publishing script	2024-03-04 17:58:20 +01:00
Fabrice Drouin	b2eb68bf83	Post release cleanup (#103 ) * Set version to 0.15.0-SNAPSHOT * Update publishing scripts	2024-02-14 18:28:19 +01:00