@sphereon/ssi-sdk.siopv2-oid4vp-rp-rest-api 0.34.1-fix.171 → 0.34.1-fix.223

package/src/types/types.ts

@@ -1,11 +1,10 @@
-import { IAgentContext, ICredentialVerifier } from '@veramo/core'
+import { CreateAuthorizationRequestPayload, CreateAuthorizationResponsePayload } from '@sphereon/did-auth-siop'
 import { GenericAuthArgs, ISingleEndpointOpts } from '@sphereon/ssi-express-support'
-import { ISIOPv2RP } from '@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth'
 import { IPDManager } from '@sphereon/ssi-sdk.pd-manager'
 import { AuthorizationRequestStateStatus, AuthorizationResponseStateStatus } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
+import { ISIOPv2RP } from '@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth'
+import { IAgentContext, ICredentialVerifier } from '@veramo/core'
 import { Request, Response } from 'express'
-import { z } from 'zod'
-import { CreateAuthorizationRequestBodySchema, CreateAuthorizationResponseSchema } from '../schemas'
 import { QRCodeOpts } from './QRCode.types'
 import { VerifiedData } from '@sphereon/did-auth-siop'
 
@@ -36,24 +35,20 @@ export interface ICreateAuthRequestWebappEndpointOpts extends ISingleEndpointOpt
 export type IRequiredPlugins = ICredentialVerifier & ISIOPv2RP & IPDManager
 export type IRequiredContext = IAgentContext<IRequiredPlugins>
 
-export type CreateAuthorizationRequest = Request<Record<string, never>, any, CreateAuthorizationRequestBody, Record<string, never>>
+export type CreateAuthorizationRequestPayloadRequest = Request<Record<string, never>, any, CreateAuthorizationRequestPayload, Record<string, never>>
 
-export type CreateAuthorizationRequestBody = z.infer<typeof CreateAuthorizationRequestBodySchema>;
-
-export type CreateAuthorizationResponse = Response<CreateAuthorizationRequestResponse>
-
-export type CreateAuthorizationRequestResponse = z.infer<typeof CreateAuthorizationResponseSchema>;
+export type CreateAuthorizationResponsePayloadResponse = Response<CreateAuthorizationResponsePayload>
 
 export type DeleteAuthorizationRequest = Request<DeleteAuthorizationRequestPathParameters, any, Record<string, any>, Record<string, any>>
 
 export type DeleteAuthorizationRequestPathParameters = {
-  correlationId: string;
+  correlationId: string
 }
 
 export type GetAuthorizationRequestStatus = Request<GetAuthorizationRequestStatusPathParameters, any, Record<string, any>, Record<string, any>>
 
 export type GetAuthorizationRequestStatusPathParameters = {
-  correlationId: string;
+  correlationId: string
 }
 
 export type RequestError = {
@@ -70,29 +65,3 @@ export interface AuthStatusResponse {
   verified_data?: VerifiedData
   error?: RequestError
 }
-
-// export type VerifiedData = {
-//   authorization_response?: AuthorizationResponse
-//   credential_claims?: AdditionalClaims
-// }
-//
-// export type AuthorizationResponse = {
-//   presentation_submission?: Record<string, any>
-//   vp_token?: VpToken
-// }
-//
-// export type SingleObjectVpTokenPE = Record<string, any>
-//
-// export type SingleStringVpTokenPE = string
-//
-// export type MultipleVpTokens = Array<SingleObjectVpTokenPE> | Array<SingleStringVpTokenPE>
-//
-// export type MultipleVpTokenDCQL = {
-//   [key: string]: MultipleVpTokens
-// }
-//
-// export type VpToken =
-//   | SingleObjectVpTokenPE
-//   | SingleStringVpTokenPE
-//   | MultipleVpTokens
-//   | MultipleVpTokenDCQL

package/src/universal-oid4vp-api-functions.ts

@@ -1,18 +1,24 @@
+import {
+  AuthorizationRequestStateStatus,
+  CreateAuthorizationRequest,
+  createAuthorizationRequestFromPayload,
+  CreateAuthorizationRequestPayloadSchema,
+  CreateAuthorizationResponsePayload,
+} from '@sphereon/did-auth-siop'
 import { checkAuth, ISingleEndpointOpts, sendErrorResponse } from '@sphereon/ssi-express-support'
 import { uriWithBase } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
 import { Request, Response, Router } from 'express'
 import uuid from 'short-uuid'
 import { validateData } from './middleware/validationMiddleware'
-import { CreateAuthorizationRequestBodySchema } from './schemas'
 import {
-  CreateAuthorizationRequest,
-  CreateAuthorizationRequestResponse,
-  CreateAuthorizationResponse,
+  AuthStatusResponse,
+  CreateAuthorizationRequestPayloadRequest,
+  CreateAuthorizationResponsePayloadResponse,
   DeleteAuthorizationRequest,
   GetAuthorizationRequestStatus,
-  AuthStatusResponse,
   ICreateAuthRequestWebappEndpointOpts,
-  IRequiredContext
+  IRequiredContext,
+  QRCodeOpts,
 } from './types'
 
 export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ICreateAuthRequestWebappEndpointOpts) {
@@ -22,58 +28,68 @@ export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context
   }
 
   const path = opts?.path ?? '/backend/auth/requests'
-  router.post(path, checkAuth(opts?.endpoint), validateData(CreateAuthorizationRequestBodySchema), async (request: CreateAuthorizationRequest, response: CreateAuthorizationResponse) => {
-    try {
-      const correlationId = request.body.correlation_id ?? uuid.uuid()
-      const qrCodeOpts = request.body.qr_code ?? opts?.qrCodeOpts
-      const queryId = request.body.query_id
-      const directPostResponseRedirectUri = request.body.direct_post_response_redirect_uri // TODO Uri not URI
-      const requestUriBase = request.body.request_uri_base
-      const callback = request.body.callback
-
-      const definitionItems = await context.agent.pdmGetDefinitions({ filter: [{ definitionId: queryId }] })
-      if (definitionItems.length === 0) {
+  router.post(
+    path,
+    checkAuth(opts?.endpoint),
+    validateData(CreateAuthorizationRequestPayloadSchema),
+    async (request: CreateAuthorizationRequestPayloadRequest, response: CreateAuthorizationResponsePayloadResponse) => {
+      try {
+        const authRequest: CreateAuthorizationRequest = createAuthorizationRequestFromPayload(request.body)
+        const correlationId = authRequest.correlationId ?? uuid.uuid()
+        const qrCodeOpts = authRequest.qrCode ? ({ ...authRequest.qrCode } satisfies QRCodeOpts) : opts?.qrCodeOpts
+        const queryId = authRequest.queryId
+
+        const definitionItems = await context.agent.pdmGetDefinitions({
+          filter: [
+            { id: queryId }, // Allow both PK (unique queryId + version combi) or just plain queryId which assumes the latest version
+            { queryId },
+          ],
+        })
+        if (definitionItems.length === 0) {
           console.log(`No query could be found for the given id. Query id: ${queryId}`)
           return sendErrorResponse(response, 404, { status: 404, message: 'No query could be found' })
+        }
+
+        const requestByReferenceURI = uriWithBase(`/siop/queries/${queryId}/auth-requests/${correlationId}`, {
+          baseURI: authRequest.requestUriBase ?? opts?.siopBaseURI,
+        })
+        const responseURI = uriWithBase(`/siop/queries/${queryId}/auth-responses/${correlationId}`, { baseURI: opts?.siopBaseURI })
+
+        const authRequestURI = await context.agent.siopCreateAuthRequestURI({
+          queryId,
+          correlationId,
+          nonce: uuid.uuid(),
+          requestByReferenceURI,
+          responseURIType: 'response_uri',
+          responseURI,
+          ...(authRequest.directPostResponseRedirectUri && { responseRedirectURI: authRequest.directPostResponseRedirectUri }),
+          ...(authRequest.callback && { callback: authRequest.callback }),
+        })
+
+        let qrCodeDataUri: string | undefined
+        if (qrCodeOpts) {
+          const { AwesomeQR } = await import('awesome-qr')
+          const qrCode = new AwesomeQR({ ...qrCodeOpts, text: authRequestURI })
+          qrCodeDataUri = `data:image/png;base64,${(await qrCode.draw())!.toString('base64')}`
+        } else {
+          qrCodeDataUri = authRequestURI
+        }
+
+        const authRequestBody = {
+          query_id: queryId,
+          correlation_id: correlationId,
+          request_uri: authRequestURI,
+          status_uri: `${uriWithBase(opts?.webappAuthStatusPath ?? `/backend/auth/status/${correlationId}`, { baseURI: opts?.webappBaseURI })}`,
+          ...(qrCodeDataUri && { qr_uri: qrCodeDataUri }),
+        } satisfies CreateAuthorizationResponsePayload
+        console.log(`Auth Request URI data to send back: ${JSON.stringify(authRequestBody)}`)
+
+        return response.status(201).json(authRequestBody)
+      } catch (error) {
+        return sendErrorResponse(response, 500, { status: 500, message: 'Could not create an authorization request URI' }, error)
       }
-
-      const requestByReferenceURI = uriWithBase(`/siop/definitions/${queryId}/auth-requests/${correlationId}`, {
-        baseURI: requestUriBase ?? opts?.siopBaseURI,
-      })
-      const responseURI = uriWithBase(`/siop/definitions/${queryId}/auth-responses/${correlationId}`, { baseURI: opts?.siopBaseURI })
-
-      const authRequestURI = await context.agent.siopCreateAuthRequestURI({
-        queryId,
-        correlationId,
-        nonce: uuid.uuid(),
-        requestByReferenceURI,
-        responseURIType: 'response_uri',
-        responseURI,
-        ...(directPostResponseRedirectUri && { responseRedirectURI: directPostResponseRedirectUri }),
-        callback
-      })
-
-      let qrCodeDataUri: string | undefined
-      if (qrCodeOpts) {
-        const { AwesomeQR } = await import('awesome-qr')
-        const qrCode = new AwesomeQR({ ...qrCodeOpts, text: authRequestURI })
-        qrCodeDataUri = `data:image/png;base64,${(await qrCode.draw())!.toString('base64')}`
-      }
-
-      const authRequestBody = {
-        query_id: queryId,
-        correlation_id: correlationId,
-        request_uri: authRequestURI,
-        status_uri: `${uriWithBase(opts?.webappAuthStatusPath ?? `/backend/auth/status/${correlationId}`, { baseURI: opts?.webappBaseURI })}`,
-        ...(qrCodeDataUri && { qr_uri: qrCodeDataUri }),
-      } satisfies CreateAuthorizationRequestResponse
-      console.log(`Auth Request URI data to send back: ${JSON.stringify(authRequestBody)}`)
-
-      return response.status(201).json(authRequestBody)
-    } catch (error) {
-      return sendErrorResponse(response, 500, { status: 500, message: 'Could not create an authorization request URI' }, error)
-    }
-  })
+    },
+  )
 }
 
 export function removeAuthRequestStateUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ISingleEndpointOpts) {
@@ -89,7 +105,7 @@ export function removeAuthRequestStateUniversalOID4VPEndpoint(router: Router, co
 
       const authRequestState = await context.agent.siopGetAuthRequestState({
         correlationId,
-        errorOnNotFound: false
+        errorOnNotFound: false,
       })
       if (!authRequestState) {
         console.log(`No authorization request could be found for the given correlationId. correlationId: ${correlationId}`)
@@ -119,7 +135,7 @@ export function authStatusUniversalOID4VPEndpoint(router: Router, context: IRequ
 
       const requestState = await context.agent.siopGetAuthRequestState({
         correlationId,
-        errorOnNotFound: false
+        errorOnNotFound: false,
       })
 
       if (!requestState) {
@@ -128,8 +144,11 @@ export function authStatusUniversalOID4VPEndpoint(router: Router, context: IRequ
       }
 
       let responseState
-      if (requestState.status === "authorization_request_retrieved") {
-        responseState = (await context.agent.siopGetAuthResponseState({ correlationId, errorOnNotFound: false }))
+      if (requestState.status === AuthorizationRequestStateStatus.RETRIEVED) {
+        responseState = await context.agent.siopGetAuthResponseState({
+          correlationId,
+          errorOnNotFound: false
+        })
       }
       const overallState = responseState ?? requestState
 
@@ -139,7 +158,6 @@ export function authStatusUniversalOID4VPEndpoint(router: Router, context: IRequ
         query_id: overallState.queryId,
         last_updated: overallState.lastUpdated,
         ...('verifiedData' in overallState && { verified_data: overallState.verifiedData }),
-        //...((responseState?.status === AuthorizationResponseStateStatus.VERIFIED && responseState.verifiedData !== undefined) && { verified_data: responseState.verifiedData }),
         ...(overallState.error && { message: overallState.error.message })
       } satisfies AuthStatusResponse
       console.debug(`Will send auth status: ${JSON.stringify(statusBody)}`)

package/src/schemas/index.ts

@@ -1,42 +0,0 @@
-import {
-  CallbackOptsSchema,
-  RequestUriMethod,
-  ResponseMode,
-  ResponseType
-} from '@sphereon/did-auth-siop'
-import { z } from 'zod'
-
-export const ResponseTypeSchema = z.enum([ResponseType.VP_TOKEN]);
-
-export const ResponseModeSchema = z.enum([ResponseMode.DIRECT_POST, ResponseMode.DIRECT_POST_JWT]);
-
-const requestUriMethods = ['get', 'post'] as const satisfies Array<RequestUriMethod>;
-export const RequestUriMethodSchema = z.enum(requestUriMethods);
-
-export const QRCodeOptsSchema = z.object({
-  size: z.number().optional(),
-  color_dark: z.string().optional(),
-  color_light: z.string().optional(),
-});
-
-export const CreateAuthorizationRequestBodySchema = z.object({
-  query_id: z.string(),
-  client_id: z.string().optional(),
-  request_uri_base: z.string().optional(),
-  correlation_id: z.string().optional(),
-  request_uri_method: RequestUriMethodSchema.optional(),
-  response_type: ResponseTypeSchema.optional(),
-  response_mode: ResponseModeSchema.optional(),
-  transaction_data: z.array(z.string()).optional(),
-  qr_code: QRCodeOptsSchema.optional(),
-  direct_post_response_redirect_uri: z.string().optional(),
-  callback: CallbackOptsSchema.optional(),
-});
-
-export const CreateAuthorizationResponseSchema = z.object({
-  correlation_id: z.string(),
-  query_id: z.string(),
-  request_uri: z.string(),
-  status_uri: z.string(),
-  qr_uri: z.string().optional(),
-});