Skip to content

Libraries and examples for integrating verifiable credentials (VC) and mobile driver's licenses (mDL) into mobile apps.

Notifications You must be signed in to change notification settings

spruceid/sprucekit-mobile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SpruceKit Mobile

SpruceKit Mobile is a collection of libraries and examples for integrating verifiable credentials (VC) and mobile driver's licenses (mDL) into Android and iOS applications.

Maturity Disclaimer

In its current version, SpruceKit Mobile 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.

Usage

iOS

Import https://github.com/spruceid/sprucekit-mobile and use the product SpruceIDMobileSdk.

Android

See https://central.sonatype.com/artifact/com.spruceid.mobile.sdk/mobilesdk.

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.

┌────────┐ ┌────────┐
│Showcase│ │Showcase│
│Android │ │  iOS   │
└────┬───┘ └───┬────┘
     │         │
     │         │
 ┌───▼──┐   ┌──▼──┐
 │Kotlin│   │Swift│
 └───┬──┘   └──┬──┘
     └────┬────┘
          │
       ┌──▼─┐
       │Rust│
       └────┘

Configuring Deep Links for same device flows

To configure the same device OpenID4VP flow:

Contributing

See CONTRIBUTING.md.

Funding

This work is funded in part by the U.S. Department of Homeland Security's Science and Technology Directorate under contract 70RSAT24T00000011 (Open-Source and Privacy-Preserving Digital Credentialing Infrastructure). Through this contract, SpruceID’s open-source libraries will be used to build privacy-preserving digital credential wallets and verifier capabilities to support standards while ensuring safe usage and interoperability across sectors like finance, healthcare, and various cross-border applications. To learn more about this work, read more here .