diff --git a/.gitignore b/.gitignore index b14ab6b..370b496 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ inc/blst.h* inc/blst_aux.h* .vscode/ -.idea/ .clang-format *bindings/*/*.so *bindings/csharp/*.exe diff --git a/bindings/java/.gitignore b/bindings/java/.gitignore index 3c83e94..662f414 100644 --- a/bindings/java/.gitignore +++ b/bindings/java/.gitignore @@ -1,2 +1,5 @@ -*.class +.gradle/ +build/ +.idea/ +.iml *.o \ No newline at end of file diff --git a/bindings/java/CKzg4844JNI.java b/bindings/java/CKzg4844JNI.java deleted file mode 100644 index 4ef0bcb..0000000 --- a/bindings/java/CKzg4844JNI.java +++ /dev/null @@ -1,30 +0,0 @@ -public class CKzg4844JNI { - - public static int BYTES_PER_COMMITMENT = 48; - public static int BYTES_PER_PROOF = 48; - public static int FIELD_ELEMENTS_PER_BLOB = 4096; - public static int BYTES_PER_FIELD_ELEMENT = 32; - public static int BYTES_PER_BLOB = FIELD_ELEMENTS_PER_BLOB * BYTES_PER_FIELD_ELEMENT; - - static { - try { - System.loadLibrary("ckzg4844jni"); - } catch (UnsatisfiedLinkError ex) { - throw new RuntimeException(ex); - } - } - - public static native void loadTrustedSetup(String file); - - public static native void freeTrustedSetup(); - - public static native byte[] computeAggregateKzgProof(byte[] blobs, long count); - - public static native boolean verifyAggregateKzgProof(byte[] blobs, byte[] commitments, long count, - byte[] proof); - - public static native byte[] blobToKzgCommitment(byte[] blob); - - public static native boolean verifyKzgProof(byte[] commitment, byte[] z, byte[] y, byte[] proof); - -} diff --git a/bindings/java/Makefile b/bindings/java/Makefile new file mode 100644 index 0000000..0cd818b --- /dev/null +++ b/bindings/java/Makefile @@ -0,0 +1,22 @@ +INCLUDE_DIRS = ../../src ../../blst/bindings + +ifeq ($(OS),Windows_NT) + CLANG_EXECUTABLE=gcc + CLANG_FLAGS= + JNI_INCLUDE_FOLDER=win32 + LIBRARY_RESOURCE=ckzg4844jni.dll + GRADLE_COMMAND=gradlew +else + CLANG_EXECUTABLE=clang + CLANG_FLAGS=-fPIC + JNI_INCLUDE_FOLDER=linux + LIBRARY_RESOURCE=libckzg4844jni.so + GRADLE_COMMAND=./gradlew +endif + +c_kzg_4844_jni: + ${CLANG_EXECUTABLE} -O -Wall -shared ${CLANG_FLAGS} ${addprefix -I,${INCLUDE_DIRS}} -I"${JAVA_HOME}/include" -I"${JAVA_HOME}/include/${JNI_INCLUDE_FOLDER}" -o src/main/resources/lib/${LIBRARY_RESOURCE} c_kzg_4844_jni.c c_kzg_4844.o ../../lib/libblst.a +test: + ${GRADLE_COMMAND} clean test + + diff --git a/bindings/java/README.md b/bindings/java/README.md index 6c476a6..68ec40c 100644 --- a/bindings/java/README.md +++ b/bindings/java/README.md @@ -2,23 +2,17 @@ ## Prerequisites -* Follow the instructions in the [README.md](../../README.md) to install blst and C-KZG. +* Follow the instructions in the [README.md](../../README.md) to install blst and build the C-KZG code. * JAVA_HOME environment variable is set to a JDK with an `include` folder containing a jni.h file. -## Windows - -```bat -TBC -``` - -## Linux - +## Build ```bash -clang -O -Wall -shared -fPIC -I../../blst/bindings -I../../src/ -I${JAVA_HOME}/include -I${JAVA_HOME}/include/linux -o lib/libckzg4844jni.so c_kzg_4844_jni.c c_kzg_4844.o ../../lib/libblst.a +make c_kzg_4844_jni ``` -## Mac-OS +This will install the library in the `src/main/resources/lib` folder according to your os and arch +## Test ```bash -TBC +make test ``` diff --git a/bindings/java/build.gradle b/bindings/java/build.gradle new file mode 100644 index 0000000..56037bd --- /dev/null +++ b/bindings/java/build.gradle @@ -0,0 +1,15 @@ +plugins { + id "application" +} + +repositories { + mavenCentral() +} + +dependencies { + testImplementation("org.junit.jupiter:junit-jupiter:5.9.1") +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/bindings/java/gradle/wrapper/gradle-wrapper.jar b/bindings/java/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 Binary files /dev/null and b/bindings/java/gradle/wrapper/gradle-wrapper.jar differ diff --git a/bindings/java/gradle/wrapper/gradle-wrapper.properties b/bindings/java/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ae04661 --- /dev/null +++ b/bindings/java/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/bindings/java/gradlew b/bindings/java/gradlew new file mode 100644 index 0000000..ab2855b --- /dev/null +++ b/bindings/java/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" \ No newline at end of file diff --git a/bindings/java/gradlew.bat b/bindings/java/gradlew.bat new file mode 100644 index 0000000..89d1d91 --- /dev/null +++ b/bindings/java/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega \ No newline at end of file diff --git a/bindings/java/settings.gradle b/bindings/java/settings.gradle new file mode 100644 index 0000000..cb9d192 --- /dev/null +++ b/bindings/java/settings.gradle @@ -0,0 +1 @@ +rootProject.name="c-kzg-4844-jni" \ No newline at end of file diff --git a/bindings/java/src/main/java/CKzg4844JNI.java b/bindings/java/src/main/java/CKzg4844JNI.java new file mode 100644 index 0000000..a5696a9 --- /dev/null +++ b/bindings/java/src/main/java/CKzg4844JNI.java @@ -0,0 +1,55 @@ +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; + +public class CKzg4844JNI { + + private final static String LIBRARY_NAME = "ckzg4844jni"; + private final static String PLATFORM_NATIVE_LIBRARY_NAME = System.mapLibraryName(LIBRARY_NAME); + + static { + InputStream libraryResource = CKzg4844JNI.class.getResourceAsStream( + "lib/" + PLATFORM_NATIVE_LIBRARY_NAME); + if (libraryResource == null) { + try { + System.loadLibrary(LIBRARY_NAME); + } catch (UnsatisfiedLinkError ex) { + throw new RuntimeException(ex); + } + } else { + try { + Path tmpdir = Files.createTempDirectory(LIBRARY_NAME + "@"); + tmpdir.toFile().deleteOnExit(); + Path tmpdll = tmpdir.resolve(PLATFORM_NATIVE_LIBRARY_NAME); + tmpdll.toFile().deleteOnExit(); + Files.copy(libraryResource, tmpdll, StandardCopyOption.REPLACE_EXISTING); + libraryResource.close(); + System.load(tmpdll.toString()); + } catch (IOException ex) { + throw new RuntimeException(ex); + } + } + } + + public static int BYTES_PER_COMMITMENT = 48; + public static int BYTES_PER_PROOF = 48; + public static int FIELD_ELEMENTS_PER_BLOB = 4096; + public static int BYTES_PER_FIELD_ELEMENT = 32; + public static int BYTES_PER_BLOB = FIELD_ELEMENTS_PER_BLOB * BYTES_PER_FIELD_ELEMENT; + + public static native void loadTrustedSetup(String file); + + public static native void freeTrustedSetup(); + + public static native byte[] computeAggregateKzgProof(byte[] blobs, long count); + + public static native boolean verifyAggregateKzgProof(byte[] blobs, byte[] commitments, long count, + byte[] proof); + + public static native byte[] blobToKzgCommitment(byte[] blob); + + public static native boolean verifyKzgProof(byte[] commitment, byte[] z, byte[] y, byte[] proof); + +} diff --git a/bindings/java/lib/.gitignore b/bindings/java/src/main/resources/lib/.gitignore similarity index 100% rename from bindings/java/lib/.gitignore rename to bindings/java/src/main/resources/lib/.gitignore diff --git a/bindings/java/src/test/java/CKZg4844JNITest.java b/bindings/java/src/test/java/CKZg4844JNITest.java new file mode 100644 index 0000000..0857420 --- /dev/null +++ b/bindings/java/src/test/java/CKZg4844JNITest.java @@ -0,0 +1,79 @@ +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.nio.ByteBuffer; +import java.util.Arrays; +import java.util.Random; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +public class CKZg4844JNITest { + + private final Random random = new Random(); + + @BeforeEach + public void setUp() { + CKzg4844JNI.loadTrustedSetup("../../src/trusted_setup.txt"); + } + + @AfterEach + public void cleanUp() { + CKzg4844JNI.freeTrustedSetup(); + } + + @Test + public void computesAndVerifiesProofs() { + + final byte[] blob = createRandomBlob(); + final byte[] blob2 = createRandomBlob(); + + assertEquals(blob.length, CKzg4844JNI.BYTES_PER_BLOB); + assertEquals(blob2.length, CKzg4844JNI.BYTES_PER_BLOB); + + final byte[] commitment = CKzg4844JNI.blobToKzgCommitment(blob); + final byte[] commitment2 = CKzg4844JNI.blobToKzgCommitment(blob2); + + assertEquals(commitment.length, CKzg4844JNI.BYTES_PER_COMMITMENT); + assertEquals(commitment2.length, CKzg4844JNI.BYTES_PER_COMMITMENT); + + // flatten blobs and commitments + final byte[] blobs = flatten(blob, blob2); + final byte[] commitments = flatten(commitment, commitment2); + + final byte[] proof = CKzg4844JNI.computeAggregateKzgProof(blobs, 2); + + assertEquals(proof.length, CKzg4844JNI.BYTES_PER_PROOF); + + assertTrue(CKzg4844JNI.verifyAggregateKzgProof(blobs, commitments, 2, proof)); + + } + + @Test + public void verifiesPointEvaluationPrecompile() { + + final byte[] commitment = new byte[48]; + commitment[0] = (byte) 0xc0; + final byte[] z = new byte[32]; + final byte[] y = new byte[32]; + final byte[] proof = new byte[48]; + proof[0] = (byte) 0xc0; + + assertTrue(CKzg4844JNI.verifyKzgProof(commitment, z, y, proof)); + + } + + + private byte[] createRandomBlob() { + final byte[] blob = new byte[CKzg4844JNI.BYTES_PER_BLOB]; + random.nextBytes(blob); + return blob; + } + + private byte[] flatten(byte[]... bytes) { + final int capacity = Arrays.stream(bytes).mapToInt(b -> b.length).sum(); + final ByteBuffer buffer = ByteBuffer.allocate(capacity); + Arrays.stream(bytes).forEach(buffer::put); + return buffer.array(); + } +}