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

package/src/types/types.ts

@@ -1,11 +1,12 @@
-import { CreateAuthorizationRequestPayload, CreateAuthorizationResponsePayload } from '@sphereon/did-auth-siop'
+import { IAgentContext, ICredentialVerifier } from '@veramo/core'
 import { GenericAuthArgs, ISingleEndpointOpts } from '@sphereon/ssi-express-support'
-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 { IPDManager } from '@sphereon/ssi-sdk.pd-manager'
 import { AdditionalClaims } from '@sphereon/ssi-types'
-import { IAgentContext, ICredentialVerifier } from '@veramo/core'
+import { AuthorizationRequestStateStatus, AuthorizationResponseStateStatus } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
 import { Request, Response } from 'express'
+import { z } from 'zod'
+import { CreateAuthorizationRequestBodySchema, CreateAuthorizationResponseSchema } from '../schemas'
 import { QRCodeOpts } from './QRCode.types'
 
 export type SiopFeatures = 'rp-status' | 'siop'
@@ -35,20 +36,24 @@ export interface ICreateAuthRequestWebappEndpointOpts extends ISingleEndpointOpt
 export type IRequiredPlugins = ICredentialVerifier & ISIOPv2RP & IPDManager
 export type IRequiredContext = IAgentContext<IRequiredPlugins>
 
-export type CreateAuthorizationRequestPayloadRequest = Request<Record<string, never>, any, CreateAuthorizationRequestPayload, Record<string, never>>
+export type CreateAuthorizationRequest = Request<Record<string, never>, any, CreateAuthorizationRequestBody, Record<string, never>>
+
+export type CreateAuthorizationRequestBody = z.infer<typeof CreateAuthorizationRequestBodySchema>;
+
+export type CreateAuthorizationResponse = Response<CreateAuthorizationRequestResponse>
 
-export type CreateAuthorizationResponsePayloadResponse = Response<CreateAuthorizationResponsePayload>
+export type CreateAuthorizationRequestResponse = z.infer<typeof CreateAuthorizationResponseSchema>;
 
 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 = {
@@ -86,4 +91,8 @@ export type MultipleVpTokenDCQL = {
   [key: string]: MultipleVpTokens
 }
 
-export type VpToken = SingleObjectVpTokenPE | SingleStringVpTokenPE | MultipleVpTokens | MultipleVpTokenDCQL
+export type VpToken =
+  | SingleObjectVpTokenPE
+  | SingleStringVpTokenPE
+  | MultipleVpTokens
+  | MultipleVpTokenDCQL

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

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

package/src/webapp-api-functions.ts

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