SignIn code for Native Auth

msal/src/main/java/com/microsoft/identity/client/INativeAuthPublicClientApplication.kt

@@ -23,9 +23,12 @@
 package com.microsoft.identity.client
 
 import com.microsoft.identity.client.exception.MsalException
+import com.microsoft.identity.client.statemachine.results.SignInResult
+import com.microsoft.identity.client.statemachine.results.SignInUsingPasswordResult
+import com.microsoft.identity.client.statemachine.states.AccountResult
 
 /**
- * INativeAuthPublicClientApplication provides top level interface that is used by dpp developers
+ * INativeAuthPublicClientApplication provides top level interface that is used by app developers
  * to use Native Auth methods.
  */
 interface INativeAuthPublicClientApplication : IPublicClientApplication {
@@ -43,4 +46,16 @@ interface INativeAuthPublicClientApplication : IPublicClientApplication {
          */
         fun onError(exception: MsalException)
     }
+
+    suspend fun getCurrentAccount(): AccountResult?
+
+    fun getCurrentAccount(callback: NativeAuthPublicClientApplication.GetCurrentAccountCallback)
+
+    suspend fun signIn(username: String, scopes: List<String>? = null): SignInResult
+
+    fun signIn(username: String, scopes: List<String>? = null, callback: NativeAuthPublicClientApplication.SignInCallback)
+
+    suspend fun signInUsingPassword(username: String, password: String, scopes: List<String>? = null): SignInUsingPasswordResult
+
+    fun signInUsingPassword(username: String, password: String, scopes: List<String>? = null, callback: NativeAuthPublicClientApplication.SignInUsingPasswordCallback)
 }

msal/src/main/java/com/microsoft/identity/client/NativeAuthPublicClientApplicationConfiguration.kt

@@ -46,8 +46,8 @@ class NativeAuthPublicClientApplicationConfiguration :
     Serializable {
     companion object {
         private val TAG = NativeAuthPublicClientApplicationConfiguration::class.java.simpleName
-        private val VALID_CHALLENGE_TYPES = listOf(NativeAuthConstants.GrantType.PASSWORD,
-            NativeAuthConstants.GrantType.OOB, NativeAuthConstants.GrantType.REDIRECT)
+        private val VALID_CHALLENGE_TYPES = listOf(NativeAuthConstants.ChallengeType.PASSWORD,
+            NativeAuthConstants.ChallengeType.OOB, NativeAuthConstants.ChallengeType.REDIRECT)
     }
 
     private object NativeAuthSerializedNames {
@@ -57,7 +57,7 @@ class NativeAuthPublicClientApplicationConfiguration :
     }
 
     //List of challenge types supported by the client.
-    //For a complete list of challenge types see [NativeAuthConstants.GrantType]
+    //For a complete list of challenge types see [NativeAuthConstants.ChallengeType]
     @SerializedName(NativeAuthSerializedNames.CHALLENGE_TYPES)
     private var challengeTypes: List<String>? = null
 

msal/src/main/java/com/microsoft/identity/client/exception/MsalUserNotFoundException.java

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package com.microsoft.identity.client.exception;
+
+public class MsalUserNotFoundException extends MsalException {
+    private final static String USER_NOT_FOUND_ERROR_CODE = "user_not_found";
+
+    public MsalUserNotFoundException() {
+        super(USER_NOT_FOUND_ERROR_CODE, "No user found in cache");
+    }
+}

msal/src/main/java/com/microsoft/identity/client/statemachine/Error.kt

@@ -34,14 +34,14 @@ sealed class Error(
 /**
  * GeneralError is a base class for all errors present in the Native Auth.
  */
-sealed class GeneralError(
-    open var error: String? = null,
-    open val errorMessage: String? = "An unexpected error happened",
-    open val correlationId: String,
-    open val errorCodes: List<Int>? = null,
-    open var exception: Exception? = null
-)
-
+class GeneralError(
+    override var error: String? = null,
+    override val errorMessage: String? = "An unexpected error happened",
+    override val correlationId: String,
+    val details: List<Map<String, String>>? = null,
+    override val errorCodes: List<Int>? = null,
+    override var exception: Exception? = null
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId, exception = exception)
 
 /**
  * BrowserRequiredError occurs when authentication cannot be performed via means of Native Auth and
@@ -51,7 +51,7 @@ class BrowserRequiredError(
     override var error: String? = null,
     override val errorMessage: String = "The client's authentication capabilities are insufficient. Please redirect to the browser to complete authentication",
     override val correlationId: String
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId)
 
 /**
  * IncorrectCodeError occurs when the user has provided incorrect code for out of band authentication.
@@ -61,7 +61,7 @@ class IncorrectCodeError(
     override val errorMessage: String,
     override val correlationId: String,
     override val errorCodes: List<Int>? = null
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
 
 /**
  * UserNotFoundError occurs when the user could not be located in the given the username. The authentication
@@ -72,7 +72,7 @@ class UserNotFoundError(
     override val errorMessage: String,
     override val correlationId: String,
     override val errorCodes: List<Int>? = null
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
 
 /**
  * PasswordIncorrectError occurs when the user has provided incorrect password for signin.
@@ -82,7 +82,7 @@ class PasswordIncorrectError(
     override val errorMessage: String,
     override val correlationId: String,
     override val errorCodes: List<Int>
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId, errorCodes = errorCodes)
 
 /**
  * UserAlreadyExistsError has used a username to create an exists for which there is a pre-existing
@@ -92,7 +92,7 @@ class UserAlreadyExistsError(
     override var error: String? = null,
     override val errorMessage: String,
     override val correlationId: String
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId)
 
 /**
  * InvalidPasswordError is seen in Signup process when a user provides a password that does not
@@ -102,7 +102,7 @@ class InvalidPasswordError(
     override var error: String? = null,
     override val errorMessage: String,
     override val correlationId: String
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId)
 
 /**
  * InvalidPasswordError is seen in Signup process when a user provides a email address that is not
@@ -112,7 +112,7 @@ class InvalidEmailError(
     override var error: String? = null,
     override val errorMessage: String,
     override val correlationId: String
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId)
 
 /**
  * InvalidAttributesError is seen in Signup process when a user provides attributes that are not
@@ -122,4 +122,4 @@ class InvalidAttributesError(
     override var error: String? = null,
     override val errorMessage: String,
     override val correlationId: String
-) : GeneralError(errorMessage = errorMessage, error = error, correlationId = correlationId)
+) : Error(errorMessage = errorMessage, error = error, correlationId = correlationId)

msal/src/main/java/com/microsoft/identity/client/statemachine/results/BaseResults.kt

@@ -0,0 +1,61 @@
+// ktlint-disable filename
+
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files(the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions :
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+package com.microsoft.identity.client.statemachine.results
+
+import com.microsoft.identity.client.statemachine.Error
+import com.microsoft.identity.client.statemachine.states.State
+
+interface Result {
+    open class SuccessResult(open val nextState: State) : Result
+    open class ErrorResult(open val error: Error) : Result
+    open class CompleteResult(open val resultValue: Any? = null) : Result
+    open class CompleteWithNextStateResult(override val resultValue: Any? = null, open val nextState: State?) : CompleteResult(resultValue = resultValue)
+
+    fun isSuccess(): Boolean = this is SuccessResult
+    fun isError(): Boolean = this is ErrorResult
+    fun isComplete(): Boolean = this is CompleteResult
+}
+
+/**
+ * Sign out: removes account from cache. Does not perform single sign-out.
+ */
+sealed interface SignOutResult : Result {
+    /**
+     * CompleteResult Result, which indicates the sign out flow completed successfully.
+     * i.e. the user account has been removed from persistence.
+     */
+    object Complete :
+        Result.CompleteResult(resultValue = null),
+        SignOutResult
+
+    /**
+     * UnexpectedError ErrorResult, which indicates that an unexpected error occurred during sign out.
+     *
+     * @param error [com.microsoft.identity.client.statemachine.Error]
+     */
+    class UnexpectedError(override val error: Error) :
+        Result.ErrorResult(error = error),
+        SignOutResult
+}