Merge develop into main for release of v2.0.0

.github/workflows/android.yaml

@@ -0,0 +1,31 @@
+name: Android CI
+
+on:
+  push:
+    branches-ignore:
+      - main
+      - 'release/**'
+  # Nightly builds to ensure dependencies don't break anything
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Build with Gradle
+        run: ./gradlew :build
+  android:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run tests on emulator
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 28
+          script: ./gradlew android-test:connectedAndroidTest -Pandroid.useAndroidX=true --info

.github/workflows/ci.yaml → .github/workflows/dev-ci.yaml

@@ -1,6 +1,13 @@
-name: Java CI
+name: Development Java CI
 
-on: push
+on:
+  push:
+    branches-ignore:
+      - main
+      - 'release/**'
+  # Nightly builds to ensure dependencies don't break anything
+  schedule:
+    - cron: '0 0 * * *'
 
 jobs:
   build:
@@ -12,4 +19,5 @@ jobs:
         with:
           java-version: 1.8
       - name: Build with Gradle
-        run: ./gradlew build -PcheckoutIfCloned=true
+        run: ./gradlew :build
+

.github/workflows/main-ci.yaml

@@ -0,0 +1,28 @@
+name: Main Java CI
+
+on:
+  push:
+    branches:
+      - main
+      - 'release/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Build with Gradle
+        run: ./gradlew :build -Prelease
+  android:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Run tests on emulator
+        uses: reactivecircus/android-emulator-runner@v2
+        with:
+          api-level: 28
+          script: ./gradlew android-test:connectedAndroidTest -Prelease -Pandroid.useAndroidX=true --info

.github/workflows/scheduled-main-java-ci.yaml

@@ -0,0 +1,20 @@
+name: Scheduled Main Java CI
+
+on:
+  # Nightly builds to ensure dependencies don't break anything
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: main # need to specify branch else it will check out develop
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Build with Gradle
+        run: ./gradlew :build -Prelease

.github/workflows/pub.yaml → .github/workflows/tagget_release.yaml

@@ -1,9 +1,7 @@
-name: Maven publishing
+name: Tagget release
 
 on:
   push:
-    branches:
-      - main
     tags:
       - v[1-9]+.[0-9]+.[0-9]+
 jobs:
@@ -16,16 +14,19 @@ jobs:
         with:
           java-version: 1.8
       - name: Publish to the Maven Central Repository
-        run: ./gradlew publish -PcheckoutIfCloned -Prelease
+        run: ./gradlew :publish -Prelease
         env:
           OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
           OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.GPG_PRIVATE_KEY }}
           ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.GPG_PASSPHRASE }}
-      - uses: "marvinpinto/action-automatic-releases@latest"
+      - name: Github release
+        uses: "marvinpinto/action-automatic-releases@latest"
         with:
           repo_token: "${{ secrets.GITHUB_TOKEN }}"
           prerelease: false
+          draft: false
           files: |
             LICENSE
             build/libs/*.jar
+        id: "automatic_releases"

.gitignore

@@ -1,6 +1,8 @@
 build/**
+android-test/build/**
 .gradle/**
 out/**
 .idea/**
 .composite-enable
 gradle.properties
+local.properties

CHANGELOG.md

@@ -3,3 +3,35 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Additional operator overload methods added to `ExponentExpr`
+- `BasicBilinearGroup` wrappers for the implemented bilinear groups
+- Convenience methods for the vector classes
+- `square`, `div` and `valueOf` convenience methods for `Zn` and `Zp` classes
+- PRF classes from Craco now are part of Math
+- `ByteArrayImpl`, a byte array implementation
+
+### Changed
+- Renamed "counting" group classes and package to "debug"
+- Made supersingular and Barreto-Naehrig implementation classes package-private (except those that are relevant to the user)
+- Made internal lazy group classes package-private
+- Adjusted some tests to work with the new package-private classes
+- Made representation handler classes package-private and moved the classes up a package
+- Made ring group impl classes package-private and moved inv and neg cost estimation to the `Ring` interface
+- Improved performance of finite field multiplication
+
+### Fixed
+- Fixed `decomposeIntoDigits` method of `IntegerRing`
+
+## [1.0.0] - 2021-03-01
+
+### Added
+- Initial release
+
+
+[Unreleased]: https://github.com/cryptimeleon/math/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/cryptimeleon/math/releases/tag/v1.0.0
+

DEVELOPER.md

@@ -0,0 +1,9 @@
+This Gradle project consists of two sub-projects.
+The root project is the Math library itself.
+The `android-test` sub-project is only used to run the library's tests on Android.
+For that purpose it contains an Android-specific build file.
+
+Since there are multiple sub-projects, you will need to prefix Gradle commands with a colon (`:`) if you want them to run only for the Math library and not the Android sub-project.
+For example, instead of `./gradlew build` use `./gradlew :build` to build the Math library.
+The former will fail since the android sub-project is not configured to be actually buildable.
+See [here](https://docs.gradle.org/current/userguide/intro_multi_project_builds.html) for more information on how multi-project builds work.

README.md

@@ -1,9 +1,12 @@
-![Build Status](https://github.com/cryptimeleon/math/workflows/Java%20CI/badge.svg)
+![Build Status](https://github.com/cryptimeleon/math/workflows/Development%20Java%20CI/badge.svg)
+![Build Status](https://github.com/cryptimeleon/math/workflows/Main%20Java%20CI/badge.svg)
+![Build Status](https://github.com/cryptimeleon/math/workflows/Scheduled%20Main%20Java%20CI/badge.svg)
+![Build Status](https://github.com/cryptimeleon/math/workflows/Android%20CI/badge.svg)
 ## Math
 
 The Cryptimeleon Math library provides the mathematical foundation for the other Cryptimeleon libraries.
-It provides basics such as mathematical groups, rings and fields, e.g. Zn, as well as implementations of cryptographic pairings.
-Furthermore, it provides serialization support for the implemented structures.
+It implements basics such as mathematical groups, rings and fields, e.g. Zn, as well as implementations of cryptographic pairings.
+Furthermore, it offers serialization support for the implemented structures.
 
 ## Security Disclaimer
 **WARNING: This library is meant to be used for prototyping and as a research tool *only*. It has not been sufficiently vetted for use in security-critical production environments. All implementations are to be considered experimental.**

android-test/build.gradle

@@ -0,0 +1,97 @@
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.2.1'
+        classpath("de.mannodermaus.gradle.plugins:android-junit5:1.7.1.1")
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: "de.mannodermaus.android-junit5"
+
+android {
+    compileSdkVersion 30
+    defaultConfig {
+        minSdkVersion 28
+        targetSdkVersion 30
+
+        testInstrumentationRunner 'androidx.test.runner.AndroidJUnitRunner'
+        // JUnit 5 support for instrumentation tests
+        testInstrumentationRunnerArgument "runnerBuilder", "de.mannodermaus.junit5.AndroidJUnit5Builder"
+    }
+
+    // make the android-test subproject just reuse the math stuff
+    sourceSets {
+        main {
+            java.srcDirs = ["../src/main/java"]
+        }
+
+        // unit tests. Run via test task
+        test {
+            java.srcDirs = ["../src/test/java"]
+        }
+
+        androidTest {
+            java.srcDirs = ["../src/test/java"]
+        }
+    }
+
+    compileOptions {
+        setSourceCompatibility(JavaVersion.VERSION_1_8)
+        setTargetCompatibility(JavaVersion.VERSION_1_8)
+    }
+
+    testOptions {
+        unitTests {
+            all {
+                useJUnitPlatform()
+                maxParallelForks 4
+                //we want display the following test events
+                testLogging {
+                    events "PASSED", "STARTED", "FAILED", "SKIPPED"
+                }
+                afterSuite { desc, result ->
+                    if (!desc.parent) { // will match the outermost suite
+                        def output = "Results: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} successes, ${result.failedTestCount} failures, ${result.skippedTestCount} skipped)"
+                        def startItem = '|  ', endItem = '  |'
+                        def repeatLength = startItem.length() + output.length() + endItem.length()
+                        println('\n' + ('-' * repeatLength) + '\n' + startItem + output + endItem + '\n' + ('-' * repeatLength))
+                    }
+                }
+            }
+        }
+    }
+}
+
+repositories {
+    mavenCentral()
+    google()
+}
+
+dependencies {
+    implementation group: 'com.googlecode.json-simple', name: 'json-simple', version:'1.1'
+    implementation group: 'org.reflections', name: 'reflections', version:'0.9.10'
+
+    // (Required) Writing and executing Unit Tests on the JUnit Platform
+    testImplementation "org.junit.jupiter:junit-jupiter-api:5.7.1"
+    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.7.1"
+
+    // (Optional) If you need "Parameterized Tests"
+    testImplementation "org.junit.jupiter:junit-jupiter-params:5.7.1"
+
+    // (Optional) If you also have JUnit 4-based tests
+    testImplementation "junit:junit:4.13"
+    testRuntimeOnly "org.junit.vintage:junit-vintage-engine:5.7.1"
+
+    // Instrumentation test stuff
+    androidTestImplementation "androidx.test:runner:1.3.0"
+    androidTestImplementation "org.junit.jupiter:junit-jupiter-api:5.7.1"
+    androidTestImplementation "org.junit.jupiter:junit-jupiter-params:5.7.1"
+
+    androidTestImplementation "de.mannodermaus.junit5:android-test-core:1.2.2"
+    androidTestRuntimeOnly "de.mannodermaus.junit5:android-test-runner:1.2.2"
+}

android-test/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="org.cryptimeleon.math">
+</manifest>

build.gradle

@@ -7,21 +7,17 @@ plugins {
 group = 'org.cryptimeleon'
 archivesBaseName = project.name
 boolean isRelease = project.hasProperty("release")
-version = '1.0.0'  + (isRelease ? "" : "-SNAPSHOT")
-
+version = '2.0.0'  + (isRelease ? "" : "-SNAPSHOT")
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 tasks.withType(JavaCompile) {
 	options.encoding = 'UTF-8'
 }
 
-
-
 repositories {
     mavenLocal()
     mavenCentral()
-    jcenter()
 }
 
 dependencies {
@@ -44,7 +40,6 @@ dependencies {
     )
 }
 
-
 test {
     useJUnitPlatform()
     maxParallelForks 4

settings.gradle

@@ -1 +1,3 @@
 rootProject.name = 'math'
+
+include 'android-test'

src/main/java/org/cryptimeleon/math/expressions/bool/ExponentEqualityExpr.java

@@ -27,7 +27,7 @@ public ExponentEqualityExpr(ExponentExpr lhs, ExponentExpr rhs) {
     }
 
     @Override
-    public BooleanExpression substitute(Substitution substitutions) {
+    public ExponentEqualityExpr substitute(Substitution substitutions) {
         return lhs.substitute(substitutions).isEqualTo(rhs.substitute(substitutions));
     }
 

src/main/java/org/cryptimeleon/math/expressions/bool/GroupEqualityExpr.java

@@ -46,7 +46,7 @@ public Group getGroup() {
     }
 
     @Override
-    public BooleanExpression substitute(Substitution substitutions) {
+    public GroupEqualityExpr substitute(Substitution substitutions) {
         return lhs.substitute(substitutions).isEqualTo(rhs.substitute(substitutions));
     }