Switching authentication flows

AWSCognitoAuthPlugin allows you to switch between different auth flows while initiating signIn. You can configure the flow in the amplify_outputs.json file or pass the authFlowType as a runtime parameter to the signIn api call.

For client side authentication there are four different flows that can be configured during runtime:

1. userSRP: The userSRP flow uses the SRP protocol (Secure Remote Password) where the password never leaves the client and is unknown to the server. This is the recommended flow and is used by default.

2. userPassword: The userPassword flow will send user credentials unencrypted to the back-end. If you want to migrate users to Cognito using the "Migration" trigger and avoid forcing users to reset their passwords, you will need to use this authentication type because the Lambda function invoked by the trigger needs to verify the supplied credentials.

3. customWithSRP: The customWithSRP flow is used to start with SRP authentication and then switch to custom authentication. This is useful if you want to use SRP for the initial authentication and then use custom authentication for subsequent authentication attempts.

4. customWithoutSRP: The customWithoutSRP flow is used to start authentication flow WITHOUT SRP and then use a series of challenge and response cycles that can be customized to meet different requirements.

5. userAuth: The userAuth flow is a choice-based authentication flow that allows the user to choose from the list of available authentication methods. This flow is useful when you want to provide the user with the option to choose the authentication method. The choices that may be available to the user are emailOTP, smsOTP, webAuthn, password or passwordSRP.

Auth can be configured to use the different flows at runtime by calling signIn with AuthSignInOptions's authFlowType as AuthFlowType.userPassword, AuthFlowType.customAuthWithoutSrp or AuthFlowType.customAuthWithSrp. If you do not specify the AuthFlowType in AuthSignInOptions, the default flow (AuthFlowType.userSRP) will be used.

For more information about authentication flows, please visit Amazon Cognito developer documentation

USER_AUTH (Choice-based authentication) flow

A use case for the USER_AUTH authentication flow is to provide the user with the option to choose the authentication method. The choices that may be available to the user are emailOTP, smsOTP, webAuthn, password or passwordSRP.

let pluginOptions = AWSAuthSignInOptions(
    authFlowType: .userAuth)
let signInResult = try await Amplify.Auth.signIn(
    username: username,
    password: password,
    options: .init(pluginOptions: pluginOptions))
guard case .continueSignInWithFirstFactorSelection(let availableFactors) = signInResult.nextStep else {
    return
}
print("Available factors: \(availableFactors)")

The selection of the authentication method is done by the user. The user can choose from the available factors and proceed with the selected factor. You should call the confirmSignIn API with the selected factor to continue the sign-in process. Following is an example if you want to proceed with the emailOTP factor selection:

// Select emailOTP as the factor
var confirmSignInResult = try await Amplify.Auth.confirmSignIn(
    challengeResponse: AuthFactorType.emailOTP.challengeResponse)

USER_PASSWORD_AUTH flow

A use case for the USER_PASSWORD_AUTH authentication flow is migrating users into Amazon Cognito

A user migration Lambda trigger helps migrate users from a legacy user management system into your user pool. If you choose the USER_PASSWORD_AUTH authentication flow, users don't have to reset their passwords during user migration. This flow sends your user's password to the service over an encrypted SSL connection during authentication.

When you have migrated all your users, switch flows to the more secure SRP flow. The SRP flow doesn't send any passwords over the network.

func signIn(username: String, password: String) async throws {

    let option = AWSAuthSignInOptions(authFlowType: .userPassword)
    do {
        let result = try await Amplify.Auth.signIn(
            username: username,
            password: password,
            options: AuthSignInRequest.Options(pluginOptions: option))
        print("Sign in succeeded with result: \(result)")
    } catch {
        print("Failed to sign in with error: \(error)")
    }
}

Migrate users with Amazon Cognito

Amazon Cognito provides a trigger to migrate users from your existing user directory seamlessly into Cognito. You achieve this by configuring your User Pool's "Migration" trigger which invokes a Lambda function whenever a user that does not already exist in the user pool authenticates, or resets their password.

In short, the Lambda function will validate the user credentials against your existing user directory and return a response object containing the user attributes and status on success. An error message will be returned if an error occurs. There's documentation around how to set up this migration flow and more detailed instructions on how the lambda should handle request and response objects.

CUSTOM_AUTH flow

Amazon Cognito User Pools supports customizing the authentication flow to enable custom challenge types, in addition to a password in order to verify the identity of users. The custom authentication flow is a series of challenge and response cycles that can be customized to meet different requirements. These challenge types may include CAPTCHAs or dynamic challenge questions.

To define your challenges for custom authentication flow, you need to implement three Lambda triggers for Amazon Cognito.

The flow is initiated by calling signIn with AuthSignInOptions configured with AuthFlowType.customAuthWithSrp OR AuthFlowType.customAuthWithoutSrp.

Follow the instructions in Custom Auth Sign In to learn about how to integrate custom authentication flow in your application with the Auth APIs.