AuthenticationAction.kt

/*
 * Copyright 2022 The Android Open Source Project
 *
 * 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.
 */
package androidx.credentials.provider
import android.annotation.SuppressLint
import android.app.PendingIntent
import android.app.slice.Slice
import android.app.slice.SliceSpec
import android.net.Uri
import android.os.Parcel
import android.os.Parcelable
import android.util.Log
import androidx.annotation.NonNull
import androidx.annotation.RequiresApi
import androidx.annotation.VisibleForTesting
import java.util.Collections

/**
 * An entry on the selector, denoting that the provider service is locked and authentication
 * is needed to proceed.
 *
 * Providers should set this entry when the provider app is locked, and no credentials can
 * be returned.
 * Providers must set the [PendingIntent] that leads to their unlock activity. When the user
 * selects this entry, the corresponding [PendingIntent] is fired and the unlock activity is
 * invoked. Once the provider authentication flow is complete, providers must set
 * the [android.service.credentials.CredentialsResponseContent] containing the unlocked credential
 * entries, through the [PendingIntentHandler.setCredentialsResponseContent] method, before
 * finishing the activity.
 * If providers fail to set the [android.service.credentials.CredentialsResponseContent], the
 * system will assume that there are no credentials available and the this entry will be removed
 * from the selector.
 *
 * @property pendingIntent the [PendingIntent] to be invoked if the user selects
 * this authentication entry on the UI.
 *
 * @see android.service.credentials.BeginGetCredentialResponse.createWithAuthentication
 * for usage details.
 *
 * @throws NullPointerException If the [pendingIntent] is null
 */
@RequiresApi(34)
class AuthenticationAction constructor(
    val pendingIntent: PendingIntent,
) : android.service.credentials.Action(
    toSlice(pendingIntent)) {

    override fun describeContents(): Int {
        return 0
    }

    override fun writeToParcel(@NonNull dest: Parcel, flags: Int) {
        super.writeToParcel(dest, flags)
    }
    @Suppress("AcronymName")
    companion object {
        private const val TAG = "AuthenticationAction"
        private const val SLICE_SPEC_REVISION = 0
        private const val SLICE_SPEC_TYPE = "AuthenticationAction"
        @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
        internal const val SLICE_HINT_PENDING_INTENT =
            "androidx.credentials.provider.authenticationAction.SLICE_HINT_PENDING_INTENT"

        /** @hide **/
        @JvmStatic
        fun toSlice(pendingIntent: PendingIntent): Slice {
            val sliceBuilder = Slice.Builder(Uri.EMPTY, SliceSpec(SLICE_SPEC_TYPE,
                SLICE_SPEC_REVISION))
            sliceBuilder.addAction(pendingIntent,
                Slice.Builder(sliceBuilder)
                    .addHints(Collections.singletonList(SLICE_HINT_PENDING_INTENT))
                    .build(),
                /*subType=*/null)
            return sliceBuilder.build()
        }

        /**
         * Returns an instance of [AuthenticationAction] derived from a [Slice] object.
         *
         * @param slice the [Slice] object that contains the information required for
         * constructing an instance of this class.
         *
         * @hide
         */
        @SuppressLint("WrongConstant") // custom conversion between jetpack and framework
        @JvmStatic
        fun fromSlice(slice: Slice): AuthenticationAction? {
            slice.items.forEach {
                if (it.hasHint(SLICE_HINT_PENDING_INTENT)) {
                    return try {
                        AuthenticationAction(it.action)
                    } catch (e: Exception) {
                        Log.i(TAG, "fromSlice failed with: " + e.message)
                        null
                    }
                }
            }
            return null
        }

        @JvmField val CREATOR: Parcelable.Creator<AuthenticationAction> = object :
        Parcelable.Creator<AuthenticationAction> {
            override fun createFromParcel(p0: Parcel?): AuthenticationAction? {
                val authAction =
                    android.service.credentials.Action.CREATOR.createFromParcel(p0)
                return fromSlice(authAction.slice)
            }

            @Suppress("ArrayReturn")
            override fun newArray(size: Int): Array<AuthenticationAction?> {
                return arrayOfNulls(size)
            }
        }
    }
}