diff --git a/bindings/kotlin/README.md b/bindings/kotlin/README.md new file mode 100644 index 000000000..5dbac22bf --- /dev/null +++ b/bindings/kotlin/README.md @@ -0,0 +1,24 @@ +# Matrix rust components kotlin + +This project and build scripts demonstrate how to create an aar and how to import it in your android projects. + +## Prerequisites + +* the Rust toolchain +* UniFFI - `cargo install uniffi_bindgen` +* cargo-ndk < 2.12.0 `cargo install cargo-ndk --version 2.11.0` +* android targets (e.g. `rustup target add \ + aarch64-linux-android \ + armv7-linux-androideabi \ + x86_64-linux-android \ + i686-linux-android`) + +## Building the SDK + +To build the full sdk and get an aar you can call : +`./bindings/kotlin/scripts/build_sdk.sh /matrix-rust_sdk/bindings/kotlin/sample/libs` +where the parameter is the path for the aar to go + +## License + +[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) diff --git a/bindings/kotlin/SECURITY.md b/bindings/kotlin/SECURITY.md new file mode 100644 index 000000000..3126b47a0 --- /dev/null +++ b/bindings/kotlin/SECURITY.md @@ -0,0 +1,5 @@ +# Reporting a Vulnerability + +**If you've found a security vulnerability, please report it to security@matrix.org** + +For more information on our security disclosure policy, visit https://www.matrix.org/security-disclosure-policy/ diff --git a/bindings/kotlin/build.gradle b/bindings/kotlin/build.gradle new file mode 100644 index 000000000..4924a37c7 --- /dev/null +++ b/bindings/kotlin/build.gradle @@ -0,0 +1,23 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. + +apply plugin: 'io.github.gradle-nexus.publish-plugin' +apply from: "${rootDir}/scripts/publish-root.gradle" + +buildscript { + repositories { + maven { url "https://plugins.gradle.org/m2/" } + google() + mavenCentral() + } + + dependencies { + classpath BuildPlugins.android + classpath BuildPlugins.kotlin + classpath BuildPlugins.nexusPublish + } +} + + +task clean(type: Delete) { + delete rootProject.buildDir +} \ No newline at end of file diff --git a/bindings/kotlin/buildSrc/build.gradle.kts b/bindings/kotlin/buildSrc/build.gradle.kts new file mode 100644 index 000000000..8e88a958d --- /dev/null +++ b/bindings/kotlin/buildSrc/build.gradle.kts @@ -0,0 +1,9 @@ +import org.gradle.kotlin.dsl.`kotlin-dsl` + +plugins { + `kotlin-dsl` +} + +repositories { + mavenCentral() +} \ No newline at end of file diff --git a/bindings/kotlin/buildSrc/src/main/java/ConfigurationData.kt b/bindings/kotlin/buildSrc/src/main/java/ConfigurationData.kt new file mode 100644 index 000000000..e32455732 --- /dev/null +++ b/bindings/kotlin/buildSrc/src/main/java/ConfigurationData.kt @@ -0,0 +1,11 @@ +object ConfigurationData { + const val compileSdk = 31 + const val targetSdk = 31 + const val minSdk = 21 + const val majorVersion = 0 + const val minorVersion = 2 + const val patchVersion = 0 + const val versionName = "$majorVersion.$minorVersion.$patchVersion" + const val snapshotVersionName = "$majorVersion.$minorVersion.${patchVersion + 1}-SNAPSHOT" + const val publishGroupId = "org.matrix.rustcomponents" +} \ No newline at end of file diff --git a/bindings/kotlin/buildSrc/src/main/java/Dependencies.kt b/bindings/kotlin/buildSrc/src/main/java/Dependencies.kt new file mode 100644 index 000000000..f5f6e394e --- /dev/null +++ b/bindings/kotlin/buildSrc/src/main/java/Dependencies.kt @@ -0,0 +1,22 @@ +internal object Versions { + const val androidGradlePlugin = "7.1.2" + const val kotlin = "1.6.10" + const val jUnit = "4.12" + const val nexusPublishGradlePlugin = "1.1.0" + const val jna = "5.10.0" +} + +internal object BuildPlugins { + const val android = "com.android.tools.build:gradle:${Versions.androidGradlePlugin}" + const val kotlin = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.kotlin}" + const val nexusPublish = "io.github.gradle-nexus:publish-plugin:${Versions.nexusPublishGradlePlugin}" +} + +/** + * To define dependencies + */ +internal object Dependencies { + const val kotlin = "org.jetbrains.kotlin:kotlin-stdlib-jdk7:${Versions.kotlin}" + const val junit = "junit:junit:${Versions.jUnit}" + const val jna = "net.java.dev.jna:jna:${Versions.jna}@aar" +} \ No newline at end of file diff --git a/bindings/kotlin/crypto/crypto-android/.gitignore b/bindings/kotlin/crypto/crypto-android/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/bindings/kotlin/crypto/crypto-android/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/bindings/kotlin/crypto/crypto-android/build.gradle b/bindings/kotlin/crypto/crypto-android/build.gradle new file mode 100644 index 000000000..543cd2a60 --- /dev/null +++ b/bindings/kotlin/crypto/crypto-android/build.gradle @@ -0,0 +1,51 @@ +plugins { + id 'com.android.library' + id 'org.jetbrains.kotlin.android' +} + +ext { + PUBLISH_GROUP_ID = ConfigurationData.publishGroupId + PUBLISH_ARTIFACT_ID = 'crypto-android' + PUBLISH_VERSION = rootVersionName + PUBLISH_DESCRIPTION = 'Android Bindings to the Matrix Rust Crypto SDK' +} + +apply from: "${rootDir}/scripts/publish-module.gradle" + +android { + + compileSdk ConfigurationData.compileSdk + + defaultConfig { + minSdk ConfigurationData.minSdk + targetSdk ConfigurationData.targetSdk + versionName ConfigurationData.versionName + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + consumerProguardFiles "consumer-rules.pro" + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + kotlinOptions { + jvmTarget = '1.8' + } +} + +android.libraryVariants.all { variant -> + def sourceSet = variant.sourceSets.find { it.name == variant.name } + sourceSet.java.srcDir new File(buildDir, "generated/source/${variant.name}") +} + +dependencies { + implementation Dependencies.jna + testImplementation Dependencies.junit +} \ No newline at end of file diff --git a/bindings/kotlin/crypto/crypto-android/consumer-rules.pro b/bindings/kotlin/crypto/crypto-android/consumer-rules.pro new file mode 100644 index 000000000..e69de29bb diff --git a/bindings/kotlin/crypto/crypto-android/proguard-rules.pro b/bindings/kotlin/crypto/crypto-android/proguard-rules.pro new file mode 100644 index 000000000..481bb4348 --- /dev/null +++ b/bindings/kotlin/crypto/crypto-android/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile \ No newline at end of file diff --git a/bindings/kotlin/crypto/crypto-android/src/main/AndroidManifest.xml b/bindings/kotlin/crypto/crypto-android/src/main/AndroidManifest.xml new file mode 100644 index 000000000..730df2c4c --- /dev/null +++ b/bindings/kotlin/crypto/crypto-android/src/main/AndroidManifest.xml @@ -0,0 +1,4 @@ + + + + diff --git a/bindings/kotlin/crypto/crypto-jvm/.gitignore b/bindings/kotlin/crypto/crypto-jvm/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/bindings/kotlin/crypto/crypto-jvm/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/bindings/kotlin/crypto/crypto-jvm/build.gradle b/bindings/kotlin/crypto/crypto-jvm/build.gradle new file mode 100644 index 000000000..ce669345b --- /dev/null +++ b/bindings/kotlin/crypto/crypto-jvm/build.gradle @@ -0,0 +1,13 @@ +plugins { + id 'java-library' + id 'org.jetbrains.kotlin.jvm' +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_7 + targetCompatibility = JavaVersion.VERSION_1_7 +} + +dependencies { + implementation 'net.java.dev.jna:jna:5.10.0@aar' +} \ No newline at end of file diff --git a/bindings/kotlin/gradle.properties b/bindings/kotlin/gradle.properties new file mode 100644 index 000000000..d2c86c8ce --- /dev/null +++ b/bindings/kotlin/gradle.properties @@ -0,0 +1,25 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app"s APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Automatically convert third-party libraries to use AndroidX +android.enableJetifier=true +# Kotlin code style for this project: "official" or "obsolete": +kotlin.code.style=official +# Enables namespacing of each library's R class so that its R class includes only the +# resources declared in the library itself and none from the library's dependencies, +# thereby reducing the size of the R class for that library +android.nonTransitiveRClass=true diff --git a/bindings/kotlin/gradle/wrapper/gradle-wrapper.jar b/bindings/kotlin/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..e708b1c02 Binary files /dev/null and b/bindings/kotlin/gradle/wrapper/gradle-wrapper.jar differ diff --git a/bindings/kotlin/gradle/wrapper/gradle-wrapper.properties b/bindings/kotlin/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..a10cc8b8d --- /dev/null +++ b/bindings/kotlin/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Mon Feb 28 18:48:31 CET 2022 +distributionBase=GRADLE_USER_HOME +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/bindings/kotlin/gradlew b/bindings/kotlin/gradlew new file mode 100755 index 000000000..4f906e0c8 --- /dev/null +++ b/bindings/kotlin/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or 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 UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$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 "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/bindings/kotlin/gradlew.bat b/bindings/kotlin/gradlew.bat new file mode 100644 index 000000000..ac1b06f93 --- /dev/null +++ b/bindings/kotlin/gradlew.bat @@ -0,0 +1,89 @@ +@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%" == "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%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/bindings/kotlin/scripts/build_crypto.sh b/bindings/kotlin/scripts/build_crypto.sh new file mode 100755 index 000000000..86756e848 --- /dev/null +++ b/bindings/kotlin/scripts/build_crypto.sh @@ -0,0 +1,67 @@ +#!/usr/bin/env bash +set -eEu + +cd "$(dirname "$0")" +CURRENT_DIR=$(pwd) + +# FOR DEBUG +#RELEASE_FLAG="" +#RELEASE_TYPE_DIR="debug" +#RELEASE_AAR_NAME="crypto-android-debug" + +# FOR RELEASE +RELEASE_FLAG="--release" +RELEASE_TYPE_DIR="release" +RELEASE_AAR_NAME="crypto-android-release" + +SRC_ROOT=../../.. +# Path to the kotlin root project +KOTLIN_ROOT=.. + +BASE_TARGET_DIR="${SRC_ROOT}/target" +SDK_ROOT="${KOTLIN_ROOT}/crypto/crypto-android" +SDK_TARGET_DIR="${SDK_ROOT}/src/main/jniLibs" +BUILD_DIR="${SDK_ROOT}/build" +GENERATED_DIR="${BUILD_DIR}/generated/source/${RELEASE_TYPE_DIR}" +mkdir -p ${GENERATED_DIR} + +TARGET_CRATE=matrix-sdk-crypto-ffi + +AAR_DESTINATION=$1 + +# Build libs for all the different architectures + +echo -e "Building for x86_64-linux-android[1/4]" +cargo ndk --target x86_64-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p ${TARGET_CRATE} + +echo -e "Building for aarch64-linux-android[2/4]" +cargo ndk --target aarch64-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p ${TARGET_CRATE} + +echo -e "Building for armv7-linux-androideabi[3/4]" +cargo ndk --target armv7-linux-androideabi -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p ${TARGET_CRATE} + +echo -e "Building for i686-linux-android[4/4]" +cargo ndk --target i686-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p ${TARGET_CRATE} + +# Generate uniffi files +echo -e "Generate uniffi kotlin file" +uniffi-bindgen generate "${SRC_ROOT}/bindings/${TARGET_CRATE}/src/olm.udl" \ + --language kotlin \ + --config "${SRC_ROOT}/bindings/${TARGET_CRATE}/uniffi.toml" \ + --out-dir ${GENERATED_DIR} \ + --lib-file "${BASE_TARGET_DIR}/x86_64-linux-android/${RELEASE_TYPE_DIR}/libmatrix_sdk_crypto_ffi.a" + +# Create android library +cd "${KOTLIN_ROOT}" +./gradlew :crypto:crypto-android:assemble +cd "${CURRENT_DIR}" + +echo -e "Moving the generated aar file to ${AAR_DESTINATION}/matrix-rust-sdk-crypto.aar" +mv "${BUILD_DIR}/outputs/aar/${RELEASE_AAR_NAME}.aar" "${AAR_DESTINATION}/matrix-rust-sdk-crypto.aar" + +# Clean-up +echo -e "Cleaning up temporary files" + +rm -r "${BUILD_DIR}" +rm -r "${SDK_TARGET_DIR}" + diff --git a/bindings/kotlin/scripts/build_sdk.sh b/bindings/kotlin/scripts/build_sdk.sh new file mode 100755 index 000000000..30c8d92b6 --- /dev/null +++ b/bindings/kotlin/scripts/build_sdk.sh @@ -0,0 +1,64 @@ +#!/usr/bin/env bash +set -eEu + +cd "$(dirname "$0")" +CURRENT_DIR=$(pwd) + +# FOR DEBUG +#RELEASE_FLAG="" +#RELEASE_TYPE_DIR="debug" +#RELEASE_AAR_NAME="sdk-android-debug" + +# FOR RELEASE +RELEASE_FLAG="--release" +RELEASE_TYPE_DIR="release" +RELEASE_AAR_NAME="sdk-android-release" + +SRC_ROOT=../../.. +# Path to the kotlin root project +KOTLIN_ROOT=.. + +BASE_TARGET_DIR="${SRC_ROOT}/target" +SDK_ROOT="${KOTLIN_ROOT}/sdk/sdk-android" +SDK_TARGET_DIR="${SDK_ROOT}/src/main/jniLibs" +BUILD_DIR="${SDK_ROOT}/build" +GENERATED_DIR="${BUILD_DIR}/generated/source/${RELEASE_TYPE_DIR}" +mkdir -p ${GENERATED_DIR} + +AAR_DESTINATION=$1 + +# Build libs for all the different architectures + +echo -e "Building for x86_64-linux-android[1/4]" +cargo ndk --target x86_64-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p matrix-sdk-ffi + +echo -e "Building for aarch64-linux-android[2/4]" +cargo ndk --target aarch64-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p matrix-sdk-ffi + +echo -e "Building for armv7-linux-androideabi[3/4]" +cargo ndk --target armv7-linux-androideabi -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p matrix-sdk-ffi + +echo -e "Building for i686-linux-android[4/4]" +cargo ndk --target i686-linux-android -o ${SDK_TARGET_DIR}/ build "${RELEASE_FLAG}" -p matrix-sdk-ffi + +# Generate uniffi files +echo -e "Generate uniffi kotlin file" +uniffi-bindgen generate "${SRC_ROOT}/bindings/matrix-sdk-ffi/src/api.udl" \ + --language kotlin \ + --out-dir ${GENERATED_DIR} \ + --lib-file "${BASE_TARGET_DIR}/x86_64-linux-android/${RELEASE_TYPE_DIR}/libmatrix_sdk_ffi.a" + +# Create android library +cd "${KOTLIN_ROOT}" +./gradlew :sdk:sdk-android:assemble +cd "${CURRENT_DIR}" + +echo -e "Moving the generated aar file to ${AAR_DESTINATION}/matrix-rust-sdk.aar" +mv "${BUILD_DIR}/outputs/aar/${RELEASE_AAR_NAME}.aar" "${AAR_DESTINATION}/matrix-rust-sdk.aar" + +# Clean-up +echo -e "Cleaning up temporary files" + +rm -r "${BUILD_DIR}" +rm -r "${SDK_TARGET_DIR}" + diff --git a/bindings/kotlin/scripts/publish-module.gradle b/bindings/kotlin/scripts/publish-module.gradle new file mode 100644 index 000000000..0b7d3f195 --- /dev/null +++ b/bindings/kotlin/scripts/publish-module.gradle @@ -0,0 +1,77 @@ +apply plugin: 'maven-publish' +apply plugin: 'signing' + +task androidSourcesJar(type: Jar) { + archiveClassifier.set('sources') + if (project.plugins.findPlugin("com.android.library")) { + // For Android libraries + from android.sourceSets.main.java.srcDirs + from android.sourceSets.main.kotlin.srcDirs + } else { + // For pure Kotlin libraries, in case you have them + from sourceSets.main.java.srcDirs + from sourceSets.main.kotlin.srcDirs + } +} + +artifacts { + archives androidSourcesJar +} + +group = PUBLISH_GROUP_ID +version = rootVersionName + +afterEvaluate { + publishing { + publications { + release(MavenPublication) { + + groupId PUBLISH_GROUP_ID + artifactId PUBLISH_ARTIFACT_ID + version PUBLISH_VERSION + + if (project.plugins.findPlugin("com.android.library")) { + from components.release + } else { + from components.java + } + + artifact androidSourcesJar + + pom { + name = PUBLISH_ARTIFACT_ID + description = PUBLISH_DESCRIPTION + url = 'https://github.com/matrix-org/matrix-rust-components-kotlin' + licenses { + license { + name = 'The Apache Software License, Version 2.0' + url = 'https://www.apache.org/licenses/LICENSE-2.0.txt' + } + } + developers { + developer { + id = 'matrixdev' + name = 'matrixdev' + email = 'android@element.io' + } + } + + scm { + connection = 'scm:git:git://github.com/matrix-org/matrix-rust-components-kotlin.git' + developerConnection = 'scm:git:ssh://git@github.com/matrix-org/matrix-rust-components-kotlin.git' + url = 'https://github.com/matrix-org/matrix-rust-components-kotlin' + } + } + } + } + } +} + +signing { + useInMemoryPgpKeys( + rootProject.ext["signing.keyId"], + rootProject.ext["signing.key"], + rootProject.ext["signing.password"], + ) + sign publishing.publications +} \ No newline at end of file diff --git a/bindings/kotlin/scripts/publish-root.gradle b/bindings/kotlin/scripts/publish-root.gradle new file mode 100644 index 000000000..609cb9a8f --- /dev/null +++ b/bindings/kotlin/scripts/publish-root.gradle @@ -0,0 +1,43 @@ +ext["signing.keyId"] = '' +ext["signing.password"] = '' +ext["signing.key"] = '' +ext["ossrhUsername"] = '' +ext["ossrhPassword"] = '' +ext["sonatypeStagingProfileId"] = '' +ext["snapshot"] = '' + +File secretPropsFile = project.rootProject.file('local.properties') +if (secretPropsFile.exists()) { + // Read local.properties file first if it exists + Properties p = new Properties() + new FileInputStream(secretPropsFile).withCloseable { is -> p.load(is) } + p.each { name, value -> ext[name] = value } +} else { + // Use system environment variables + ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME') + ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD') + ext["sonatypeStagingProfileId"] = System.getenv('SONATYPE_STAGING_PROFILE_ID') + ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID') + ext["signing.password"] = System.getenv('SIGNING_PASSWORD') + ext["signing.key"] = System.getenv('SIGNING_KEY') + ext["snapshot"] = System.getenv('SNAPSHOT') +} + +if (snapshot.toBoolean()) { + ext["rootVersionName"] = ConfigurationData.snapshotVersionName +} else { + ext["rootVersionName"] = ConfigurationData.versionName +} + +nexusPublishing { + repositories { + sonatype { + stagingProfileId = sonatypeStagingProfileId + username = ossrhUsername + password = ossrhPassword + version = rootVersionName + nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/")) + snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")) + } + } +} \ No newline at end of file diff --git a/bindings/kotlin/sdk/sdk-android/.gitignore b/bindings/kotlin/sdk/sdk-android/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/bindings/kotlin/sdk/sdk-android/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/bindings/kotlin/sdk/sdk-android/build.gradle b/bindings/kotlin/sdk/sdk-android/build.gradle new file mode 100644 index 000000000..14cb16560 --- /dev/null +++ b/bindings/kotlin/sdk/sdk-android/build.gradle @@ -0,0 +1,51 @@ +plugins { + id 'com.android.library' + id 'org.jetbrains.kotlin.android' +} + +ext { + PUBLISH_GROUP_ID = ConfigurationData.publishGroupId + PUBLISH_ARTIFACT_ID = 'sdk-android' + PUBLISH_VERSION = rootVersionName + PUBLISH_DESCRIPTION = 'Android Bindings to the Matrix Rust SDK' +} + +apply from: "${rootDir}/scripts/publish-module.gradle" + +android { + + compileSdk ConfigurationData.compileSdk + + defaultConfig { + minSdk ConfigurationData.minSdk + targetSdk ConfigurationData.targetSdk + versionName ConfigurationData.versionName + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + consumerProguardFiles "consumer-rules.pro" + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + kotlinOptions { + jvmTarget = '1.8' + } +} + +android.libraryVariants.all { variant -> + def sourceSet = variant.sourceSets.find { it.name == variant.name } + sourceSet.java.srcDir new File(buildDir, "generated/source/${variant.name}") +} + +dependencies { + implementation Dependencies.jna + testImplementation Dependencies.junit +} diff --git a/bindings/kotlin/sdk/sdk-android/consumer-rules.pro b/bindings/kotlin/sdk/sdk-android/consumer-rules.pro new file mode 100644 index 000000000..e69de29bb diff --git a/bindings/kotlin/sdk/sdk-android/proguard-rules.pro b/bindings/kotlin/sdk/sdk-android/proguard-rules.pro new file mode 100644 index 000000000..481bb4348 --- /dev/null +++ b/bindings/kotlin/sdk/sdk-android/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile \ No newline at end of file diff --git a/bindings/kotlin/sdk/sdk-android/src/main/AndroidManifest.xml b/bindings/kotlin/sdk/sdk-android/src/main/AndroidManifest.xml new file mode 100644 index 000000000..1ae1f06b5 --- /dev/null +++ b/bindings/kotlin/sdk/sdk-android/src/main/AndroidManifest.xml @@ -0,0 +1,2 @@ + + diff --git a/bindings/kotlin/sdk/sdk-jvm/.gitignore b/bindings/kotlin/sdk/sdk-jvm/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/bindings/kotlin/sdk/sdk-jvm/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/bindings/kotlin/sdk/sdk-jvm/build.gradle b/bindings/kotlin/sdk/sdk-jvm/build.gradle new file mode 100644 index 000000000..ce669345b --- /dev/null +++ b/bindings/kotlin/sdk/sdk-jvm/build.gradle @@ -0,0 +1,13 @@ +plugins { + id 'java-library' + id 'org.jetbrains.kotlin.jvm' +} + +java { + sourceCompatibility = JavaVersion.VERSION_1_7 + targetCompatibility = JavaVersion.VERSION_1_7 +} + +dependencies { + implementation 'net.java.dev.jna:jna:5.10.0@aar' +} \ No newline at end of file diff --git a/bindings/kotlin/settings.gradle b/bindings/kotlin/settings.gradle new file mode 100644 index 000000000..f1f0f2279 --- /dev/null +++ b/bindings/kotlin/settings.gradle @@ -0,0 +1,27 @@ +pluginManagement { + repositories { + gradlePluginPortal() + google() + mavenCentral() + } + plugins { + id 'com.android.application' version '7.1.0-beta01' + id 'com.android.library' version '7.1.0-beta01' + id 'org.jetbrains.kotlin.android' version '1.5.30' + id 'org.jetbrains.kotlin.jvm' version '1.5.30' + } +} +dependencyResolutionManagement { + repositories { + google() + mavenCentral() + flatDir { + dirs 'libs' + } + } +} +rootProject.name = "MatrixKotlinRustSDK" +include ':crypto:crypto-android' +include ':crypto:crypto-jvm' +include ':sdk:sdk-jvm' +include ':sdk:sdk-android' diff --git a/bindings/matrix-sdk-crypto-ffi/uniffi.toml b/bindings/matrix-sdk-crypto-ffi/uniffi.toml index d23d255b5..ca1ce5b22 100644 --- a/bindings/matrix-sdk-crypto-ffi/uniffi.toml +++ b/bindings/matrix-sdk-crypto-ffi/uniffi.toml @@ -1,5 +1,6 @@ [bindings.kotlin] -package_name = "org.matrix.sdk.crypto" +package_name = "org.matrix.rustcomponents.sdk.crypto" +cdylib_name = "matrix_sdk_crypto_ffi" [bindings.swift] module_name = "MatrixSDKCrypto" diff --git a/bindings/matrix-sdk-ffi/uniffi.toml b/bindings/matrix-sdk-ffi/uniffi.toml new file mode 100644 index 000000000..b2baf340a --- /dev/null +++ b/bindings/matrix-sdk-ffi/uniffi.toml @@ -0,0 +1,3 @@ +[bindings.kotlin] +package_name = "org.matrix.rustcomponents.sdk" +cdylib_name = "matrix_sdk_ffi" \ No newline at end of file