Skip to content
SDK for social seed recovery
Java
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ZionSkrSdk
app
gradle/wrapper
libs
media
.gitignore
.travis.yml
.travis.yml
LICENSE
README.md Update README.md Aug 5, 2019
build.gradle
gradle.properties Update SKR SDK 1.0.0 Jul 19, 2019
gradlew Update SKR SDK 1.0.0 Jul 19, 2019
gradlew.bat Update SKR SDK 1.0.0 Jul 19, 2019
settings.gradle

README.md

Zion Social Key Recovery SDK

Build Status

Introduction

Zion Social Key Recovery SDK (Zion-SKR-SDK) is an Android library that provides Java APIs for developers to integrate HTC Zion Vault's Social Key Recovery (SKR) feature into their apps. 3rd party apps integrating Zion-SKR-SDK will be able to use SKR to backup or restore their hierarchical deterministic (HD) wallet seed on HTC EXODUS phones. For details about SKR, see the HTC EXODUS official website at the link below.
https://www.htcexodus.com/us/support/exodus-one/faq/what-is-social-key-recovery-and-why-use-it.html

SDK

Architecture

The architecture diagram below illustrates component interaction in Social Key Recovery.

Architecture

  • Wallet app

  • TrustZone

    A trusted execution environment (TEE) is a secure area of a main processor. It guarantees code and data loaded inside to be protected with respect to confidentiality and integrity[clarification needed].[1] A TEE as an isolated execution environment provides security features such as isolated execution, integrity of applications executing with the TEE, along with confidentiality of their assets.[2] In general terms, the TEE offers an execution space that provides a higher level of security[for whom?] than a rich mobile operating system open (mobile OS) and more functionality than a 'secure element' (SE).[3]

    • The user's seed is stored securely in the TrustZone.
    • Seed splitting and sharing uses Shamir's secret sharing, implemented inside the TrustZone. SSS implementation uses SSS from dsprenkels.
    • Only encrypted partial seeds will be sent to Android.
  • Cloud storage

    • The user's trusted contact list is saved with cloud storage. Its purpose is to remind the user who they have asked to help backup.
  • Cloud messaging

    • Data exchange uses cloud messaging. Currently, this is implemented with Firebase Cloud Messaging (FCM).
  • Deep links

    • Deep links are used for initial connection set up. Currently, this is implemented with Firebase Dynamic Links.

Flow

Sequence diagram describing the partial seed backup flow with friend.
Backup Sequence diagram describing the partial seed restore flow with friend. Restore

Usage

  1. Integration guide for using Zion-SKR-SDK to backup and restore seeds on an HTC EXODUS:
  1. Applying and integrating related cloud services:
  1. Applying for HTC Public Key Server access:
    Send an email to Hank_Chiu@htc.com with the following information:
  • Full name, e.g., Hank Chiu
  • Company name, e.g., HTC
  • Email address
  • App name, e.g., HTC Zion
  • App's package name, e.g., "com.htc.wallet"
  • App's SHA256 signature (Base64 encoded), e.g., xpghBVzbMWoosDUOJl1/trHXXlSBBilUanBSiwVe/rk=
# keytool -list -printcert -jarfile app-partner-release.apk  
 ...
  SHA256: C6:98:21:05:5C:DB:31:6A:28:B0:35:0E:26:5D:7F:B6:B1:D7:5E:54:81:06:29:54:6A:70:52:8B:05:5E:FE:B9
 ...
# echo "C6:98:21:05:5C:DB:31:6A:28:B0:35:0E:26:5D:7F:B6:B1:D7:5E:54:81:06:29:54:6A:70:52:8B:05:5E:FE:B9" | xxd -r -p | base64  
 xpghBVzbMWoosDUOJl1/trHXXlSBBilUanBSiwVe/rk=

Gradle plugin integration

  1. Copy the .aar file into your app project library path:
    <Project Name>\app\libs\ZionSkrSdk-release.aar
  2. Add following dependency to your build.gradle:
dependencies {
  implementation(name: 'ZionSkrSdk-release', ext: 'aar')     
}

For details, refer to https://github.com/htczion/Zion-SKR-SDK/wiki.

License

Copyright (c) 2019 HTC Corporation. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.