Skip to content

Commit c3b6423

Browse files
committed
docs: add mobile support section to README
Document the mobile feature flag, HostCallbackKeyProvider, rustls TLS backend, redb storage compatibility, and CI workflow for cross-compilation.
1 parent 9fd48e8 commit c3b6423

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,15 @@ This repository provides the implementation of the KERI protocol. [`keriox_core`
4444
- [Watcher](./components/watcher): the KERI Watcher
4545
- [Controller](./components/controller): the client for accessing the infrastructure
4646
- [SDK](./keriox_sdk): high-level SDK providing `KeriRuntime` and `Controller` for KERI+TEL operations
47+
- [Key Provider](./keri_keyprovider): pluggable cryptographic signing abstraction (software, file-encrypted, OS keychain, host-callback for mobile)
48+
49+
## Mobile support
50+
51+
KERIOX supports mobile targets (Android API 30+ and iOS) via:
52+
53+
- **`mobile` feature flag** on `keri-sdk` — enables `host` + `software` key providers, uses `rustls` for TLS
54+
- **`HostCallbackKeyProvider`** in `keri_keyprovider` — delegates all signing to host platform callbacks (Android Keystore / iOS Keychain). Private keys never enter Rust memory.
55+
- **`rustls`** TLS backend — pure Rust, no OpenSSL dependency
56+
- **`redb`** storage — pure Rust, no mmap, works on both Android and iOS app sandboxes
57+
58+
See the [mobile SDK CI workflow](./.github/workflows/mobile.yml) for cross-compilation verification.

0 commit comments

Comments
 (0)