@spruceid/react-native-mobile-sdk
v0.1.1
Published
Spruce Mobile SDK for React Native
Downloads
5
Readme
SpruceID Mobile SDK for React Native
Maturity Disclaimer
In its current version, Mobile SDK has not yet undergone a formal security audit to desired levels of confidence for suitable use in production systems. This implementation is currently suitable for exploratory work and experimentation only. We welcome feedback on the usability, architecture, and security of this implementation and are committed to a conducting a formal audit with a reputable security firm before the v1.0 release.
Installation
npm install @spruceid/react-native-mobile-sdk
iOS
Add to the app's info.plist
<key>NSBluetoothAlwaysUsageDescription</key>
<string>Secure transmission of mobile DL/ID data</string>
Android
Add to the AndroidManifest.xml
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
In addition to the manifest, on newer Android versions your applications will also need to trigger a dialogue prompt. You can refer to this documentation for more information
await PermissionsAndroid.requestMultiple([
'android.permission.ACCESS_FINE_LOCATION',
'android.permission.BLUETOOTH_CONNECT',
'android.permission.BLUETOOTH_SCAN',
'android.permission.BLUETOOTH_ADVERTISE',
]);
Usage
import { createMdocFromCbor } from '@spruceid/react-native-mobile-sdk';
// ...
const mdoc = await createMdocFromCbor(mdocCborBase64);
For more, see the documentation.
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
Architecture
Our Mobile SDKs use shared code, with most of the logic being written once in Rust, and when not possible, native APIs (e.g. Bluetooth, OS Keychain) are called in native SDKs.
┌────────────┐
│React Native│
└──────┬─────┘
│
┌────┴────┐
┌───▼──┐ ┌──▼──┐
│Kotlin│ │Swift│
└───┬──┘ └──┬──┘
└────┬────┘
│
┌──▼─┐
│Rust│
└────┘