Merge pull request #31 from VirgilSecurity/enclave

Added Secure Enclave module

Author: BuddahLD

build.gradle

@@ -44,7 +44,10 @@ buildscript {
             coroutines  : '1.3.0-M1',
 
             // Gradle
-            gardle      : '3.4.2',
+            gradle      : '3.4.2',
+
+            // Maven
+            mavenPublish: '3.6.2',
 
             // Android
             android     : '4.1.1.4',
@@ -63,15 +66,16 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath "com.android.tools.build:gradle:$versions.gardle"
+        classpath "com.android.tools.build:gradle:$versions.gradle"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$versions.kotlin"
         classpath "org.jetbrains.dokka:dokka-gradle-plugin:$versions.dokka"
-        classpath 'digital.wup:android-maven-publish:3.6.2'
+        classpath "digital.wup:android-maven-publish:$versions.mavenPublish"
     }
 }
 
 allprojects {
     repositories {
+        mavenLocal()
         google()
         jcenter()
         mavenCentral()

ethree-common/src/main/java/com/virgilsecurity/android/common/data/Const.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/Const.kt

@@ -31,7 +31,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.common.data
+package com.virgilsecurity.android.common
 
 /**
  * Const

ethree-kotlin/src/main/java/com/virgilsecurity/android/ethree/kotlin/callback/OnCompleteListener.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/callback/OnCompleteListener.kt

@@ -31,7 +31,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.callback
+package com.virgilsecurity.android.common.callback
 
 /**
  * Interface that is intended to signal if some asynchronous process is completed successfully

ethree-kotlin/src/main/java/com/virgilsecurity/android/ethree/kotlin/callback/OnGetTokenCallback.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/callback/OnGetTokenCallback.kt

@@ -31,7 +31,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.callback
+package com.virgilsecurity.android.common.callback
 
 /**
  * Interface that should provide Json Web Token when [onGetToken] callback is called.

ethree-kotlin/src/main/java/com/virgilsecurity/android/ethree/kotlin/callback/OnResultListener.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/callback/OnResultListener.kt

@@ -31,7 +31,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.callback
+package com.virgilsecurity.android.common.callback
 
 /**
  * Interface that is intended to return *<T>* type result if some asynchronous process is

ethree-common/src/main/java/com/virgilsecurity/android/common/data/model/LookupResult.kt

@@ -31,21 +31,17 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.interaction
-
-import android.content.Context
-import com.virgilsecurity.android.common.data.Const
-import com.virgilsecurity.android.common.data.Const.NO_CONTEXT
-import com.virgilsecurity.android.common.data.Const.VIRGIL_BASE_URL
-import com.virgilsecurity.android.common.data.Const.VIRGIL_CARDS_SERVICE_PATH
-import com.virgilsecurity.android.common.data.local.KeyManagerLocal
-import com.virgilsecurity.android.common.data.model.LookupResult
-import com.virgilsecurity.android.common.data.remote.KeyManagerCloud
+package com.virgilsecurity.android.common.interaction
+
+import com.virgilsecurity.android.common.Const
+import com.virgilsecurity.android.common.Const.NO_CONTEXT
+import com.virgilsecurity.android.common.Const.VIRGIL_BASE_URL
+import com.virgilsecurity.android.common.Const.VIRGIL_CARDS_SERVICE_PATH
 import com.virgilsecurity.android.common.exceptions.*
-import com.virgilsecurity.android.ethree.build.VersionVirgilAgent
-import com.virgilsecurity.android.ethree.kotlin.callback.OnGetTokenCallback
-import com.virgilsecurity.android.ethree.kotlin.model.Completable
-import com.virgilsecurity.android.ethree.kotlin.model.Result
+import com.virgilsecurity.android.common.model.Completable
+import com.virgilsecurity.android.common.model.LookupResult
+import com.virgilsecurity.android.common.model.Result
+import com.virgilsecurity.keyknox.build.VersionVirgilAgent
 import com.virgilsecurity.keyknox.exception.DecryptionFailedException
 import com.virgilsecurity.keyknox.exception.EntryAlreadyExistsException
 import com.virgilsecurity.pythia.brainkey.BrainKey
@@ -61,7 +57,6 @@ import com.virgilsecurity.sdk.crypto.VirgilCrypto
 import com.virgilsecurity.sdk.crypto.VirgilPrivateKey
 import com.virgilsecurity.sdk.crypto.VirgilPublicKey
 import com.virgilsecurity.sdk.exception.EmptyArgumentException
-import com.virgilsecurity.sdk.jwt.Jwt
 import com.virgilsecurity.sdk.jwt.accessProviders.CachingJwtProvider
 import com.virgilsecurity.sdk.jwt.contract.AccessTokenProvider
 import com.virgilsecurity.sdk.storage.DefaultKeyStorage
@@ -70,19 +65,20 @@ import java.io.InputStream
 import java.io.OutputStream
 
 /**
- * [EThree] class simplifies work with Virgil Services to easily implement End to End Encrypted
+ * [EThreeCore] class simplifies work with Virgil Services to easily implement End to End Encrypted
  * communication.
  */
-class EThree
+abstract class EThreeCore
 /**
- * @constructor Initializing [CardManager] with provided in [EThree.initialize] callback
+ * @constructor Initializing [CardManager] with provided in [EThreeCore.initialize] callback
  * [onGetTokenCallback] using [CachingJwtProvider] also initializing [DefaultKeyStorage] with
  * default settings.
- */ private constructor(context: Context, private val tokenProvider: AccessTokenProvider) {
+ */
+constructor(private val tokenProvider: AccessTokenProvider) {
 
     private val virgilCrypto = VirgilCrypto()
     private val cardManager: CardManager
-    private val keyManagerLocal: KeyManagerLocal
+    protected abstract val keyManagerLocal: KeyManagerLocal
     private val keyManagerCloud: KeyManagerCloud
 
     init {
@@ -94,38 +90,11 @@ class EThree
                         VirgilCardClient(VIRGIL_BASE_URL + VIRGIL_CARDS_SERVICE_PATH,
                                          httpClient))
         }
-        keyManagerLocal = KeyManagerLocal(tokenProvider.getToken(NO_CONTEXT).identity, context)
-        keyManagerCloud = KeyManagerCloud(currentIdentity(),
-                                          tokenProvider,
-                                          VersionVirgilAgent.VERSION)
-    }
-
-    companion object {
-        /**
-         * Current method allows you to initialize EThree helper class. To do this you
-         * should provide [onGetTokenCallback] that must return Json Web Token string
-         * representation with identity of the user which will use this class.
-         * In [onResultListener] you will receive instance of [EThree] class or an [Throwable]
-         * if something went wrong.
-         *
-         * To start execution of the current function, please see [Result] description.
-         */
-        @JvmStatic fun initialize(context: Context,
-                                  onGetTokenCallback: OnGetTokenCallback) = object : Result<EThree> {
-            override fun get(): EThree {
-                val tokenProvider = CachingJwtProvider(CachingJwtProvider.RenewJwtCallback {
-                    Jwt(onGetTokenCallback.onGetToken())
-                })
-
-                // Just check whether we can get token, otherwise there's no reasons to
-                // initialize EThree. We have caching JWT provider, so sequential calls
-                // won't take much time, as token will be cached after first call.
-                tokenProvider.getToken(NO_CONTEXT)
-                return EThree(context, tokenProvider)
-            }
-        }
 
-        private const val THROTTLE_TIMEOUT = 2 * 1000L // 2 seconds
+        keyManagerCloud = KeyManagerCloud(
+            currentIdentity(),
+            tokenProvider,
+            VersionVirgilAgent.VERSION)
     }
 
     /**
@@ -157,7 +126,7 @@ class EThree
 
     /**
      * Revokes the public key for current *identity* in Virgil's Cards Service. After this operation
-     * you can call [EThree.register] again.
+     * you can call [EThreeCore.register] again.
      *
      * To start execution of the current function, please see [Completable] description.
      *
@@ -606,7 +575,7 @@ class EThree
      * [PublicKey] in [onResultListener] callback or [Throwable] if something went wrong.
      *
      * [PublicKeyNotFoundException] will be thrown for the first not found public key.
-     * [EThree.register]
+     * [EThreeCore.register]
      *
      * Can be called only if private key is on the device, otherwise [PrivateKeyNotFoundException]
      * exception will be thrown.
@@ -679,4 +648,8 @@ class EThree
             "You have to get private key first. Use \'register\' " +
             "or \'restorePrivateKey\' functions.")
     }
+
+    companion object {
+        private const val THROTTLE_TIMEOUT = 2 * 1000L // 2 seconds
+    }
 }

ethree-kotlin/src/main/java/com/virgilsecurity/android/ethree/kotlin/interaction/EThree.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/interaction/EThreeCore.kt

@@ -31,10 +31,10 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.common.data.remote
+package com.virgilsecurity.android.common.interaction
 
-import com.virgilsecurity.android.common.data.Const
-import com.virgilsecurity.android.common.data.Const.VIRGIL_BASE_URL
+import com.virgilsecurity.android.common.Const
+import com.virgilsecurity.android.common.Const.VIRGIL_BASE_URL
 import com.virgilsecurity.keyknox.KeyknoxManager
 import com.virgilsecurity.keyknox.client.HttpClient
 import com.virgilsecurity.keyknox.client.KeyknoxClient
@@ -71,7 +71,7 @@ class KeyManagerCloud(
 
     fun exists(password: String) = initCloudKeyStorage(password).exists(identity)
 
-    fun store(password: String, data: ByteArray, meta: Map<String, String>? = null) =
+    fun store(password: String, data: ByteArray, meta: Map<String, String>?) =
             initCloudKeyStorage(password).store(identity, data, meta)
 
     fun retrieve(password: String) = initCloudKeyStorage(password).retrieve(identity)

ethree-common/src/main/java/com/virgilsecurity/android/common/data/remote/KeyManagerCloud.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/interaction/KeyManagerCloud.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2015-2019, Virgil Security, Inc.
+ *
+ * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     (1) Redistributions of source code must retain the above copyright notice, this
+ *     list of conditions and the following disclaimer.
+ *
+ *     (2) Redistributions in binary form must reproduce the above copyright notice,
+ *     this list of conditions and the following disclaimer in the documentation
+ *     and/or other materials provided with the distribution.
+ *
+ *     (3) Neither the name of virgil nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.virgilsecurity.android.common.interaction
+
+import com.virgilsecurity.sdk.storage.KeyEntry
+
+/**
+ * KeyManagerLocal
+ */
+interface KeyManagerLocal {
+
+    fun exists() : Boolean
+
+    fun store(privateKey: ByteArray)
+
+    fun load(): KeyEntry
+
+    fun delete()
+}

ethree-common/src/main/java/com/virgilsecurity/android/common/interaction/KeyManagerLocal.kt

@@ -31,9 +31,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.model
+package com.virgilsecurity.android.common.model
 
-import com.virgilsecurity.android.ethree.kotlin.callback.OnCompleteListener
+import com.virgilsecurity.android.common.callback.OnCompleteListener
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch

ethree-kotlin/src/main/java/com/virgilsecurity/android/ethree/kotlin/model/Completable.kt renamed to ethree-common/src/main/java/com/virgilsecurity/android/common/model/Completable.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2015-2019, Virgil Security, Inc.
+ *
+ * Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     (1) Redistributions of source code must retain the above copyright notice, this
+ *     list of conditions and the following disclaimer.
+ *
+ *     (2) Redistributions in binary form must reproduce the above copyright notice,
+ *     this list of conditions and the following disclaimer in the documentation
+ *     and/or other materials provided with the distribution.
+ *
+ *     (3) Neither the name of virgil nor the names of its
+ *     contributors may be used to endorse or promote products derived from
+ *     this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.virgilsecurity.android.common.model
+
+import com.virgilsecurity.sdk.crypto.VirgilPublicKey
+
+/**
+ * Lookup Result typealias to ease e3kit usage
+ */
+
+typealias LookupResult = Map<String, VirgilPublicKey>

ethree-common/src/main/java/com/virgilsecurity/android/common/model/LookupResult.kt

@@ -31,9 +31,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package com.virgilsecurity.android.ethree.kotlin.model
+package com.virgilsecurity.android.common.model
 
-import com.virgilsecurity.android.ethree.kotlin.callback.OnResultListener
+import com.virgilsecurity.android.common.callback.OnResultListener
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch