@wireapp/core-crypto 0.4.0

package/README.md

@@ -0,0 +1,118 @@
+# Wire CoreCrypto
+
+[![Wire logo](https://github.com/wireapp/wire/blob/master/assets/header-small.png?raw=true)](https://wire.com/jobs/)
+
+This repository is part of the source code of Wire. You can find more information at [wire.com](https://wire.com) or by contacting opensource@wire.com.
+
+You can find the published source code at [github.com/wireapp/wire](https://github.com/wireapp/wire).
+
+For licensing information, see the attached LICENSE file and the list of third-party licenses at [wire.com/legal/licenses/](https://wire.com/legal/licenses/).
+
+No license is granted to the Wire trademark and its associated logos, all of which will continue to be owned exclusively by Wire Swiss GmbH. Any use of the Wire trademark and/or its associated logos is expressly prohibited without the express prior written consent of Wire Swiss GmbH.
+
+## Parts
+
+* CoreCrypto: Abstracts MLS & Proteus in a unified API
+* CoreCryptoFFI: FFI bindings for iOS, Android and WASM
+* Keystore: Encrypted Keystore powered by SQLCipher on all platforms except WASM. WASM uses an IndexedDB-backed, encrypted store with AES256-GCM
+* MlsProvider: RustCrypto + Keystore MLS provider
+
+See [ARCHITECTURE.md](docs/ARCHITECTURE.md)
+
+## Usage
+
+### [API Docs](https://wireapp.github.io/core-crypto/core_crypto/)
+
+## Building
+
+### General Requirements
+
+- rust: [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)
+- cargo-make: [https://sagiegurari.github.io/cargo-make/](https://sagiegurari.github.io/cargo-make/)
+
+### Android
+
+Install Android SDK and Build-Tools for API level 30+
+
+NOTE: If you are building on macOS you'll need to setup $ANDROID_SDK_ROOT path variable manually:
+```ignore
+export ANDROID_SDK_ROOT=~/Android/Sdk
+```
+Install android rust targets
+```ignore
+rustup target add x86_64-linux-android aarch64-linux-android armv7-linux-androideabi i686-linux-android
+```
+
+### iOS
+
+Install Xcode & it's commandline tools: [https://developer.apple.com/xcode/](https://developer.apple.com/xcode/)
+
+Install iOS rust targets
+
+```ignore
+rustup target add aarch64-apple-ios x86_64-apple-ios aarch64-apple-ios-sim
+```
+
+### MacOS
+
+Install macOS rust targets (M1 macs are currently not supported)
+```ignore
+rustup target add x86_64-apple-darwin
+```
+
+### Linux
+
+If cross-compiling from macOS you'll need install: [https://github.com/messense/homebrew-macos-cross-toolchains](https://github.com/messense/homebrew-macos-cross-toolchains)
+
+Install linux targets
+
+```ignore
+rustup target add x86_64-unknown-linux-gnu
+```
+
+### WASM
+
+* Install [wasm-pack](https://rustwasm.github.io/wasm-pack/)
+* Install the wasm32-unknown-unknown toolchain `rustup target add wasm32-unknown-unknown`
+* Install node.js (recommended way is via [Volta](https://volta.sh/))
+
+### Bindings
+
+Build bindings for Android, JVM, iOS and WASM
+
+```ignore
+cd crypto-ffi 
+
+# builds bindings and targets for the JVM (macOS / Linux)
+cargo make "copy-jvm-resources"
+
+# builds bindings and targets for Android
+cargo make "copy-android-resources"
+
+# builds iOS framework
+cargo make "create-swift-package"
+
+# builds wasm binary
+cargo make wasm
+```
+
+## Publishing
+
+### Changelog
+
+* Update <CHANGELOG.tpl> accordingly
+* run `cargo xtask documentation changelog` to update <CHANGELOG.md> with the git-conventional history
+
+### Android / JVM
+
+You can publish the JVM and Android bindings to maven using gradle after you'be build the corresponding target.
+
+```ignore
+cd kotlin
+./gradlew :jvm:publishToMavenLocal
+./gradlew :android:publishToMavenLocal
+```
+
+### JS / WASM
+
+Given that you are logged in NPM and can publish to `@wireapp/core-crypto`, you can just `npm publish` to push a new version

package/package.json

@@ -0,0 +1,63 @@
+{
+    "name": "@wireapp/core-crypto",
+    "version": "0.4.0",
+    "description": "CoreCrypto bindings for the Web - Dev version",
+    "type": "module",
+    "module": "platforms/web/corecrypto.js",
+    "types": "platforms/web/corecrypto.d.js",
+    "scripts": {
+        "prepare": "npm run build",
+        "build": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.js",
+        "build:test": "npm run clean && rollup -c crypto-ffi/bindings/js/rollup.config.test.js",
+        "clean": "rm -f ./platforms/web/*.{js,ts,wasm,html} && rm -rf ./platforms/web/assets",
+        "package": "npm run build && npm pack",
+        "test:raw": "jest -c crypto-ffi/bindings/js/jest.config.js --no-cache --runInBand --verbose",
+        "test": "npm run build:test && npm run test:raw",
+        "test:cov": "npm run build:test && jest -c crypto-ffi/bindings/js/jest.config.js --coverage --no-cache --runInBand --verbose"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "platforms/web"
+    ],
+    "keywords": [
+        "wire",
+        "e2ee",
+        "corecrypto",
+        "mls",
+        "proteus"
+    ],
+    "author": "Mathieu Amiot <amiot.mathieu@gmail.com>",
+    "license": "GPL-3.0",
+    "homepage": "https://github.com/wireapp/core-crypto",
+    "repository": {
+        "type": "git",
+        "url": "git@github.com:wireapp/core-crypto.git"
+    },
+    "bugs": {
+        "url": "https://github.com/wireapp/core-crypto/issues"
+    },
+    "devDependencies": {
+        "@rollup/plugin-html": "^0.2.4",
+        "@types/jest": "^28.1.6",
+        "@types/jest-dev-server": "^5.0.0",
+        "@typescript-eslint/eslint-plugin": "^5.33.0",
+        "@typescript-eslint/parser": "^5.33.0",
+        "@wasm-tool/rollup-plugin-rust": "^2.2.2",
+        "dts-bundle-generator": "^6.12.0",
+        "eslint": "^8.21.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^4.2.1",
+        "jest": "^28.1.3",
+        "jest-dev-server": "^6.1.1",
+        "prettier": "^2.7.1",
+        "puppeteer": "^16.1.0",
+        "rollup": "^2.77.2",
+        "rollup-jest": "^3.0.0",
+        "rollup-plugin-ts": "^3.0.2",
+        "ts-jest": "^28.0.7",
+        "ts-loader": "^9.3.1",
+        "typescript": "^4.7.4"
+    }
+}