Wear os authentication (#1691)

* Initial proof-of-concept: sharing Session over data layer

* Add initial onboarding and login flow

In onboarding, the home assistant urls are received from connected devices. If the user clicks on it, the authentication flow starts.
The user can alter the login details and proceed to login.
The authentication uses the "auth/login_flow" api, instead of the normal authentication api, since there is no support for webview on wear os.

* Clean up wear and app communication

Clean up

* Add proof of authentication on home. And add logout button on home

* Update onboarding list

* Add loading views and error messages

* Move startup logic to HomeActivity to hopefully save some resources

* Add manual setup option and improve UI

* Cleanup

* Passing ktLintCheck

* Passing ktLintCheck after rebase

* Fix building after build.gradle changes during rebase

* Process review comments

Remove multiple product flavors
Remove unnecessary log
Replace margin with additional header

.gitignore

@@ -7,3 +7,4 @@ google-services.json
 .idea/
 .gradle/
 build/
+*.keystore

app/build.gradle.kts

@@ -145,6 +145,8 @@ dependencies {
     implementation("androidx.navigation:navigation-ui-ktx:2.3.5")
     implementation("com.google.android.material:material:1.4.0")
 
+    implementation("com.google.android.gms:play-services-wearable:17.1.0")
+
     implementation("androidx.room:room-runtime:2.3.0")
     implementation("androidx.room:room-ktx:2.3.0")
     kapt("androidx.room:room-compiler:2.3.0")

app/src/main/AndroidManifest.xml

@@ -231,6 +231,15 @@
         <activity
             android:name=".onboarding.OnboardingActivity"
             android:configChanges="orientation|screenSize|keyboardHidden" />
+
+        <service android:name=".onboarding.WearOnboardingListener">
+            <intent-filter>
+                <action android:name="com.google.android.gms.wearable.MESSAGE_RECEIVED" />
+                <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
+                <data android:scheme="wear" android:host="*"
+                    android:path="/request_home_assistant_instance" />
+            </intent-filter>
+        </service>
 
         <activity
             android:name=".webview.WebViewActivity"

app/src/main/java/io/homeassistant/companion/android/onboarding/OnboardingListenerComponent.kt

@@ -0,0 +1,10 @@
+package io.homeassistant.companion.android.onboarding
+
+import dagger.Component
+import io.homeassistant.companion.android.common.dagger.AppComponent
+
+@Component(dependencies = [AppComponent::class])
+interface OnboardingListenerComponent {
+
+    fun inject(listener: WearOnboardingListener)
+}

app/src/main/java/io/homeassistant/companion/android/onboarding/WearOnboardingListener.kt

@@ -0,0 +1,57 @@
+package io.homeassistant.companion.android.onboarding
+
+import android.util.Log
+import com.google.android.gms.wearable.MessageEvent
+import com.google.android.gms.wearable.PutDataMapRequest
+import com.google.android.gms.wearable.PutDataRequest
+import com.google.android.gms.wearable.Wearable
+import com.google.android.gms.wearable.WearableListenerService
+import io.homeassistant.companion.android.common.dagger.GraphComponentAccessor
+import io.homeassistant.companion.android.common.data.authentication.AuthenticationRepository
+import io.homeassistant.companion.android.common.data.url.UrlRepository
+import kotlinx.coroutines.runBlocking
+import javax.inject.Inject
+
+class WearOnboardingListener : WearableListenerService() {
+
+    @Inject
+    lateinit var authenticationUseCase: AuthenticationRepository
+
+    @Inject
+    lateinit var urlUseCase: UrlRepository
+
+    override fun onCreate() {
+        super.onCreate()
+        DaggerOnboardingListenerComponent.builder()
+            .appComponent((applicationContext.applicationContext as GraphComponentAccessor).appComponent)
+            .build()
+            .inject(this)
+    }
+
+    override fun onMessageReceived(event: MessageEvent) {
+        Log.d("WearOnboardingListener", "onMessageReceived: $event")
+
+        if (event.path == "/request_home_assistant_instance") {
+            val nodeId = event.sourceNodeId
+            sendHomeAssistantInstance(nodeId)
+        }
+    }
+
+    private fun sendHomeAssistantInstance(nodeId: String) = runBlocking {
+        Log.d("WearOnboardingListener", "sendHomeAssistantInstance: $nodeId")
+        // Retrieve current instance
+        val url = urlUseCase.getUrl()
+
+        // Put as DataMap in data layer
+        val putDataReq: PutDataRequest = PutDataMapRequest.create("/home_assistant_instance").run {
+            dataMap.putString("name", url?.host.toString())
+            dataMap.putString("url", url.toString())
+            setUrgent()
+            asPutDataRequest()
+        }
+        Wearable.getDataClient(this@WearOnboardingListener).putDataItem(putDataReq).apply {
+            addOnSuccessListener { Log.d("WearOnboardingListener", "sendHomeAssistantInstance: success") }
+            addOnFailureListener { Log.d("WearOnboardingListener", "sendHomeAssistantInstance: failed") }
+        }
+    }
+}

app/src/main/res/layout/fragment_mobile_app_integration.xml

@@ -31,8 +31,7 @@
                 <com.google.android.material.textfield.TextInputEditText
                     android:id="@+id/deviceName"
                     android:layout_width="match_parent"
-                    android:layout_height="wrap_content"
-                    />
+                    android:layout_height="wrap_content" />
 
             </com.google.android.material.textfield.TextInputLayout>
 

app/src/main/res/values/wear.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources xmlns:tools="http://schemas.android.com/tools"
+    tools:keep="@array/android_wear_capabilities">
+    <string-array name="android_wear_capabilities">
+        <item>request_authentication_token</item>
+        <item>request_home_assistant_instance</item>
+    </string-array>
+</resources>

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/AuthenticationRepository.kt

@@ -1,9 +1,15 @@
 package io.homeassistant.companion.android.common.data.authentication
 
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowCreateEntry
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowInit
 import java.net.URL
 
 interface AuthenticationRepository {
 
+    suspend fun initiateLoginFlow(): LoginFlowInit
+
+    suspend fun loginAuthentication(flowId: String, username: String, password: String): LoginFlowCreateEntry
+
     suspend fun registerAuthorizationCode(authorizationCode: String)
 
     suspend fun retrieveExternalAuthentication(forceRefresh: Boolean): String

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/AuthenticationRepositoryImpl.kt

@@ -5,6 +5,10 @@ import io.homeassistant.companion.android.common.data.LocalStorage
 import io.homeassistant.companion.android.common.data.authentication.AuthenticationRepository
 import io.homeassistant.companion.android.common.data.authentication.AuthorizationException
 import io.homeassistant.companion.android.common.data.authentication.SessionState
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowAuthentication
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowCreateEntry
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowInit
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowRequest
 import io.homeassistant.companion.android.common.data.url.UrlRepository
 import okhttp3.HttpUrl.Companion.toHttpUrlOrNull
 import java.net.URL
@@ -26,6 +30,27 @@ class AuthenticationRepositoryImpl @Inject constructor(
         private const val PREF_BIOMETRIC_ENABLED = "biometric_enabled"
     }
 
+    override suspend fun initiateLoginFlow(): LoginFlowInit {
+        return authenticationService.initializeLogin(
+            LoginFlowRequest(
+                AuthenticationService.CLIENT_ID,
+                AuthenticationService.AUTH_CALLBACK,
+                AuthenticationService.HANDLER
+            )
+        )
+    }
+
+    override suspend fun loginAuthentication(flowId: String, username: String, password: String): LoginFlowCreateEntry {
+        return authenticationService.authenticate(
+            AuthenticationService.AUTHENTICATE_BASE_PATH + flowId,
+            LoginFlowAuthentication(
+                AuthenticationService.CLIENT_ID,
+                username,
+                password
+            )
+        )
+    }
+
     override suspend fun registerAuthorizationCode(authorizationCode: String) {
         authenticationService.getToken(
             AuthenticationService.GRANT_TYPE_CODE,

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/AuthenticationService.kt

@@ -1,10 +1,16 @@
 package io.homeassistant.companion.android.common.data.authentication.impl
 
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowAuthentication
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowCreateEntry
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowInit
+import io.homeassistant.companion.android.common.data.authentication.impl.entities.LoginFlowRequest
 import io.homeassistant.companion.android.common.data.authentication.impl.entities.Token
 import retrofit2.Response
+import retrofit2.http.Body
 import retrofit2.http.Field
 import retrofit2.http.FormUrlEncoded
 import retrofit2.http.POST
+import retrofit2.http.Url
 
 interface AuthenticationService {
 
@@ -13,6 +19,9 @@ interface AuthenticationService {
         const val GRANT_TYPE_CODE = "authorization_code"
         const val GRANT_TYPE_REFRESH = "refresh_token"
         const val REVOKE_ACTION = "revoke"
+        val HANDLER = listOf("homeassistant", null)
+        const val AUTHENTICATE_BASE_PATH = "auth/login_flow/"
+        const val AUTH_CALLBACK = "homeassistant://auth-callback"
     }
 
     @FormUrlEncoded
@@ -37,4 +46,10 @@ interface AuthenticationService {
         @Field("token") refreshToken: String,
         @Field("action") action: String
     )
+
+    @POST("auth/login_flow")
+    suspend fun initializeLogin(@Body body: LoginFlowRequest): LoginFlowInit
+
+    @POST
+    suspend fun authenticate(@Url url: String, @Body body: LoginFlowAuthentication): LoginFlowCreateEntry
 }

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/entities/LoginFlowAuthentication.kt

@@ -0,0 +1,12 @@
+package io.homeassistant.companion.android.common.data.authentication.impl.entities
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class LoginFlowAuthentication(
+    @JsonProperty("client_id")
+    val clientId: String,
+    @JsonProperty("username")
+    val userName: String,
+    @JsonProperty("password")
+    val password: String
+)

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/entities/LoginFlowCreateEntry.kt

@@ -0,0 +1,14 @@
+package io.homeassistant.companion.android.common.data.authentication.impl.entities
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class LoginFlowCreateEntry(
+    @JsonProperty("version")
+    val version: Int,
+    @JsonProperty("type")
+    val type: String,
+    @JsonProperty("flow_id")
+    val flowId: String,
+    @JsonProperty("result")
+    val result: String
+)

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/entities/LoginFlowInit.kt

@@ -0,0 +1,14 @@
+package io.homeassistant.companion.android.common.data.authentication.impl.entities
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class LoginFlowInit(
+    @JsonProperty("type")
+    val type: String,
+    @JsonProperty("flow_id")
+    val flowId: String,
+    @JsonProperty("step_id")
+    val stepId: String,
+    @JsonProperty("errors")
+    val errors: Map<String, String>
+)

common/src/main/java/io/homeassistant/companion/android/common/data/authentication/impl/entities/LoginFlowRequest.kt

@@ -0,0 +1,12 @@
+package io.homeassistant.companion.android.common.data.authentication.impl.entities
+
+import com.fasterxml.jackson.annotation.JsonProperty
+
+data class LoginFlowRequest(
+    @JsonProperty("client_id")
+    val clientId: String,
+    @JsonProperty("redirect_uri")
+    val redirectUri: String,
+    @JsonProperty("handler")
+    val handler: List<String?>
+)

wear/build.gradle.kts

@@ -53,6 +53,7 @@ android {
             signingConfig = signingConfigs.getByName("release")
         }
     }
+
     kotlinOptions {
         jvmTarget = "11"
     }
@@ -65,9 +66,15 @@ android {
 dependencies {
     implementation(project(":common"))
 
+    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.1")
+
     implementation("com.google.android.material:material:1.4.0")
 
     implementation("androidx.wear:wear:1.1.0")
     implementation("com.google.android.support:wearable:2.8.1")
+    implementation("com.google.android.gms:play-services-wearable:17.1.0")
     compileOnly("com.google.android.wearable:wearable:2.8.1")
+
+    implementation("com.google.dagger:dagger:2.38.1")
+    kapt("com.google.dagger:dagger-compiler:2.38.1")
 }

wear/src/main/AndroidManifest.xml

@@ -2,11 +2,13 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="io.homeassistant.companion.android">
 
+    <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
 
     <uses-feature android:name="android.hardware.type.watch" />
 
     <application
+        android:name=".HomeAssistantApplication"
         android:allowBackup="true"
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
@@ -17,23 +19,26 @@
             android:name="com.google.android.wearable"
             android:required="true" />
 
-        <!--
-               Set to true if your app is Standalone, that is, it does not require the handheld
-               app to run.
-        -->
+        <!-- The app can run without a connected phone -->
         <meta-data
             android:name="com.google.android.wearable.standalone"
             android:value="true" />
 
-        <activity
-            android:name=".Home"
-            android:label="@string/app_name">
+        <activity android:name=".home.HomeActivity"
+            android:label="@string/app_name"
+            android:exported="true">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
-
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+        <activity android:name=".onboarding.OnboardingActivity" />
+        <activity android:name=".onboarding.integration.MobileAppIntegrationActivity" />
+        <activity android:name=".onboarding.authentication.AuthenticationActivity" />
+        <activity android:name=".onboarding.manual_setup.ManualSetupActivity" />
+
+        <!-- To show confirmations and failures -->
+        <activity android:name="androidx.wear.activity.ConfirmationActivity" />
     </application>
 
 </manifest>

wear/src/main/java/io/homeassistant/companion/android/HomeAssistantApplication.kt

@@ -0,0 +1,20 @@
+package io.homeassistant.companion.android
+
+import android.app.Application
+import io.homeassistant.companion.android.common.dagger.AppComponent
+import io.homeassistant.companion.android.common.dagger.Graph
+import io.homeassistant.companion.android.common.dagger.GraphComponentAccessor
+
+open class HomeAssistantApplication : Application(), GraphComponentAccessor {
+
+    lateinit var graph: Graph
+
+    override fun onCreate() {
+        super.onCreate()
+
+        graph = Graph(this, 0)
+    }
+
+    override val appComponent: AppComponent
+        get() = graph.appComponent
+}