commonMain.com.twilio.passkeys.models.CreatePasskeyRequest.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twilio-verify-passkeys-common

Twilio Passkeys SDK enables developers to easily add Passkeys into their existing authentication flows within their own mobile applications. The Verify Passkeys SDK supports passkeys creation and authentication using the FIDO/WebAuthn industry standard.

The newest version!

/*
 * Copyright © 2024 Twilio Inc.
 *
 * 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 com.twilio.passkeys.models

import kotlinx.serialization.Serializable

/**
 * Represents a request for creating a passkey.
 *
 * @property challenge The challenge for the passkey creation.
 * @property rp The relying party (RP) information.
 * @property user The user information.
 * @property pubKeyCredParams The list of public key credential parameters.
 * @property timeout The timeout value for the passkey creation.
 * @property attestation The attestation type for the passkey creation.
 * @property excludeCredentials The list of key credentials to exclude.
 * @property authenticatorSelection The authenticator selection criteria.
 */
@Serializable
data class CreatePasskeyRequest(
  var challenge: String,
  val rp: Rp,
  val user: User,
  val pubKeyCredParams: List,
  val timeout: Long,
  val attestation: String? = null,
  val excludeCredentials: List? = null,
  val authenticatorSelection: AuthenticatorSelection,
)

/**
 * Represents relying party (RP) information.
 *
 * @property name The name of the relying party.
 * @property id The identifier of the relying party.
 * @property icon The icon URL of the relying party.
 */
@Serializable
data class Rp(
  val name: String,
  val id: String,
  val icon: String?,
)

/**
 * Represents user information.
 *
 * @property id The identifier of the user.
 * @property icon The icon URL of the user.
 * @property name The name of the user.
 * @property displayName The display name of the user.
 */
@Serializable
data class User(
  var id: String,
  var icon: String?,
  val name: String,
  val displayName: String?,
)

/**
 * Represents public key credential parameters.
 *
 * @property type The type of the public key credential.
 * @property alg The algorithm used by the public key credential.
 */
@Serializable
data class PubKeyCredParams(
  val type: String,
  val alg: Int,
)

/**
 * Represents authenticator selection criteria.
 *
 * @property authenticatorAttachment The authenticator attachment type.
 * @property requireResidentKey Specifies whether a resident key is required.
 * @property residentKey The resident key.
 * @property userVerification The user verification method.
 */
@Serializable
data class AuthenticatorSelection(
  val authenticatorAttachment: String?,
  val requireResidentKey: Boolean?,
  val residentKey: String? = null,
  val userVerification: String?,
)