restructure + usage of mpcutils4j

Author: pvriel

README.md

@@ -2,7 +2,7 @@
 A Java library for the OPRF functions I programmed during my PhD.
 
 [![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-[![Coverage](https://badgen.net/badge/coverage/82%25/green)](https://badgen.net/badge/coverage/82%25/green)
+[![Coverage](https://badgen.net/badge/coverage/95%25/green)](https://badgen.net/badge/coverage/95%25/green)
 
 ***
 

build.gradle

@@ -4,12 +4,20 @@ plugins {
 }
 
 group 'com.github.pvriel'
-version '1.0.1'
+version '1.1.0'
 
 repositories {
     mavenLocal()
     mavenCentral()
 
+    maven {
+        url = uri("https://maven.pkg.github.com/pvriel/mpcutils4j")
+        credentials {
+            username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
+            password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
+        }
+    }
+
     maven {
         url = uri("https://maven.pkg.github.com/pvriel/oblivioustransfer4j")
         credentials {
@@ -28,11 +36,12 @@ repositories {
 }
 
 dependencies {
+    implementation 'com.github.pvriel:mpcutils4j:1.+'
     implementation 'com.github.pvriel:oblivioustransfer4j:1.+'
     implementation 'org.apache.commons:commons-lang3:3.+'
 
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.+'
-    testImplementation 'com.github.pvriel:prf4j:1.1.0'
+    testImplementation 'com.github.pvriel:prf4j:1.+'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.+'
 }
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -55,7 +55,7 @@
 #       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
+#       https://github.com/gradle/gradle/blob/HEAD/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/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # 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"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac

gradlew

@@ -26,6 +26,7 @@ if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
 if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 

gradlew.bat

@@ -1,7 +1,7 @@
 package com.github.pvriel.oprf4j.nroprf.semihonest.KISS17;
 
+import com.github.pvriel.mpcutils4j.stream.StreamUtils;
 import com.github.pvriel.oblivioustransfer4j.precomputed.PrecomputedObliviousTransferReceiver;
-import com.github.pvriel.oblivioustransfer4j.utils.StreamUtils;
 import com.github.pvriel.oprf4j.nroprf.NROPRFEvaluator;
 import com.github.pvriel.oprf4j.precomputed.PrecomputedOPRFEvaluator;
 import org.apache.commons.lang3.tuple.Triple;
@@ -10,12 +10,13 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.math.BigInteger;
+import java.util.stream.IntStream;
 
 /**
  * Class representing the <a href="https://www.semanticscholar.org/paper/Private-Set-Intersection-for-Unequal-Set-Sizes-with-Kiss-Liu/ef148d510ce6fd445b73584a238f6244660efbe6">KISS17</a> variant of the
  * {@link NROPRFEvaluator} protocol.
  */
-public class KISS17NROPRFEvaluator extends NROPRFEvaluator implements PrecomputedOPRFEvaluator<Triple<boolean[], BigInteger, Object>> {
+public class KISS17NROPRFEvaluator extends NROPRFEvaluator implements PrecomputedOPRFEvaluator<Triple<boolean[], BigInteger[], Object>> {
 
     private final PrecomputedObliviousTransferReceiver<Object> precomputedObliviousTransferReceiver;
     private final int bitLengthRandomValues;
@@ -31,6 +32,8 @@ public class KISS17NROPRFEvaluator extends NROPRFEvaluator implements Precompute
      *          The (not-null) prime number that is used for the group (the result of applying the PRF is always part of F_{p}).
      * @param   q
      *          The (not-null) prime number, for which q | p - 1 holds. This prime number is used to apply mod operations with the exponents.
+     * @param  <T>
+     *          The type of the elements that are used in the oblivious transfer.
      */
     public <T> KISS17NROPRFEvaluator(int bitLengthRandomValues, PrecomputedObliviousTransferReceiver<T> precomputedObliviousTransferReceiver,
                                  BigInteger p, BigInteger q) {
@@ -41,25 +44,31 @@ public <T> KISS17NROPRFEvaluator(int bitLengthRandomValues, PrecomputedOblivious
     }
 
     @Override
-    public Triple<boolean[], BigInteger, Object> executeOfflinePhase(BigInteger element, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
-        boolean[] choices = new boolean[bitLength];
-        for (int i = 0; i < bitLength; i ++) choices[i] = element.testBit(i);
+    public Triple<boolean[], BigInteger[], Object> executeOfflinePhase(BigInteger[] elements, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+        boolean[] choices = new boolean[elements.length * bitLength];
+        for (int i = 0; i < elements.length; i ++) for (int j = 0; j < bitLength; j ++) choices[i * bitLength + j] = elements[i].testBit(j);
 
-        BigInteger g_modded = StreamUtils.readBigIntegerFromInputStream(inputStream);
+        BigInteger[] g_modded = new BigInteger[elements.length];
+        for (int i = 0; i < g_modded.length; i ++) g_modded[i] = StreamUtils.readBigIntegerFromInputStream(inputStream);
         var resultOfflinePhaseOTs =  precomputedObliviousTransferReceiver.executeOfflinePhase(choices, bitLengthRandomValues, inputStream, outputStream);
         return Triple.of(choices, g_modded, resultOfflinePhaseOTs);
     }
 
     @Override
-    public BigInteger executeOnlinePhase(Triple<boolean[], BigInteger, Object> resultOfflinePhase, BigInteger element, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+    public BigInteger[] executeOnlinePhase(Triple<boolean[], BigInteger[], Object> resultOfflinePhase, BigInteger[] elements, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
         boolean[] choices = resultOfflinePhase.getLeft();
-        BigInteger g_modded = resultOfflinePhase.getMiddle();
+        BigInteger[] g_modded = resultOfflinePhase.getMiddle();
         Object resultOfflinePhaseOTs = resultOfflinePhase.getRight();
 
         BigInteger[] R_s = precomputedObliviousTransferReceiver.executeOnlinePhase(resultOfflinePhaseOTs, choices, bitLengthRandomValues, inputStream, outputStream);
 
-        BigInteger exponent = BigInteger.ONE;
-        for (BigInteger r : R_s) exponent = exponent.multiply(r).mod(getQ());
-        return g_modded.modPow(exponent, getP());
+        BigInteger[] result = new BigInteger[elements.length];
+        IntStream.range(0, elements.length).parallel().forEach(i -> {
+            BigInteger g_modded_i = g_modded[i];
+            BigInteger exponent = BigInteger.ONE;
+            for (int j = 0; j < bitLength; j ++) exponent = exponent.multiply(R_s[i * bitLength + j]).mod(getQ());
+            result[i] = g_modded_i.modPow(exponent, getP());
+        });
+        return result;
     }
 }

src/main/java/com/github/pvriel/oprf4j/nroprf/semihonest/KISS17/KISS17NROPRFEvaluator.java

@@ -1,16 +1,17 @@
 package com.github.pvriel.oprf4j.nroprf.semihonest.KISS17;
 
+import com.github.pvriel.mpcutils4j.math.MultiplicativeGroup;
+import com.github.pvriel.mpcutils4j.stream.StreamUtils;
 import com.github.pvriel.oblivioustransfer4j.precomputed.PrecomputedObliviousTransferSender;
-import com.github.pvriel.oblivioustransfer4j.utils.StreamUtils;
 import com.github.pvriel.oprf4j.nroprf.NROPRFProvider;
 import com.github.pvriel.oprf4j.precomputed.PrecomputedOPRFProvider;
-import com.github.pvriel.oprf4j.utils.MultiplicativeGroup;
 import org.apache.commons.lang3.tuple.Pair;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.math.BigInteger;
+import java.util.stream.IntStream;
 
 /**
  * Class representing the <a href="https://www.semanticscholar.org/paper/Private-Set-Intersection-for-Unequal-Set-Sizes-with-Kiss-Liu/ef148d510ce6fd445b73584a238f6244660efbe6">KISS17</a> variant of the
@@ -38,6 +39,8 @@ public class KISS17NROPRFProvider extends NROPRFProvider implements PrecomputedO
      *          The (not-null) element to perform the modulus operation with for the exponents.
      * @param   g
      *          The (not-null) generator of the multiplicative group.
+     * @param   <T>
+     *          The type of the elements in the {@link PrecomputedObliviousTransferSender}.
      */
     public <T> KISS17NROPRFProvider(int bitLengthRandomValues, PrecomputedObliviousTransferSender<T> precomputedObliviousTransferSender,
                                    BigInteger[] a0, BigInteger[] a1, BigInteger p, BigInteger q, BigInteger g) {
@@ -48,28 +51,33 @@ public <T> KISS17NROPRFProvider(int bitLengthRandomValues, PrecomputedObliviousT
     }
 
     @Override
-    public Pair<Object, BigInteger[][]> executeOfflinePhase(int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+    public Pair<Object, BigInteger[][]> executeOfflinePhase(int amountOfElements, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
         MultiplicativeGroup multiplicativeGroupQ = new MultiplicativeGroup(getQ());
-        BigInteger[] r = multiplicativeGroupQ.getRandomElements(bitLength);
+        BigInteger[] r = multiplicativeGroupQ.getRandomElements(amountOfElements * bitLength);
 
-        BigInteger[][] R = new BigInteger[bitLength][2];
-        BigInteger r_inv = BigInteger.ONE;
-        for (int i = 0; i < R.length; i ++) {
-            r_inv = r_inv.multiply(r[i]).mod(getQ());
-            R[i][0] = r[i].multiply(getA0()[i]).mod(getQ());
-            R[i][1] = r[i].multiply(getA1()[i]).mod(getQ());
-        }
-        r_inv = r_inv.modInverse(getQ());
-        BigInteger g_modded = getG().modPow(r_inv, getP());
-        StreamUtils.writeBigIntegerToOutputStream(g_modded, outputStream);
+        BigInteger[][] R = new BigInteger[amountOfElements * bitLength][2];
+        BigInteger[] g_modded = new BigInteger[amountOfElements];
+        IntStream.range(0, amountOfElements).parallel().forEach(i -> {
+            BigInteger r_inv_i = BigInteger.ONE;
+            for (int j = 0; j < bitLength; j ++) {
+                r_inv_i = r_inv_i.multiply(r[i * bitLength + j]).mod(getQ());
+                R[i * bitLength + j][0] = r[i * bitLength + j].multiply(getA0()[j]).mod(getQ());
+                R[i * bitLength + j][1] = r[i * bitLength + j].multiply(getA1()[j]).mod(getQ());
+            }
+            r_inv_i = r_inv_i.modInverse(getQ());
+            g_modded[i] = getG().modPow(r_inv_i, getP());
+        });
+
+        for (BigInteger bigInteger : g_modded) StreamUtils.writeBigIntegerToOutputStream(bigInteger, outputStream);
+        outputStream.flush();
 
         Object resultOfflinePhaseOTs = precomputedObliviousTransferSender.executeOfflinePhase(R, bitLengthRandomValues, inputStream, outputStream);
 
         return Pair.of(resultOfflinePhaseOTs, R);
     }
 
     @Override
-    public void executeOnlinePhase(Pair<Object, BigInteger[][]> resultOfflinePhase, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+    public void executeOnlinePhase(Pair<Object, BigInteger[][]> resultOfflinePhase, int amountOfElements, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
         var resultOfflinePhaseOTs = resultOfflinePhase.getLeft();
         var R = resultOfflinePhase.getRight();
 

src/main/java/com/github/pvriel/oprf4j/nroprf/semihonest/KISS17/KISS17NROPRFProvider.java

@@ -11,21 +11,41 @@
  */
 public interface OPRFEvaluator {
 
+    /**
+     * Method to execute the OPRF functionality.
+     * @param   elements
+     *          The (not-null) elements to apply the PRF to.
+     * @param   bitLength
+     *          The bit length of the elements. Should be strictly positive, and should match the value used by the {@link OPRFProvider} node.
+     * @param   inputStream
+     *          The (not-null) input stream to receive data from the {@link OPRFProvider} node.
+     *          <br>This stream will not be closed after this process.
+     * @param   outputStream
+     *          The (not-null) output stream to send data to the {@link OPRFProvider} node.
+     *          <br>This stream will not be closed after this process.
+     * @return  The (not-null) OPRF (element) results.
+     * @throws  IOException
+     *          If an IO-related problem occurred during the execution of this process.
+     */
+    BigInteger[] evaluate(BigInteger[] elements, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException;
+
     /**
      * Method to execute the OPRF functionality.
      * @param   element
      *          The (not-null) element to apply the PRF to.
      * @param   bitLength
-     *          The bitlength of the element. Should be strictly positive, and should match the value used by the {@link OPRFProvider} node.
+     *          The bit length of the element. Should be strictly positive, and should match the value used by the {@link OPRFProvider} node.
      * @param   inputStream
      *          The (not-null) input stream to receive data from the {@link OPRFProvider} node.
      *          <br>This stream will not be closed after this process.
      * @param   outputStream
      *          The (not-null) output stream to send data to the {@link OPRFProvider} node.
      *          <br>This stream will not be closed after this process.
-     * @return  The (not-null) OPRF(element) result.
+     * @return  The (not-null) OPRF (element) result.
      * @throws  IOException
      *          If an IO-related problem occurred during the execution of this process.
      */
-    BigInteger evaluate(BigInteger element, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException;
+    default BigInteger evaluate(BigInteger element, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+        return evaluate(new BigInteger[] {element}, bitLength, inputStream, outputStream)[0];
+    }
 }

src/main/java/com/github/pvriel/oprf4j/oprf/OPRFEvaluator.java

@@ -12,8 +12,11 @@ public interface OPRFProvider {
 
     /**
      * Method to provide the OPRF functionality.
+     * @param   amountOfValues
+     *          The amount of values to apply the PRF to (from the evaluator side).
+     *          This value should match the amount of values provided by the {@link OPRFEvaluator} node.
      * @param   bitLength
-     *          The bit length of the message to apply the PRF to. Should be strictly positive, and should match the value used by the {@link OPRFEvaluator} node.
+     *          The bit length of the messages to apply the PRF to. Should be strictly positive, and should match the value used by the {@link OPRFEvaluator} node.
      * @param   inputStream
      *          The (not-null) input stream to receive data from the {@link OPRFEvaluator} node.
      *          <br>The stream will not be closed after this process.
@@ -23,5 +26,22 @@ public interface OPRFProvider {
      * @throws  IOException
      *          If an IO-related problem occurred during the execution of this process.
      */
-    void execute(int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException;
+    void execute(int amountOfValues, int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException;
+
+    /**
+     * Method to provide the OPRF functionality.
+     * @param   bitLength
+     *          The bit length of the messages to apply the PRF to. Should be strictly positive, and should match the value used by the {@link OPRFEvaluator} node.
+     * @param   inputStream
+     *          The (not-null) input stream to receive data from the {@link OPRFEvaluator} node.
+     *          <br>The stream will not be closed after this process.
+     * @param   outputStream
+     *          The (not-null) output stream to send data to the {@link OPRFEvaluator} node.
+     *          <br>The stream will not be closed after this process.
+     * @throws  IOException
+     *          If an IO-related problem occurred during the execution of this process.
+     */
+    default void execute(int bitLength, InputStream inputStream, OutputStream outputStream) throws IOException {
+        execute(1, bitLength, inputStream, outputStream);
+    }
 }