commonMain.com.twilio.passkeys.PasskeyPayloadMapper.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

import com.twilio.passkeys.exception.TwilioException
import com.twilio.passkeys.extensions.b64Decode
import com.twilio.passkeys.extensions.b64Encode
import com.twilio.passkeys.models.AuthenticatePasskeyDto
import com.twilio.passkeys.models.AuthenticatePasskeyRequest
import com.twilio.passkeys.models.AuthenticatePasskeyResponse
import com.twilio.passkeys.models.CreatePasskeyDto
import com.twilio.passkeys.models.CreatePasskeyRequest
import com.twilio.passkeys.models.CreatePasskeyResponse
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.SerializationException
import kotlinx.serialization.json.Json

/**
 * Object responsible for mapping passkey-related payloads and responses.
 * This object provides methods for mapping passkey creation and authentication payloads,
 * as well as mapping creation and authentication responses.
 */
internal object PasskeyPayloadMapper {
  /**
   * JSON parser configured for passkey-related operations.
   */
  @OptIn(ExperimentalSerializationApi::class)
  private val json =
    Json {
      ignoreUnknownKeys = true
      explicitNulls = false
    }

  /**
   * Maps a create payload JSON to a [CreatePasskeyRequest].
   *
   * @param createPayload The payload containing the create passkey information.
   * @return The passkey creation request mapped from the provided payload.
   */
  fun mapToCreatePasskeyRequest(createPayload: String): CreatePasskeyRequest {
    val createPasskeyRequest = json.decodeFromString(createPayload)
    createPasskeyRequest.apply {
      challenge = challenge.b64Decode().b64Encode()
      user.id = user.id.b64Decode().b64Encode()
    }
    return createPasskeyRequest
  }

  /**
   * Maps a authenticate payload JSON to a [AuthenticatePasskeyRequest].
   *
   * @param authenticatePayload The payload containing the authenticate passkey information.
   * @return The passkey authentication request mapped from the provided payload.
   */
  fun mapToAuthenticatePasskeyRequest(authenticatePayload: String): AuthenticatePasskeyRequest {
    val authenticatePasskeyRequest =
      json.decodeFromString(authenticatePayload)
    authenticatePasskeyRequest.publicKey.apply {
      challenge = challenge.b64Decode().b64Encode()
    }
    return authenticatePasskeyRequest
  }

  /**
   * Maps a registration result JSON to a [CreatePasskeyResponse].
   *
   * @param registrationResultJson The JSON string containing registration result information.
   * @return The passkey creation response mapped from the provided JSON.
   */
  fun mapToCreatePasskeyResponse(registrationResultJson: String): CreatePasskeyResponse {
    val createPasskeyDto = json.decodeFromString(registrationResultJson)
    return CreatePasskeyResponse(
      id = createPasskeyDto.id,
      rawId = createPasskeyDto.rawId,
      authenticatorAttachment = createPasskeyDto.authenticatorAttachment,
      type = createPasskeyDto.type,
      attestationObject = createPasskeyDto.response.attestationObject,
      clientDataJSON = createPasskeyDto.response.clientDataJSON,
      transports = createPasskeyDto.response.transports,
    )
  }

  /**
   * Maps an authentication result JSON to a [AuthenticatePasskeyResponse].
   *
   * @param authenticatePasskeyResultJson The JSON string containing authentication result information.
   * @return The passkey authentication response mapped from the provided JSON.
   */
  fun mapToAuthenticatePasskeyResponse(authenticatePasskeyResultJson: String): AuthenticatePasskeyResponse {
    val authenticatePasskeyDto =
      json.decodeFromString(authenticatePasskeyResultJson)
    return AuthenticatePasskeyResponse(
      id = authenticatePasskeyDto.id,
      rawId = authenticatePasskeyDto.rawId,
      authenticatorAttachment = authenticatePasskeyDto.authenticatorAttachment,
      type = authenticatePasskeyDto.type,
      clientDataJSON = authenticatePasskeyDto.response.clientDataJSON,
      authenticatorData = authenticatePasskeyDto.response.authenticatorData,
      signature = authenticatePasskeyDto.response.signature,
      userHandle = authenticatePasskeyDto.response.userHandle,
    )
  }

  /**
   * Maps an exception to a [TwilioException] with appropriate error messages.
   *
   * @param e The exception to be mapped.
   * @return The TwilioException mapped from the provided exception.
   */
  fun mapException(e: Exception): TwilioException {
    return when (e) {
      is SerializationException, is IllegalArgumentException, is IndexOutOfBoundsException ->
        TwilioException.InvalidPayloadException(e)

      else -> TwilioException.GeneralException(e)
    }
  }
}