This document is a guide for using the OpenDID authentication client, providing users with the functionality to create, store, and manage WalletToken, Lock/Unlock, Key, DID Document, and Verifiable Credential (VC) information required for OpenDID.
| Category | Details |
|---|---|
| OS | Android 14 |
| Language | Java 17 |
| IDE | Android Studio 4 |
| Build System | Gradle 8.2 |
| Compatibility | Android API level 34 or higher |
git clone https://github.com/OmniOneID/did-ca-aos.git
: This is how to compile and test the app using Android Studio.
- Install Android Studio
- After installing Android Studio, run it. From the top menu, select File > Open to open the desired project folder. (source/did-ca-aos)
- Open the project
- Once the project is open, you can check the source files, resource files, and configuration files in the left-side Project window of the Android Studio window. Here you can manage all the code and resources of the app.
- Select emulator or real device
- In the Android Studio window's top bar, you can select the target device to build and run the app in the Device Manager or Target Device menu.
- Emulator: You can run the app on a virtual Android device. To create a new virtual device, use the AVD Manager to set up a new emulator. There may be differences from a real device, and some features may not work on the emulator.
- Device: If a real Android device is connected via USB, select that device to run the app. USB debugging must be enabled in the developer options.
- Check project settings
- Before building, you need to verify the project settings.
- Go to File > Project Structure and in the Modules section, verify the Compile SDK Version, Build Tools Version, Min SDK Version, etc., and modify them if necessary.
- In the build.gradle file, check the dependencies, defaultConfig, and buildTypes settings to manage the app's build configuration.
- Build and run the app
- After selecting the target device, click the Run button at the top to build the app and run it on the selected device. If the build is successful, the app will run on the selected emulator or device.
The Android SDK is referred to as did-client-sdk-aos below.
- did-core-sdk-aos-1.0.0.jar
- did-utility-sdk-aos-1.0.0.jar
- did-datamodel-sdk-aos-1.0.0.jar
- did-wallet-sdk-aos-1.0.0.jar
- did-communication-sdk-aos-1.0.0.jar
Please refer to the respective links for their own licenses for third-party libraries used by each SDK.
Client SDK License-dependencies
- Prepare the did-client-sdk-aos library
- If you do not have the above library files, you need to build them from the SDK repository to generate the jar files. Move to Client SDK
-
Add the did-client-sdk-aos library
a. Add jar files to the project
- Open the project in Android Studio.
- Create a
libsfolder under theappdirectory in the Project window. (Skip this step if the folder already exists.) - Copy the prepared jar files into the
libsfolder.
b. Add jar files to the project dependencies
- After copying the jar files to the
libsfolder, right-click each jar file in the Project window and select "Add as Library..." - Android Studio will automatically add the jar files as project dependencies.
-
Modify the build.gradle file
a. Modify the dependencies section
- Open the build.gradle file for the app module, and add the following code to the dependencies section to include the
did-client-sdk-aoslibrary in the project:
dependencies { . . . implementation fileTree(dir: 'libs', include: ['*.jar']) implementation 'com.google.code.gson:gson:2.10.1' implementation 'androidx.biometric:biometric:1.1.0' implementation 'org.bitcoinj:bitcoinj-core:0.15.7' implementation 'com.madgag.spongycastle:core:1.54.0.0' implementation 'com.madgag.spongycastle:prov:1.54.0.0' implementation 'com.madgag.spongycastle:pkix:1.54.0.0' implementation 'com.madgag.spongycastle:pg:1.54.0.0' api "androidx.room:room-runtime:2.6.1" annotationProcessor "androidx.room:room-compiler:2.6.1" }b. Check the minSdkVersion and targetSdkVersion settings
- In the android section of the build.gradle file, verify the minSdkVersion and targetSdkVersion settings and modify them to meet the project requirements.
android { compileSdkVersion 34 defaultConfig { applicationId "org.omnione.did.ca" minSdkVersion 26 targetSdkVersion 34 versionCode 1 versionName "1.0" } } - Open the build.gradle file for the app module, and add the following code to the dependencies section to include the
-
Import and Usage
a. Modify the URLs Class
- In the
Config.javafile of the project, update the URL information for each service provider:
public class Config { public static final String TAS_URL = "http://192.168.3.130:8090"; public static final String VERIFIER_URL = "http://192.168.3.130:8092"; public static final String CAS_URL = "http://192.168.3.130:8094"; public static final String WALLET_URL = "http://192.168.3.130:8095"; public static final String API_GATEWAY_URL = "http://192.168.3.130:8093"; public static final String DEMO_URL = "http://192.168.3.130:8099"; }
b. Using the did-client-sdk-aos Module
- At the top of the Java/Kotlin file where you want to use the class or method, import as follows:
import org.omnione.did.sdk.core; import org.omnione.did.sdk.utility; import org.omnione.did.sdk.datamodel; import org.omnione.did.sdk.wallet; import org.omnione.did.sdk.communication;
- You can now use the features provided by the did-client-sdk-aos module in your source code:
try { String hWalletToken = WalletAPI.createWalletToken(WWALLET_TOKEN_PURPOSE.LIST_VC); List<Credential> credentials = WalletAPI.getAllCredentials(hWalletToken); if (credentials != null) { for (Credential vc : credentials) { Log.d("VC", vc.toJson()); } } } catch (WalletException e) { Log.e("WalletException", "Message: " + e.getMessage()); } catch (CommunicationException e) { Log.e("CommunicationException", "Message: " + e.getMessage()); } catch (UtilityException e) { Log.e("UtilityException", "Message: " + e.getMessage()); }
- In the
-
Build and Test
a. Build and Run
- Click the Run button at the top of Android Studio to build and run the project. If any errors occur during the build process, check the Build window for error details and resolve the issues.
b. Test
- Once the build is successfully completed, run the app to ensure that the did-client-sdk-aos library functions correctly. Use Android Studio’s debugger and logs to identify any potential issues.
-
Troubleshooting
-
If the did-client-sdk-aos library is not properly loaded or functioning, check the following:
- Correct Dependencies: Verify that the dependencies are correctly set in the
build.gradlefile. - SDK Version: Ensure that the project’s minSdkVersion and targetSdkVersion are compatible with the SDK being used.
- Permissions: Check that the necessary permissions are correctly set in the AndroidManifest.xml file.
- Correct Dependencies: Verify that the dependencies are correctly set in the
-
ChangeLog can be found :
To watch our demonstration videos of the OpenDID system in action, please visit our Demo Repository.
These videos showcase key features including user registration, VC issuance, and VP submission processes.
Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.