@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth/src/functions.ts

import {
  ClientIdentifierPrefix,
  ClientMetadataOpts,
  DcqlQueryLookupCallback,
  InMemoryRPSessionManager,
  PassBy,
  PresentationVerificationCallback,
  PresentationVerificationResult,
  PropertyTarget,
  ResponseMode,
  ResponseType,
  RevocationVerification,
  RP,
  RPBuilder,
  Scope,
  SubjectType,
  SupportedVersion,
  VerifyJwtCallback,
} from '@sphereon/did-auth-siop'
import { CreateJwtCallback, JwtHeader, JwtIssuer, JwtPayload, SigningAlgo } from '@sphereon/oid4vc-common'
import { IPresentationDefinition } from '@sphereon/pex'
import { getAgentDIDMethods, getAgentResolver } from '@sphereon/ssi-sdk-ext.did-utils'
import {
  isExternalIdentifierOIDFEntityIdOpts,
  isManagedIdentifierDidOpts,
  isManagedIdentifierDidResult,
  isManagedIdentifierX5cOpts,
  ManagedIdentifierOptsOrResult,
} from '@sphereon/ssi-sdk-ext.identifier-resolution'
import { JwtCompactResult } from '@sphereon/ssi-sdk-ext.jwt-service'
import { IVerifySdJwtPresentationResult } from '@sphereon/ssi-sdk.sd-jwt'
import { CredentialMapper, HasherSync, OriginalVerifiableCredential, PresentationSubmission } from '@sphereon/ssi-types'
import { IVerifyCallbackArgs, IVerifyCredentialResult, VerifyCallback } from '@sphereon/wellknown-dids-client'
import { TKeyType } from '@veramo/core'
import { JWTVerifyOptions } from 'did-jwt'
import { Resolvable } from 'did-resolver'
import { EventEmitter } from 'events'
import { validate as isValidUUID } from 'uuid'
import { IRequiredContext, IRPOptions, ISIOPIdentifierOptions } from './types/ISIOPv2RP'
import { DcqlQuery } from 'dcql'
import { defaultHasher } from '@sphereon/ssi-sdk.core'

export function getRequestVersion(rpOptions: IRPOptions): SupportedVersion {
  if (Array.isArray(rpOptions.supportedVersions) && rpOptions.supportedVersions.length > 0) {
    return rpOptions.supportedVersions[0]
  }
  return SupportedVersion.OID4VP_v1
}

function getWellKnownDIDVerifyCallback(siopIdentifierOpts: ISIOPIdentifierOptions, context: IRequiredContext) {
  return siopIdentifierOpts.wellknownDIDVerifyCallback
    ? siopIdentifierOpts.wellknownDIDVerifyCallback
    : async (args: IVerifyCallbackArgs): Promise<IVerifyCredentialResult> => {
        const result = await context.agent.cvVerifyCredential({
          credential: args.credential as OriginalVerifiableCredential,
          fetchRemoteContexts: true,
        })
        return { verified: result.result }
      }
}

export function getDcqlQueryLookupCallback(context: IRequiredContext): DcqlQueryLookupCallback {
  async function dcqlQueryLookup(queryId: string, version?: string, tenantId?: string): Promise<DcqlQuery> {
    // TODO Add caching?
    const result = await context.agent.pdmGetDefinitions({
      filter: [
        {
          queryId,
          ...(tenantId && { tenantId }),
          ...(version && { version }),
        },
        ...(isValidUUID(queryId) ? [{ id: queryId }] : []),
      ],
    })
    if (result && result.length > 0) {
      return result[0].query
    }

    return Promise.reject(Error(`No dcql query found for queryId ${queryId}`))
  }

  return dcqlQueryLookup
}

export function getPresentationVerificationCallback(
  idOpts: ManagedIdentifierOptsOrResult,
  context: IRequiredContext,
): PresentationVerificationCallback {
  async function presentationVerificationCallback(
    args: any, // FIXME any
    presentationSubmission?: PresentationSubmission,
  ): Promise<PresentationVerificationResult> {
    if (CredentialMapper.isSdJwtEncoded(args)) {
      const result: IVerifySdJwtPresentationResult = await context.agent.verifySdJwtPresentation({
        presentation: args,
      })
      // fixme: investigate the correct way to handle this
      return { verified: !!result.payload }
    }

    if (CredentialMapper.isMsoMdocOid4VPEncoded(args)) {
      // TODO Funke reevaluate
      if (context.agent.mdocOid4vpRPVerify === undefined) {
        return Promise.reject('ImDLMdoc agent plugin must be enabled to support MsoMdoc types')
      }
      if (presentationSubmission !== undefined && presentationSubmission !== null) {
        const verifyResult = await context.agent.mdocOid4vpRPVerify({
          vp_token: args,
          presentation_submission: presentationSubmission,
        })
        return { verified: !verifyResult.error }
      }
      throw Error(`mdocOid4vpRPVerify(...) method requires a presentation submission`)
    }

    const result = await context.agent.verifyPresentation({
      presentation: args,
      fetchRemoteContexts: true,
      domain: (await context.agent.identifierManagedGet(idOpts)).kid?.split('#')[0],
    })
    return { verified: result.verified }
  }

  return presentationVerificationCallback
}

export async function createRPBuilder(args: {
  rpOpts: IRPOptions
  definition?: IPresentationDefinition
  context: IRequiredContext
}): Promise<RPBuilder> {
  const { rpOpts, context } = args
  const { identifierOpts } = rpOpts

  const didMethods = identifierOpts.supportedDIDMethods ?? (await getAgentDIDMethods(context))
  const eventEmitter = rpOpts.eventEmitter ?? new EventEmitter()

  const defaultClientMetadata: ClientMetadataOpts = {
    // FIXME: All of the below should be configurable. Some should come from builder, some should be determined by the agent.
    // For now it is either preconfigured or everything passed in as a single object
    idTokenSigningAlgValuesSupported: [SigningAlgo.EDDSA, SigningAlgo.ES256, SigningAlgo.ES256K], // added newly
    requestObjectSigningAlgValuesSupported: [SigningAlgo.EDDSA, SigningAlgo.ES256, SigningAlgo.ES256K], // added newly
    responseTypesSupported: [ResponseType.ID_TOKEN], // added newly
    client_name: 'Sphereon',
    vpFormatsSupported: {
      jwt_vc: { alg: ['EdDSA', 'ES256K'] },
      jwt_vp: { alg: ['ES256K', 'EdDSA'] },
    },
    scopesSupported: [Scope.OPENID_DIDAUTHN],
    subjectTypesSupported: [SubjectType.PAIRWISE],
    subject_syntax_types_supported: didMethods.map((method) => `did:${method}`),
    passBy: PassBy.VALUE,
  }

  const resolver =
    rpOpts.identifierOpts.resolveOpts?.resolver ??
    getAgentResolver(context, {
      resolverResolution: true,
      localResolution: true,
      uniresolverResolution: rpOpts.identifierOpts.resolveOpts?.noUniversalResolverFallback !== true,
    })
  //todo: probably wise to first look and see if we actually need the hasher to begin with
  let hasher: HasherSync | undefined = rpOpts.credentialOpts?.hasher
  if (!rpOpts.credentialOpts?.hasher || typeof rpOpts.credentialOpts?.hasher !== 'function') {
    hasher = defaultHasher
  }

  const builder = RP.builder({ requestVersion: getRequestVersion(rpOpts) })
    .withScope('openid', PropertyTarget.REQUEST_OBJECT)
    .withResponseMode(rpOpts.responseMode ?? ResponseMode.POST)
    .withResponseType(ResponseType.VP_TOKEN, PropertyTarget.REQUEST_OBJECT)
    // todo: move to options fill/correct method
    .withSupportedVersions(rpOpts.supportedVersions ?? [SupportedVersion.OID4VP_v1, SupportedVersion.SIOPv2_OID4VP_D28])

    .withEventEmitter(eventEmitter)
    .withSessionManager(rpOpts.sessionManager ?? new InMemoryRPSessionManager(eventEmitter))
    .withClientMetadata(rpOpts.clientMetadataOpts ?? defaultClientMetadata, PropertyTarget.REQUEST_OBJECT)
    .withVerifyJwtCallback(
      rpOpts.verifyJwtCallback
        ? rpOpts.verifyJwtCallback
        : getVerifyJwtCallback(
            {
              resolver,
              verifyOpts: {
                wellknownDIDVerifyCallback: getWellKnownDIDVerifyCallback(rpOpts.identifierOpts, context),
                checkLinkedDomain: 'if_present',
              },
            },
            context,
          ),
    )
    .withDcqlQueryLookup(getDcqlQueryLookupCallback(context))
    .withRevocationVerification(RevocationVerification.NEVER)
    .withPresentationVerification(getPresentationVerificationCallback(identifierOpts.idOpts, context))

  const oidfOpts = identifierOpts.oidfOpts
  if (oidfOpts && isExternalIdentifierOIDFEntityIdOpts(oidfOpts)) {
    builder.withEntityId(oidfOpts.identifier, PropertyTarget.REQUEST_OBJECT)
  } else {
    const resolution = await context.agent.identifierManagedGet(identifierOpts.idOpts)
    const clientId: string =
      rpOpts.clientMetadataOpts?.client_id ??
      resolution.issuer ??
      (isManagedIdentifierDidResult(resolution) ? resolution.did : resolution.jwkThumbprint)
    const clientIdPrefixed = prefixClientId(clientId)
    builder.withClientId(clientIdPrefixed, PropertyTarget.REQUEST_OBJECT)
  }

  if (hasher) {
    builder.withHasher(hasher)
  }
  //fixme: this has been removed in the new version of did-auth-siop
  /*if (!rpOpts.clientMetadataOpts?.subjectTypesSupported) {
    // Do not update in case it is already provided via client metadata opts
    didMethods.forEach((method) => builder.addDidMethod(method))
  }*/
  //fixme: this has been removed in the new version of did-auth-siop
  // builder.withWellknownDIDVerifyCallback(getWellKnownDIDVerifyCallback(didOpts, context))

  if (rpOpts.responseRedirectUri) {
    builder.withResponseRedirectUri(rpOpts.responseRedirectUri)
  }

  // Pass through V1/D28-specific options to the builder
  if (rpOpts.transactionData) {
    builder.withTransactionData(rpOpts.transactionData)
  }
  if (rpOpts.verifierInfo) {
    builder.withVerifierInfo(rpOpts.verifierInfo)
  }
  if (rpOpts.verifierAttestations) {
    builder.withVerifierAttestations(rpOpts.verifierAttestations)
  }
  if (rpOpts.requestUriMethod) {
    builder.withRequestUriMethod(rpOpts.requestUriMethod)
  }
  if (rpOpts.expectedOrigins) {
    builder.withExpectedOrigins(rpOpts.expectedOrigins)
  }
  if (rpOpts.walletNonce) {
    builder.withWalletNonce(rpOpts.walletNonce)
  }

  //const key = resolution.key
  //fixme: this has been removed in the new version of did-auth-siop
  //builder.withSuppliedSignature(SuppliedSigner(key, context, getSigningAlgo(key.type) as unknown as KeyAlgo), did, kid, getSigningAlgo(key.type))

  /*if (isManagedIdentifierDidResult(resolution)) {
    //fixme: only accepts dids in version used. New SIOP lib also accepts other types
    builder.withSuppliedSignature(
      SuppliedSigner(key, context, getSigningAlgo(key.type) as unknown as KeyAlgo),
      resolution.did,
      resolution.kid,
      getSigningAlgo(key.type),
    )
  }*/
  //fixme: signcallback and it's return type are not totally compatible with our CreateJwtCallbackBase
  const createJwtCallback = signCallback(rpOpts.identifierOpts.idOpts, context)
  builder.withCreateJwtCallback(createJwtCallback satisfies CreateJwtCallback<any>)
  return builder
}

export function signCallback(
  idOpts: ManagedIdentifierOptsOrResult,
  context: IRequiredContext,
): (jwtIssuer: JwtIssuer, jwt: { header: JwtHeader; payload: JwtPayload }, kid?: string) => Promise<string> {
  return async (jwtIssuer: JwtIssuer, jwt: { header: JwtHeader; payload: JwtPayload }, kid?: string) => {
    if (!(isManagedIdentifierDidOpts(idOpts) || isManagedIdentifierX5cOpts(idOpts))) {
      return Promise.reject(Error(`JWT issuer method ${jwtIssuer.method} not yet supported`))
    }
    const result: JwtCompactResult = await context.agent.jwtCreateJwsCompactSignature({
      // FIXME fix cose-key inference
      // @ts-ignore
      issuer: { identifier: idOpts.identifier, kmsKeyRef: idOpts.kmsKeyRef, noIdentifierInHeader: false },
      // FIXME fix JWK key_ops
      // @ts-ignore
      protectedHeader: jwt.header,
      payload: jwt.payload,
    })
    return result.jwt
  }
}

function getVerifyJwtCallback(
  _opts: {
    resolver?: Resolvable
    verifyOpts?: JWTVerifyOptions & {
      checkLinkedDomain: 'never' | 'if_present' | 'always'
      wellknownDIDVerifyCallback?: VerifyCallback
    }
  },
  context: IRequiredContext,
): VerifyJwtCallback {
  return async (_jwtVerifier, jwt) => {
    const result = await context.agent.jwtVerifyJwsSignature({ jws: jwt.raw })
    console.log(result.message)
    return !result.error
  }
}

export async function createRP({ rpOptions, context }: { rpOptions: IRPOptions; context: IRequiredContext }): Promise<RP> {
  return (await createRPBuilder({ rpOpts: rpOptions, context })).build()
}

export function getSigningAlgo(type: TKeyType): SigningAlgo {
  switch (type) {
    case 'Ed25519':
      return SigningAlgo.EDDSA
    case 'Secp256k1':
      return SigningAlgo.ES256K
    case 'Secp256r1':
      return SigningAlgo.ES256
    // @ts-ignore
    case 'RSA':
      return SigningAlgo.RS256
    default:
      throw Error('Key type not yet supported')
  }
}

export function prefixClientId(clientId: string): string {
  // FIXME SSISDK-60
  if (clientId.startsWith('did:')) {
    return `${ClientIdentifierPrefix.DECENTRALIZED_IDENTIFIER}:${clientId}`
  }

  return clientId
}