@sphereon/ssi-sdk.siopv2-oid4vp-rp-rest-api 0.34.1-feature.SSISDK.58.host.nonce.endpoint.194 → 0.34.1-feature.SSISDK.62.218

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

@@ -1,19 +1,26 @@
-import { AuthorizationResponseStateStatus } from '@sphereon/did-auth-siop'
+import {
+  AuthorizationRequestStateStatus,
+  AuthorizationResponseStateStatus,
+  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 { VerifiedDataMode } from '@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth'
 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,
+  QRCodeOpts,
 } from './types'
 
 export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ICreateAuthRequestWebappEndpointOpts) {
@@ -26,26 +33,29 @@ export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context
   router.post(
     path,
     checkAuth(opts?.endpoint),
-    validateData(CreateAuthorizationRequestBodySchema),
-    async (request: CreateAuthorizationRequest, response: CreateAuthorizationResponse) => {
+    validateData(CreateAuthorizationRequestPayloadSchema),
+    async (request: CreateAuthorizationRequestPayloadRequest, response: CreateAuthorizationResponsePayloadResponse) => {
       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: [{ queryId }] })
+        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/definitions/${queryId}/auth-requests/${correlationId}`, {
-          baseURI: requestUriBase ?? opts?.siopBaseURI,
+        const requestByReferenceURI = uriWithBase(`/siop/queries/${queryId}/auth-requests/${correlationId}`, {
+          baseURI: authRequest.requestUriBase ?? opts?.siopBaseURI,
         })
-        const responseURI = uriWithBase(`/siop/definitions/${queryId}/auth-responses/${correlationId}`, { baseURI: opts?.siopBaseURI })
+        const responseURI = uriWithBase(`/siop/queries/${queryId}/auth-responses/${correlationId}`, { baseURI: opts?.siopBaseURI })
 
         const authRequestURI = await context.agent.siopCreateAuthRequestURI({
           queryId,
@@ -54,8 +64,8 @@ export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context
           requestByReferenceURI,
           responseURIType: 'response_uri',
           responseURI,
-          ...(directPostResponseRedirectUri && { responseRedirectURI: directPostResponseRedirectUri }),
-          callback,
+          ...(authRequest.directPostResponseRedirectUri && { responseRedirectURI: authRequest.directPostResponseRedirectUri }),
+          ...(authRequest.callback && { callback: authRequest.callback }),
         })
 
         let qrCodeDataUri: string | undefined
@@ -63,6 +73,8 @@ export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context
           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 = {
@@ -71,7 +83,7 @@ export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context
           request_uri: authRequestURI,
           status_uri: `${uriWithBase(opts?.webappAuthStatusPath ?? `/backend/auth/status/${correlationId}`, { baseURI: opts?.webappBaseURI })}`,
           ...(qrCodeDataUri && { qr_uri: qrCodeDataUri }),
-        } satisfies CreateAuthorizationRequestResponse
+        } satisfies CreateAuthorizationResponsePayload
         console.log(`Auth Request URI data to send back: ${JSON.stringify(authRequestBody)}`)
 
         return response.status(201).json(authRequestBody)
@@ -134,8 +146,12 @@ export function authStatusUniversalOID4VPEndpoint(router: Router, context: IRequ
       }
 
       let responseState
-      if (requestState.status === 'authorization_request_created') {
-        responseState = await context.agent.siopGetAuthResponseState({ correlationId, errorOnNotFound: false })
+      if (requestState.status === AuthorizationRequestStateStatus.RETRIEVED) {
+        responseState = await context.agent.siopGetAuthResponseState({
+          correlationId,
+          errorOnNotFound: false,
+          includeVerifiedData: VerifiedDataMode.VERIFIED_PRESENTATION,
+        })
       }
       const overallState = responseState ?? requestState
 

package/src/webapp-api-functions.ts

@@ -1,7 +1,7 @@
-import { AuthorizationRequestState, AuthorizationResponseStateStatus } from '@sphereon/did-auth-siop'
+import { AuthorizationRequestState, AuthorizationResponseStateStatus, AuthorizationResponseStateWithVerifiedData } from '@sphereon/did-auth-siop'
 import { checkAuth, ISingleEndpointOpts, sendErrorResponse } from '@sphereon/ssi-express-support'
 import { AuthStatusResponse, GenerateAuthRequestURIResponse, uriWithBase } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
-import { AuthorizationResponseStateWithVerifiedData, VerifiedDataMode } from '@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth'
+import { VerifiedDataMode } from '@sphereon/ssi-sdk.siopv2-oid4vp-rp-auth'
 import { shaHasher as defaultHasher } from '@sphereon/ssi-sdk.core'
 import { Request, Response, Router } from 'express'
 import uuid from 'short-uuid'
@@ -12,29 +12,29 @@ export function createAuthRequestWebappEndpoint(router: Router, context: IRequir
     console.log(`createAuthRequest Webapp endpoint is disabled`)
     return
   }
-  const path = opts?.path ?? '/webapp/definitions/:definitionId/auth-requests'
+  const path = opts?.path ?? '/webapp/queries/:queryId/auth-requests'
   router.post(path, checkAuth(opts?.endpoint), async (request: Request, response: Response) => {
     try {
       // if (!request.agent) throw Error('No agent configured')
-      const definitionId = request.params.definitionId
-      if (!definitionId) {
-        return sendErrorResponse(response, 400, 'No definitionId query parameter provided')
+      const queryId = request.params.queryId
+      if (!queryId) {
+        return sendErrorResponse(response, 400, 'No queryId query parameter provided')
       }
       const state: string = request.body.state ?? uuid.uuid()
       const correlationId = request.body.correlationId ?? state
       const qrCodeOpts = request.body.qrCodeOpts ?? opts?.qrCodeOpts
 
-      const requestByReferenceURI = uriWithBase(`/siop/definitions/${definitionId}/auth-requests/${state}`, {
+      const requestByReferenceURI = uriWithBase(`/siop/queries/${queryId}/auth-requests/${state}`, {
         baseURI: opts?.siopBaseURI,
       })
-      const responseURI = uriWithBase(`/siop/definitions/${definitionId}/auth-responses/${state}`, { baseURI: opts?.siopBaseURI })
+      const responseURI = uriWithBase(`/siop/queries/${queryId}/auth-responses/${state}`, { baseURI: opts?.siopBaseURI })
       // first version is for backwards compat
       const responseRedirectURI =
         ('response_redirect_uri' in request.body && (request.body.response_redirect_uri as string | undefined)) ??
         ('responseRedirectURI' in request.body && (request.body.responseRedirectURI as string | undefined))
 
       const authRequestURI = await context.agent.siopCreateAuthRequestURI({
-        definitionId,
+        queryId,
         correlationId,
         state,
         nonce: uuid.uuid(),
@@ -53,7 +53,7 @@ export function createAuthRequestWebappEndpoint(router: Router, context: IRequir
       const authRequestBody: GenerateAuthRequestURIResponse = {
         correlationId,
         state,
-        definitionId,
+        queryId,
         authRequestURI,
         authStatusURI: `${uriWithBase(opts?.webappAuthStatusPath ?? '/webapp/auth-status', { baseURI: opts?.webappBaseURI })}`,
         ...(qrCodeDataUri && { qrCodeDataUri }),
@@ -76,26 +76,24 @@ export function authStatusWebappEndpoint(router: Router, context: IRequiredConte
     try {
       console.log('Received auth-status request...')
       const correlationId: string = request.body.correlationId as string
-      const definitionId: string = request.body.definitionId as string
+      const queryId: string = request.body.queryId as string
 
       const requestState =
-        correlationId && definitionId
+        correlationId && queryId
           ? await context.agent.siopGetAuthRequestState({
               correlationId,
-              definitionId,
+              queryId,
               errorOnNotFound: false,
             })
           : undefined
-      if (!requestState || !definitionId || !correlationId) {
-        console.log(
-          `No authentication request mapping could be found for the given URL. correlation: ${correlationId}, definitionId: ${definitionId}`,
-        )
+      if (!requestState || !queryId || !correlationId) {
+        console.log(`No authentication request mapping could be found for the given URL. correlation: ${correlationId}, queryId: ${queryId}`)
         response.statusCode = 404
         const statusBody: AuthStatusResponse = {
           status: requestState ? requestState.status : 'error',
           error: 'No authentication request mapping could be found for the given URL.',
           correlationId,
-          definitionId,
+          queryId,
           lastUpdated: requestState ? requestState.lastUpdated : Date.now(),
         }
         return response.json(statusBody)
@@ -107,10 +105,10 @@ export function authStatusWebappEndpoint(router: Router, context: IRequiredConte
       }
 
       let responseState
-      if (requestState.status === 'sent') {
+      if (requestState.status === 'authorization_request_retrieved') {
         responseState = (await context.agent.siopGetAuthResponseState({
           correlationId,
-          definitionId,
+          queryId,
           includeVerifiedData: includeVerifiedData,
           errorOnNotFound: false,
         })) as AuthorizationResponseStateWithVerifiedData
@@ -121,7 +119,7 @@ export function authStatusWebappEndpoint(router: Router, context: IRequiredConte
         status: overallState.status,
         ...(overallState.error ? { error: overallState.error?.message } : {}),
         correlationId,
-        definitionId,
+        queryId,
         lastUpdated: overallState.lastUpdated,
         ...(responseState && responseState.status === AuthorizationResponseStateStatus.VERIFIED
           ? {
@@ -148,17 +146,17 @@ export function removeAuthRequestStateWebappEndpoint(router: Router, context: IR
     console.log(`removeAuthStatus Webapp endpoint is disabled`)
     return
   }
-  const path = opts?.path ?? '/webapp/definitions/:definitionId/auth-requests/:correlationId'
+  const path = opts?.path ?? '/webapp/queries/:queryId/auth-requests/:correlationId'
   router.delete(path, checkAuth(opts?.endpoint), async (request: Request, response: Response) => {
     try {
       const correlationId: string = request.params.correlationId
-      const definitionId: string = request.params.definitionId
-      if (!correlationId || !definitionId) {
-        console.log(`No authorization request could be found for the given url. correlationId: ${correlationId}, definitionId: ${definitionId}`)
+      const queryId: string = request.params.queryId
+      if (!correlationId || !queryId) {
+        console.log(`No authorization request could be found for the given url. correlationId: ${correlationId}, queryId: ${queryId}`)
         return sendErrorResponse(response, 404, 'No authorization request could be found')
       }
       response.statusCode = 200
-      return response.json(await context.agent.siopDeleteAuthState({ definitionId, correlationId }))
+      return response.json(await context.agent.siopDeleteAuthState({ queryId, correlationId }))
     } catch (error) {
       return sendErrorResponse(response, 500, error.message, error)
     }
@@ -170,7 +168,7 @@ export function getDefinitionsEndpoint(router: Router, context: IRequiredContext
     console.log(`getDefinitions Webapp endpoint is disabled`)
     return
   }
-  const path = opts?.path ?? '/webapp/definitions'
+  const path = opts?.path ?? '/webapp/queries'
   router.get(path, checkAuth(opts?.endpoint), async (request: Request, response: Response) => {
     try {
       const definitions = await context.agent.pdmGetDefinitions()

package/src/schemas/index.ts

@@ -1,36 +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(),
-})