add crypto interface

Author: HaoXuan40404

.github/workflows/build.yml

@@ -31,5 +31,5 @@ jobs:
           cp ./lab-core-dynamic-libs/* ./solution/vcl/src/main/resources/WeDPR_dynamic_lib/
       - name: compile and run ut
         run: bash ./gradlew clean build
-      - name: run demo
-        run: cd solution/vcl/dist/ && java -cp "apps/*:conf/:libs/*" com.webank.wedpr.vcl.DemoMain
+      # - name: run demo
+      #   run: cd solution/vcl/dist/ && java -cp "apps/*:conf/:libs/*" com.webank.wedpr.vcl.DemoMain

.gitignore

@@ -24,6 +24,8 @@
 *.dylib
 *.dll
 *.so
+.DS_Store
+*/.DS_Store
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*

release_note.txt

@@ -0,0 +1 @@
+v1.0.0

settings.gradle

@@ -10,3 +10,4 @@
 rootProject.name = 'WeDPR-Lab-Java-SDK'
 include 'common'
 include 'solution:vcl'
+include 'solution:crypto'

solution/crypto/build.gradle

@@ -0,0 +1,21 @@
+plugins {
+    id 'java'
+    id 'com.github.sherter.google-java-format' version '0.8'
+}
+
+group 'com.webank'
+version '1.0.0-SNAPSHOT'
+
+sourceCompatibility = 1.8
+
+repositories {
+    mavenCentral()
+}
+
+test.onlyIf { project.hasProperty('runTest') }
+verifyGoogleJavaFormat.onlyIf { project.hasProperty('runVerifyGoogleJavaFormat') }
+
+dependencies {
+    compile project(':common')
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+}

solution/crypto/src/main/java/com/webank/wedpr/crypto/CryptoClient.java

@@ -0,0 +1,45 @@
+// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+package com.webank.wedpr.crypto;
+
+import com.webank.wedpr.common.WedprException;
+
+/**
+ * Client class used by WeDPR crypto. This is the main interface class for Java apps using VCL
+ * functions.
+ */
+public class CryptoClient {
+
+  /**
+   * @param pubKey
+   * @param plaintext
+   * @return
+   * @throws WedprException
+   */
+  public CryptoResult secp256k1EciesEncrypt(String pubKey, String plaintext) throws WedprException {
+    return NativeInterface.secp256k1EciesEncrypt(pubKey, plaintext).expectNoError();
+  }
+
+  public CryptoResult secp256k1EciesDecrypt(String priKey, String ciphertext)
+      throws WedprException {
+    return NativeInterface.secp256k1EciesDecrypt(priKey, ciphertext).expectNoError();
+  }
+
+  public CryptoResult secp256k1GenKeyPair() throws WedprException {
+    return NativeInterface.secp256k1GenKeyPair().expectNoError();
+  }
+
+  public CryptoResult keccak256Hash(String message) throws WedprException {
+    return NativeInterface.keccak256Hash(message).expectNoError();
+  }
+
+  public CryptoResult secp256k1Sign(String priKey, String messageHash) throws WedprException {
+    return NativeInterface.secp256k1Sign(priKey, messageHash).expectNoError();
+  }
+
+  public CryptoResult secp256k1Verify(String pubKey, String messageHash, String signature)
+      throws WedprException {
+    return NativeInterface.secp256k1Verify(pubKey, messageHash, signature).expectNoError();
+  }
+
+  // TODO: Add a getVclConfig function to expose the value of RANGE_SIZE_IN_BITS.
+}

solution/crypto/src/main/java/com/webank/wedpr/crypto/CryptoResult.java

@@ -0,0 +1,29 @@
+// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+
+package com.webank.wedpr.crypto;
+
+import com.webank.wedpr.common.WedprException;
+import com.webank.wedpr.common.WedprResult;
+
+/**
+ * Result class used by Crypto client.
+ *
+ * <p>This is an easy way to return multiple data from a single JNI interface.
+ */
+public class CryptoResult extends WedprResult {
+  public String signature;
+  public String publicKey;
+  public String privateKey;
+  public String hash;
+  public boolean booleanResult;
+  public String encryptedData;
+  public String decryptedData;
+
+  /** Expects no error occurred, otherwise throws an Exception. */
+  public CryptoResult expectNoError() throws WedprException {
+    if (hasError()) {
+      throw new WedprException(wedprErrorMessage);
+    }
+    return this;
+  }
+}

solution/crypto/src/main/java/com/webank/wedpr/crypto/DemoMain.java

@@ -0,0 +1,57 @@
+// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+
+package com.webank.wedpr.crypto;
+
+import com.webank.wedpr.common.WedprException;
+import java.util.Base64;
+
+/**
+ * Minimalist demo of WeDPR Crypto.
+ *
+ * <p>For a better interactive demo, please try our Rust version at
+ * https://github.com/WeBankBlockchain/WeDPR-Lab-Core
+ */
+public class DemoMain {
+
+  public static void main(String[] args) throws Exception {
+    CryptoClient cryptoClient = new CryptoClient();
+    runCryptoDemo(cryptoClient);
+  }
+
+  private static void runCryptoDemo(CryptoClient cryptoClient) throws WedprException {
+    System.out.println("\n*******\nWeDPR CRYPTO RUN\n*******");
+    System.out.println("Generate EC keyPair\n");
+
+    CryptoResult cryptoResult = cryptoClient.secp256k1GenKeyPair();
+    String publicKey = cryptoResult.publicKey;
+    String privateKey = cryptoResult.privateKey;
+    System.out.println("public key = " + publicKey);
+    System.out.println("private key = " + privateKey);
+
+    String message = Base64.getEncoder().encodeToString("WeDPR Crypto Demo".getBytes());
+    System.out.println("Hash message = " + message + " with keccak256" + "\n");
+    String messageHash = cryptoClient.keccak256Hash(message).hash;
+    System.out.println("messageHash = " + messageHash);
+
+    System.out.println(
+        "Sign data with message hash = " + messageHash + " by EC keyPair private key" + "\n");
+
+    String signature = cryptoClient.secp256k1Sign(privateKey, messageHash).signature;
+
+    System.out.println("Signature = " + signature);
+
+    System.out.println(
+        "Verify Signature with message hash = " + messageHash + " by EC keyPair public key" + "\n");
+    boolean result = cryptoClient.secp256k1Verify(publicKey, messageHash, signature).booleanResult;
+    System.out.println("result = " + result);
+
+    System.out.println(
+        "Encrypt data with messageHash = " + messageHash + " by EC keyPair public key" + "\n");
+    String cipherData = cryptoClient.secp256k1EciesEncrypt(publicKey, messageHash).encryptedData;
+    System.out.println("cipherData = " + cipherData);
+
+    System.out.println("Decrypt data by EC keyPair private key" + "\n");
+    String plainData = cryptoClient.secp256k1EciesDecrypt(privateKey, cipherData).decryptedData;
+    System.out.println("plainData = " + plainData);
+  }
+}

solution/crypto/src/main/java/com/webank/wedpr/crypto/NativeInterface.java

@@ -0,0 +1,45 @@
+// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+
+package com.webank.wedpr.crypto;
+
+import com.webank.wedpr.common.NativeUtils;
+import java.io.IOException;
+
+/** Native interface for VCL client. */
+public class NativeInterface {
+
+  static {
+    try {
+      // Load the dynamic library of VCL on different operating systems.
+      String osName = System.getProperty("os.name").toLowerCase();
+      String libPathInJar;
+      if (osName.contains("windows")) {
+        libPathInJar = "/WeDPR_dynamic_lib/ffi_java_crypto.dll";
+      } else if (osName.contains("linux")) {
+        libPathInJar = "/WeDPR_dynamic_lib/libffi_java_crypto.so";
+      } else if (osName.contains("mac")) {
+        libPathInJar = "/WeDPR_dynamic_lib/libffi_java_crypto.dylib";
+      } else {
+        throw new IOException(String.format("Operating system %s is not supported.", osName));
+      }
+      NativeUtils.loadLibraryFromJar(libPathInJar);
+    } catch (IOException e) {
+      // TODO: Provide more instructions on resolving dynamic library loading errors.
+      throw new RuntimeException(e);
+    }
+  }
+
+  // JNI function section.
+  public static native CryptoResult secp256k1EciesEncrypt(String pubKey, String plaintext);
+
+  public static native CryptoResult secp256k1EciesDecrypt(String priKey, String ciphertext);
+
+  public static native CryptoResult secp256k1GenKeyPair();
+
+  public static native CryptoResult keccak256Hash(String message);
+
+  public static native CryptoResult secp256k1Sign(String priKey, String messageHash);
+
+  public static native CryptoResult secp256k1Verify(
+      String pubKey, String messageHash, String signature);
+}

solution/crypto/src/main/resources/WeDPR_dynamic_lib/.blank_file

@@ -0,0 +1 @@
+Have a good day :D