credentials/credentials/src/main/java/androidx/credentials/PublicKeyCredential.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

import android.os.Bundle
import androidx.credentials.internal.FrameworkClassParsingException
import androidx.credentials.internal.RequestValidationHelper

/**
 * Represents the user's passkey credential granted by the user for app sign-in.
 *
 * @property authenticationResponseJson the public key credential authentication response in JSON
 *   format that follows the standard webauthn json format shown at
 *   [this w3c link](https://w3c.github.io/webauthn/#dictdef-authenticationresponsejson)
 */
class PublicKeyCredential
private constructor(
    val authenticationResponseJson: String,
    data: Bundle,
) : Credential(TYPE_PUBLIC_KEY_CREDENTIAL, data) {

    /**
     * Constructs a [PublicKeyCredential].
     *
     * @param authenticationResponseJson the public key credential authentication response in JSON
     *   format that follows the standard webauthn json format shown at
     *   [this w3c link](https://w3c.github.io/webauthn/#dictdef-authenticationresponsejson)
     * @throws NullPointerException If [authenticationResponseJson] is null
     * @throws IllegalArgumentException If [authenticationResponseJson] is empty, or if it is not a
     *   valid JSON
     */
    constructor(
        authenticationResponseJson: String
    ) : this(authenticationResponseJson, toBundle(authenticationResponseJson))

    init {
        require(RequestValidationHelper.isValidJSON(authenticationResponseJson)) {
            "authenticationResponseJson must not be empty, and must be a valid JSON"
        }
    }

    /** Companion constants / helpers for [PublicKeyCredential]. */
    companion object {
        /** The type value for public key credential related operations. */
        const val TYPE_PUBLIC_KEY_CREDENTIAL: String =
            "androidx.credentials.TYPE_PUBLIC_KEY_CREDENTIAL"

        /** The Bundle key value for the public key credential subtype (privileged or regular). */
        internal const val BUNDLE_KEY_SUBTYPE = "androidx.credentials.BUNDLE_KEY_SUBTYPE"
        internal const val BUNDLE_KEY_AUTHENTICATION_RESPONSE_JSON =
            "androidx.credentials.BUNDLE_KEY_AUTHENTICATION_RESPONSE_JSON"

        @JvmStatic
        internal fun toBundle(authenticationResponseJson: String): Bundle {
            val bundle = Bundle()
            bundle.putString(BUNDLE_KEY_AUTHENTICATION_RESPONSE_JSON, authenticationResponseJson)
            return bundle
        }

        @JvmStatic
        internal fun createFrom(data: Bundle): PublicKeyCredential {
            try {
                val authenticationResponseJson =
                    data.getString(BUNDLE_KEY_AUTHENTICATION_RESPONSE_JSON)
                return PublicKeyCredential(authenticationResponseJson!!, data)
            } catch (e: Exception) {
                throw FrameworkClassParsingException()
            }
        }
    }
}