@procivis/react-native-one-core 1.26999.0 → 1.41710.0

package/README.md

@@ -1,5 +1,8 @@
-![Procivis One](https://assets.procivis-one.com/static/logo/logo_dark_Procivis_One.png#gh-light-mode-only)
-![Procivis One](https://assets.procivis-one.com/static/logo/logo_light_Procivis_One.png#gh-dark-mode-only)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://assets.procivis-one.com/static/logo/logo_dark_Procivis_One.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://assets.procivis-one.com/static/logo/logo_light_Procivis_One.png">
+  <img alt="Shows a Procivis One black logo in light color mode and a white one in dark color mode." src="https://assets.procivis-one.com/static/logo/logo_light_Procivis_One.png">
+</picture>
 
 # One Core React Native SDK
 
@@ -60,27 +63,6 @@ allprojects {
 }
 ```
 
-Add following to your app `android/app/build.gradle` to remove unsupported architectures:
-
-```
-...
-android {
-   defaultConfig {
-        ...
-
-        ndk {
-            abiFilters "armeabi-v7a", "arm64-v8a", "x86"
-        }
-        packagingOptions {
-            exclude 'lib/mips/**'
-            exclude 'lib/mips64/**'
-            exclude 'lib/armeabi/**'
-            exclude 'lib/x86_64/**'
-        }
-    }
-}
-```
-
 ## Usage
 
 ```javascript
@@ -137,24 +119,48 @@ and regulations mature and harden.
 
 ## Supported standards
 
-### Credential data models
+### Credential models
+
+#### W3C VC
+
+- [W3C Verifiable Credentials Data Model 2.0][vcdm] in the following variations:
+
+| Securing mechanism                           | Supported representations                           | Supported proof/signature types                                                          |
+| -------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------ |
+| [W3C Data Integrity Proofs][vcdi] (embedded) | [JSON-LD][jld] in Compacted Document Form | <ul><li>[W3C Data Integrity ECDSA Cryptosuites v1.0][ecd] / [ecdsa-rdfc-2019][ecd2019]</li><li>[W3C Data Integrity EdDSA Cryptosuites v1.0][edd] / [eddsa-rdfc-2022][edd2022]</li><li>[W3C Data Integrity BBS Cryptosuites v1.0][bbs] / [bbs-2023][bbs2023]</li></ul> |
+| [W3C VC-JOSE-COSE][jose] (enveloping)        | <ul><li>[SD-JWT][sdjwt]</li><li>[JWT][jw]</li></ul> | <ul><li>JOSE / ECDSA [ES256][es2]</li><li>JOSE / EdDSA [Ed25519][ed255]</li><li>JOSE / CRYSTALS-DILITHIUM 3 [CRYDI3][crydi3]* |
+
+\* CRYSTALS-DILITHIUM is a post-quantum resistant signature scheme, selected by NIST for [Post-Quantum Cryptography Standardization][pqc].
+Support for the recently published [FIPS-204][fips] is planned for the near future.
+
+#### ISO mdoc
+
+- [ISO/IEC 18013-5:2021][iso5] standard for mdoc credentials.
+  - [COSE][cose] proofs
+    - ECDSA [ES256][es2]
+    - EdDSA [Ed25519][ed255]
+
+#### IETF SD-JWT VC
+
+- [IETF SD-JWT-based Verifiable Credentials][sdjwtvc]:
+
+| Standard       | Supported representations | Supported proof/signature types                                                                                                          |
+| -------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| IETF SD-JWT VC | SD-JWT                    | <ul><li>JOSE / ECDSA [ES256][es2]</li><li>JOSE / EdDSA [Ed25519][ed255]</li><li>JOSE / CRYSTALS-DILITHIUM 3 [CRYDI3][crydi3]\*</li></ul> |
 
-- [Verifiable Credentials][vcdm] (VCs)
-  - JSON-LD
-  - SD-JWT
-  - JWT
-- [ISO/IEC 18013-5:2021][iso]
-  - mdoc
+\* CRYSTALS-DILITHIUM is a post-quantum resistant signature scheme, selected by NIST for [Post-Quantum Cryptography Standardization][pqc].
+Support for the recently published [FIPS-204][fips] is planned for the near future.
 
 ### Exchange and transport
 
 - OpenID for Verifiable Credentials
   - [OID4VCI][vci]; ID-1
-  - [OID4VP][vp]; ID-2
+  - OID4VP; [ID-2][vp20] (Draft 20) & [Draft 25][vp25]
     - [OID4VP over BLE][ble]; optimized version of Draft 00
-    - OID4VP over MQTT; proprietary adaptation of OID4VP over BLE via MQTT channel
-- [ISO/IEC 18013-5][iso]
-  - QR-code engagement and offline device retrieval over BLE
+    - OID4VP over MQTT; proprietary adaptation of "OID4VP over BLE" via MQTT channel
+- ISO/IEC 18013
+  - [18013-5][iso5]: QR code engagement and offline device retrieval over BLE
+  - [18013-7][iso7]: Online data retrieval via OID4VP
 
 ### Key storage
 
@@ -165,6 +171,7 @@ and regulations mature and harden.
 
 - [Bitstring Status List v1.0][sl]
 - [Linked Validity Verifiable Credentials (LVVC)][lvvc]
+- [Token Status List - Draft 03][tsl]
 
 ## Support
 
@@ -175,28 +182,52 @@ Need support or have feedback? [Contact us](https://www.procivis.ch/en/contact).
 Some rights reserved. This library is published under the [Apache License
 Version 2.0](./LICENSE).
 
-![Procivis AG](https://assets.procivis-one.com/static/logo/logo_light_mode_Procivis.svg#gh-light-mode-only)
-![Procivis AG](https://assets.procivis-one.com/static/logo/logo_dark_mode_Procivis.svg#gh-dark-mode-only)
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://assets.procivis-one.com/static/logo/logo_dark_mode_Procivis.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://assets.procivis-one.com/static/logo/logo_light_mode_Procivis.svg">
+  <img alt="Shows a Procivis black logo in light color mode and a white one in dark color mode." src="https://assets.procivis-one.com/static/logo/logo_dark_mode_Procivis.svg">
+</picture>
 
 © Procivis AG, [https://www.procivis.ch](https://www.procivis.ch).
 
 [archi]: https://github.com/procivis#architecture
+[bbs]: https://www.w3.org/TR/vc-di-bbs/
+[bbs2023]: https://www.w3.org/TR/vc-di-bbs/#bbs-2023
 [ble]: https://openid.net/specs/openid-4-verifiable-presentations-over-ble-1_0.html
 [canivc]: https://canivc.com/implementations/procivis-one-core/
 [comp]: https://github.com/procivis/one-react-native-components
 [core]: https://github.com/procivis/one-core
+[cose]: https://www.rfc-editor.org/rfc/rfc9052
+[crydi3]: https://datatracker.ietf.org/doc/html/draft-ietf-cose-dilithium-01
 [docs]: https://docs.procivis.ch/
+[ecd]: https://www.w3.org/TR/vc-di-ecdsa/
+[ecd2019]: https://www.w3.org/TR/vc-di-ecdsa/#ecdsa-rdfc-2019
+[edd]: https://www.w3.org/TR/vc-di-eddsa/
+[edd2022]: https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022
+[ed255]: https://datatracker.ietf.org/doc/html/rfc8037
+[es2]: https://datatracker.ietf.org/doc/html/rfc7518
 [eudiwi]: https://issuer.eudiw.dev/
 [eudiwv]: https://verifier.eudiw.dev/home
-[iso]: https://www.iso.org/standard/69084.html
+[fips]: https://csrc.nist.gov/pubs/fips/204/final
+[iso5]: https://www.iso.org/standard/69084.html
+[iso7]: https://www.iso.org/standard/82772.html
+[jld]: https://www.w3.org/TR/json-ld11/
+[jose]: https://w3c.github.io/vc-jose-cose/
+[jw]: https://datatracker.ietf.org/doc/html/rfc7519
 [key]: https://github.com/procivis#key-features
 [lvvc]: https://eprint.iacr.org/2022/1658.pdf
 [owf]: https://github.com/openwallet-foundation-labs/identity-credential
 [pow]: https://github.com/procivis/one-wallet
+[pqc]: https://csrc.nist.gov/pqc-standardization
 [rncore]: https://github.com/procivis/react-native-one-core
-[sdkref]: https://docs.procivis.ch/sdk/overview
+[sdjwt]: https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-12.html
+[sdjwtvc]: https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-05.html
+[sdkref]: https://docs.procivis.ch/sdk
 [sl]: https://www.w3.org/TR/vc-bitstring-status-list/
-[trial]: https://docs.procivis.ch/trial/intro
+[trial]: https://docs.procivis.ch/trial
+[tsl]: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-status-list-03
+[vcdi]: https://www.w3.org/TR/vc-data-integrity/
 [vcdm]: https://www.w3.org/TR/vc-data-model-2.0/
 [vci]: https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0-ID1.html
-[vp]: https://openid.net/specs/openid-4-verifiable-presentations-1_0-ID2.html
+[vp20]: https://openid.net/specs/openid-4-verifiable-presentations-1_0-20.html
+[vp25]: https://openid.net/specs/openid-4-verifiable-presentations-1_0-25.html

package/android/build.gradle

@@ -24,8 +24,18 @@ class Checksum {
     }
 }
 
+buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'org.jetbrains.kotlin.plugin.serialization:org.jetbrains.kotlin.plugin.serialization.gradle.plugin:1.9.0'
+    }
+}
+
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
+apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
 
 def safeExtGet(prop, fallback) {
     rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
@@ -36,7 +46,7 @@ android {
     buildToolsVersion = "30.0.2"
 
     defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 21)
+        minSdkVersion safeExtGet('minSdkVersion', 26)
         targetSdkVersion safeExtGet('targetSdkVersion', 33)
         versionCode 1
         versionName "1.0.0"
@@ -46,6 +56,9 @@ android {
     lintOptions {
         abortOnError false
     }
+    buildFeatures {
+        dataBinding true
+    }
 }
 
 repositories {
@@ -53,13 +66,33 @@ repositories {
 }
 
 dependencies {
-    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:${safeExtGet('kotlinVersion', '1.8.0')}")
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:${safeExtGet('kotlinVersion', '1.9.0')}")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1")
     implementation 'com.facebook.react:react-native:+'
 
     releaseImplementation(name: 'onecore-release', ext: 'aar')
     debugImplementation(name: 'onecore-debug', ext: 'aar')
     implementation 'net.java.dev.jna:jna:5.13.0@aar'
-    implementation("org.jetbrains.kotlin:kotlin-reflect:${safeExtGet('kotlinVersion', '1.8.0')}")
+    implementation("org.jetbrains.kotlin:kotlin-reflect:${safeExtGet('kotlinVersion', '1.9.0')}")
+
+    implementation(name: 'core-reactnative-compatible-2025.0305.1', ext: 'aar')
+    implementation("com.google.android.material:material:1.9.0")
+    implementation("com.squareup.retrofit2:retrofit:2.11.0")
+    implementation("com.squareup.retrofit2:converter-scalars:2.11.0")
+    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.0")
+    implementation("com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:1.0.0")
+    implementation("com.jakewharton.timber:timber:5.0.1")
+    implementation("org.apache.commons:commons-math3:3.6.1")
+    implementation 'androidx.appcompat:appcompat:1.6.1'
+    implementation 'androidx.biometric:biometric:1.1.0'
+}
+
+def downloadFile = { url, file ->
+    new URL(url).withInputStream { downloadStream ->
+        file.withOutputStream { fileOut ->
+            fileOut << downloadStream
+        }
+    }
 }
 
 def coreUrlAAR = { buildType ->
@@ -71,18 +104,21 @@ def coreUrlAAR = { buildType ->
     def url = sdk.url
     File file = new File("$projectDir/libs/${name}.aar")
     file.parentFile.mkdirs()
-    if (!file.exists()) {
-        new URL(url).withInputStream { downloadStream ->
-            file.withOutputStream { fileOut ->
-                fileOut << downloadStream
-            }
+
+    def sha1Expected = sdk.sha1
+    if (file.exists()) {
+        if (Checksum.getChecksum(file, "SHA1") == sha1Expected) {
+            // all good
+            return
         }
+        // The file is most likely just stale -> delete and download again
+        file.delete()
     }
 
+    downloadFile(url, file)
     def sha1sum = Checksum.getChecksum(file, "SHA1")
-    def sha1Expected = sdk.sha1
     if (sha1sum != sha1Expected) {
-        file.delete()
+        // if the file hash still does not match then something is off
         println "URL($name): $url"
         println "sha1 expected: $sha1Expected"
         println "sha1 actual: $sha1sum"

package/android/build.gradle_opensource

@@ -0,0 +1,121 @@
+import java.security.MessageDigest
+class Checksum {
+    static getChecksum(file, type) {
+        def digest = MessageDigest.getInstance(type)
+        def inputStream = file.newInputStream()
+        def buffer = new byte[16384]
+        def len
+
+        while((len=inputStream.read(buffer)) > 0) {
+            digest.update(buffer, 0, len)
+        }
+
+        def result = ""
+        for(byte b : digest.digest()) {
+            result += toHex(b)
+        }
+        return result
+    }
+    private static hexChr(int b) {
+        return Integer.toHexString(b & 0xF)
+    }
+    private static toHex(int b) {
+        return hexChr((b & 0xF0) >> 4) + hexChr(b & 0x0F)
+    }
+}
+
+buildscript {
+    repositories {
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath 'org.jetbrains.kotlin.plugin.serialization:org.jetbrains.kotlin.plugin.serialization.gradle.plugin:1.9.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
+android {
+    compileSdkVersion safeExtGet('compileSdkVersion', 33)
+    buildToolsVersion = "30.0.2"
+
+    defaultConfig {
+        minSdkVersion safeExtGet('minSdkVersion', 26)
+        targetSdkVersion safeExtGet('targetSdkVersion', 33)
+        versionCode 1
+        versionName "1.0.0"
+        
+        consumerProguardFiles 'proguard-rules.pro'
+    }
+    lintOptions {
+        abortOnError false
+    }
+    buildFeatures {
+        dataBinding true
+    }
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk7:${safeExtGet('kotlinVersion', '1.9.0')}")
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.8.1")
+    implementation 'com.facebook.react:react-native:+'
+
+    releaseImplementation(name: 'onecore-release', ext: 'aar')
+    debugImplementation(name: 'onecore-debug', ext: 'aar')
+    implementation 'net.java.dev.jna:jna:5.13.0@aar'
+    implementation("org.jetbrains.kotlin:kotlin-reflect:${safeExtGet('kotlinVersion', '1.9.0')}")
+}
+
+def downloadFile = { url, file ->
+    new URL(url).withInputStream { downloadStream ->
+        file.withOutputStream { fileOut ->
+            fileOut << downloadStream
+        }
+    }
+}
+
+def coreUrlAAR = { buildType ->
+    def name = "onecore-${buildType}"
+    def coreSdkJsonFile = file("$projectDir/../core-sdk.json")
+    def coreSdkJson = new groovy.json.JsonSlurper().parseText(coreSdkJsonFile.text)
+    def sdk = coreSdkJson.android[buildType]
+
+    def url = sdk.url
+    File file = new File("$projectDir/libs/${name}.aar")
+    file.parentFile.mkdirs()
+
+    def sha1Expected = sdk.sha1
+    if (file.exists()) {
+        if (Checksum.getChecksum(file, "SHA1") == sha1Expected) {
+            // all good
+            return
+        }
+        // The file is most likely just stale -> delete and download again
+        file.delete()
+    }
+
+    downloadFile(url, file)
+    def sha1sum = Checksum.getChecksum(file, "SHA1")
+    if (sha1sum != sha1Expected) {
+        // if the file hash still does not match then something is off
+        println "URL($name): $url"
+        println "sha1 expected: $sha1Expected"
+        println "sha1 actual: $sha1sum"
+        throw new Error("AAR file SHA1 mismatch: " + name)
+    }
+}
+
+afterEvaluate {
+    coreUrlAAR('debug')
+    coreUrlAAR('release')
+}

package/android/src/main/AndroidManifest.xml

@@ -1,2 +1,5 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="ch.procivis.one.core">
-</manifest>
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="ch.procivis.one.core">
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+</manifest>

package/android/src/main/java/ch/procivis/one/core/Deserialize.kt

@@ -11,11 +11,11 @@ object Deserialize {
         return constructObjectWithMembers(T::class, data) as T
     }
 
-    private fun extractArrayItem(kType: KType, data: ReadableArray, index: Int): Any {
+    private fun extractArrayItem(kType: KType, data: ReadableArray, index: Int): Any? {
         val kClass = kType.classifier as KClass<*>
 
         if (kClass.java.isEnum) {
-            return constructEnumValue(kClass, data.getString(index))
+            return constructEnumValue(kClass, data.getString(index)!!)
         }
 
         return when (kClass) {
@@ -26,15 +26,15 @@ object Deserialize {
             List::class -> {
                 val itemType = kType.arguments.first().type
                 val values = data.getArray(index)
-                return extractArrayItems(itemType!!, values)
+                return extractArrayItems(itemType!!, values!!)
             }
 
             Map::class -> {
                 val values = data.getMap(index)
-                return extractMapItems(kType, values)
+                return extractMapItems(kType, values!!)
             }
 
-            else -> constructObjectWithMembers(kClass, data.getMap(index))
+            else -> constructObjectWithMembers(kClass, data.getMap(index)!!)
         }
     }
 
@@ -58,7 +58,7 @@ object Deserialize {
     }
 
     private fun extractObjectItem(type: KType, data: ReadableMap, name: String): Any? {
-        if (!data.hasKey(name) || (type.isMarkedNullable && data.isNull(name))) {
+        if (!data.hasKey(name)) {
             return null
         }
 
@@ -69,6 +69,10 @@ object Deserialize {
             return DeserializeSpecific.Obj.convertCustom(kClass, data, name)
         }
 
+        if (type.isMarkedNullable && data.isNull(name)) {
+            return null
+        }
+
         if (kClass.java.isEnum) {
             return constructEnumValue(kClass, data.getString(name)!!)
         }

package/android/src/main/java/ch/procivis/one/core/DeserializeSpecific.kt

@@ -6,7 +6,7 @@ import kotlin.reflect.KClass
 
 object DeserializeSpecific {
     object Obj {
-        private val CustomConversionTypes = arrayOf(CredentialSchemaTypeBindingEnum::class)
+        private val CustomConversionTypes = arrayOf(CredentialSchemaTypeBindingEnum::class, OptionalString::class)
 
         fun isCustomConversionType(type: KClass<*>): Boolean {
             return CustomConversionTypes.contains(type)
@@ -16,7 +16,14 @@ object DeserializeSpecific {
             return when (type) {
                 CredentialSchemaTypeBindingEnum::class -> input.getString(field)
                     ?.let { credentialSchemaType(it) }
-
+                OptionalString::class -> {
+                    val value = input.getString(field)
+                    if (value == null) {
+                        OptionalString.None
+                    } else {
+                        OptionalString.Some(value)
+                    }
+                }
                 else -> {
                     throw IllegalArgumentException("Invalid map conversion: $input")
                 }
@@ -31,6 +38,7 @@ object DeserializeSpecific {
             "PROCIVIS_ONE_SCHEMA2024" -> CredentialSchemaTypeBindingEnum.ProcivisOneSchema2024
             "FALLBACK_SCHEMA2024" -> CredentialSchemaTypeBindingEnum.FallbackSchema2024
             "MDOC" -> CredentialSchemaTypeBindingEnum.Mdoc
+            "SD_JWT_VC" -> CredentialSchemaTypeBindingEnum.SdJwtVc
             else -> CredentialSchemaTypeBindingEnum.Other(credentialSchemaType)
         }
     }
@@ -38,7 +46,7 @@ object DeserializeSpecific {
     fun ids(ids: ReadableArray): List<String> {
         val result = mutableListOf<String>()
         for (n in 0 until ids.size()) {
-            result.add(ids.getString(n))
+            result.add(ids.getString(n)!!)
         }
         return result
     }
@@ -84,10 +92,10 @@ object DeserializeSpecific {
         return fn(input)
     }
 
-    private fun <T> enumList(entries: ReadableArray, fn: (String) -> T): List<T> {
+    fun <T> enumList(entries: ReadableArray, fn: (String) -> T): List<T> {
         val result = mutableListOf<T>()
         for (n in 0 until entries.size()) {
-            result.add(fn(entries.getString(n)))
+            result.add(fn(entries.getString(n)!!))
         }
         return result
     }