@sphereon/ssi-sdk.siopv2-oid4vp-rp-rest-api 0.34.1-feature.SSISDK.46.41 → 0.34.1-feature.SSISDK.50.98
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +120 -208
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +7 -80
- package/dist/index.d.ts +7 -80
- package/dist/index.js +116 -204
- package/dist/index.js.map +1 -1
- package/package.json +19 -22
- package/src/index.ts +1 -1
- package/src/siop-api-functions.ts +10 -20
- package/src/siopv2-rp-api-server.ts +7 -7
- package/src/types/types.ts +1 -42
- package/src/webapp-api-functions.ts +183 -0
- package/src/middleware/validationMiddleware.ts +0 -20
- package/src/schemas/index.ts +0 -50
- package/src/universal-oid4vp-api-functions.ts +0 -172
|
@@ -1,172 +0,0 @@
|
|
|
1
|
-
import { AuthorizationResponseStateStatus } from '@sphereon/did-auth-siop'
|
|
2
|
-
import { checkAuth, ISingleEndpointOpts, sendErrorResponse } from '@sphereon/ssi-express-support'
|
|
3
|
-
import { uriWithBase } from '@sphereon/ssi-sdk.siopv2-oid4vp-common'
|
|
4
|
-
import { Request, Response, Router } from 'express'
|
|
5
|
-
import uuid from 'short-uuid'
|
|
6
|
-
import { validateData } from './middleware/validationMiddleware'
|
|
7
|
-
import { CreateAuthorizationRequestBodySchema } from './schemas'
|
|
8
|
-
import {
|
|
9
|
-
CreateAuthorizationRequest,
|
|
10
|
-
CreateAuthorizationRequestResponse,
|
|
11
|
-
CreateAuthorizationResponse,
|
|
12
|
-
DeleteAuthorizationRequest,
|
|
13
|
-
GetAuthorizationRequestStatus,
|
|
14
|
-
GetAuthStatusResponse,
|
|
15
|
-
ICreateAuthRequestWebappEndpointOpts,
|
|
16
|
-
IRequiredContext
|
|
17
|
-
} from './types'
|
|
18
|
-
|
|
19
|
-
export function createAuthRequestUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ICreateAuthRequestWebappEndpointOpts) {
|
|
20
|
-
if (opts?.enabled === false) {
|
|
21
|
-
console.log(`createAuthRequest universal OID4VP endpoint is disabled`)
|
|
22
|
-
return
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
const path = opts?.path ?? '/backend/auth/requests'
|
|
26
|
-
router.post(path, checkAuth(opts?.endpoint), validateData(CreateAuthorizationRequestBodySchema), async (request: CreateAuthorizationRequest, response: CreateAuthorizationResponse) => {
|
|
27
|
-
try {
|
|
28
|
-
const correlationId = request.body.correlation_id ?? uuid.uuid()
|
|
29
|
-
const qrCodeOpts = request.body.qr_code ?? opts?.qrCodeOpts
|
|
30
|
-
const queryId = request.body.query_id
|
|
31
|
-
const directPostResponseRedirectUri = request.body.direct_post_response_redirect_uri // TODO Uri not URI
|
|
32
|
-
const requestUriBase = request.body.request_uri_base
|
|
33
|
-
|
|
34
|
-
try {
|
|
35
|
-
await context.agent.pdmGetDefinition({ itemId: queryId })
|
|
36
|
-
} catch(e) {
|
|
37
|
-
console.log(`No query could be found for the given id. Query id: ${queryId}`)
|
|
38
|
-
return sendErrorResponse(response, 404, { status: 404, message: 'No query could be found' })
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
const requestByReferenceURI = uriWithBase(`/siop/definitions/${queryId}/auth-requests/${correlationId}`, {
|
|
42
|
-
baseURI: requestUriBase ?? opts?.siopBaseURI,
|
|
43
|
-
})
|
|
44
|
-
const responseURI = uriWithBase(`/siop/definitions/${queryId}/auth-responses/${correlationId}`, { baseURI: opts?.siopBaseURI })
|
|
45
|
-
|
|
46
|
-
const authRequestURI = await context.agent.siopCreateAuthRequestURI({
|
|
47
|
-
queryId,
|
|
48
|
-
correlationId,
|
|
49
|
-
nonce: uuid.uuid(),
|
|
50
|
-
requestByReferenceURI,
|
|
51
|
-
responseURIType: 'response_uri',
|
|
52
|
-
responseURI,
|
|
53
|
-
...(directPostResponseRedirectUri && { responseRedirectURI: directPostResponseRedirectUri }),
|
|
54
|
-
})
|
|
55
|
-
|
|
56
|
-
let qrCodeDataUri: string | undefined
|
|
57
|
-
if (qrCodeOpts) {
|
|
58
|
-
const { AwesomeQR } = await import('awesome-qr')
|
|
59
|
-
const qrCode = new AwesomeQR({ ...qrCodeOpts, text: authRequestURI })
|
|
60
|
-
qrCodeDataUri = `data:image/png;base64,${(await qrCode.draw())!.toString('base64')}`
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
const authRequestBody = {
|
|
64
|
-
query_id: queryId,
|
|
65
|
-
correlation_id: correlationId,
|
|
66
|
-
request_uri: authRequestURI,
|
|
67
|
-
status_uri: `${uriWithBase(opts?.webappAuthStatusPath ?? `/backend/auth/status/${correlationId}`, { baseURI: opts?.webappBaseURI })}`,
|
|
68
|
-
...(qrCodeDataUri && { qr_uri: qrCodeDataUri }),
|
|
69
|
-
} satisfies CreateAuthorizationRequestResponse
|
|
70
|
-
console.log(`Auth Request URI data to send back: ${JSON.stringify(authRequestBody)}`)
|
|
71
|
-
|
|
72
|
-
return response.status(201).json(authRequestBody)
|
|
73
|
-
} catch (error) {
|
|
74
|
-
return sendErrorResponse(response, 500, { status: 500, message: 'Could not create an authorization request URI' }, error)
|
|
75
|
-
}
|
|
76
|
-
})
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
export function removeAuthRequestStateUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ISingleEndpointOpts) {
|
|
80
|
-
if (opts?.enabled === false) {
|
|
81
|
-
console.log(`removeAuthStatus universal OID4VP endpoint is disabled`)
|
|
82
|
-
return
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
const path = opts?.path ?? '/backend/auth/requests/:correlationId'
|
|
86
|
-
router.delete(path, checkAuth(opts?.endpoint), async (request: DeleteAuthorizationRequest, response: Response) => {
|
|
87
|
-
try {
|
|
88
|
-
const correlationId: string = request.params.correlationId
|
|
89
|
-
|
|
90
|
-
const authRequestState = await context.agent.siopGetAuthRequestState({
|
|
91
|
-
correlationId,
|
|
92
|
-
errorOnNotFound: false
|
|
93
|
-
})
|
|
94
|
-
if (!authRequestState) {
|
|
95
|
-
console.log(`No authorization request could be found for the given correlationId. correlationId: ${correlationId}`)
|
|
96
|
-
return sendErrorResponse(response, 404, { status: 404, message: 'No authorization request could be found' })
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
await context.agent.siopDeleteAuthState({ correlationId })
|
|
100
|
-
|
|
101
|
-
return response.status(204).json()
|
|
102
|
-
} catch (error) {
|
|
103
|
-
return sendErrorResponse(response, 500, { status: 500, message: error.message }, error)
|
|
104
|
-
}
|
|
105
|
-
})
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
export function authStatusUniversalOID4VPEndpoint(router: Router, context: IRequiredContext, opts?: ISingleEndpointOpts) {
|
|
109
|
-
if (opts?.enabled === false) {
|
|
110
|
-
console.log(`authStatus universal OID4VP endpoint is disabled`)
|
|
111
|
-
return
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
const path = opts?.path ?? '/backend/auth/status/:correlationId'
|
|
115
|
-
router.get(path, checkAuth(opts?.endpoint), async (request: GetAuthorizationRequestStatus, response: Response) => {
|
|
116
|
-
try {
|
|
117
|
-
console.log('Received auth-status request...')
|
|
118
|
-
const correlationId: string = request.params.correlationId
|
|
119
|
-
|
|
120
|
-
const requestState = await context.agent.siopGetAuthRequestState({
|
|
121
|
-
correlationId,
|
|
122
|
-
errorOnNotFound: false
|
|
123
|
-
})
|
|
124
|
-
|
|
125
|
-
if (!requestState) {
|
|
126
|
-
console.log(`No authorization request could be found for the given correlationId. correlationId: ${correlationId}`)
|
|
127
|
-
return sendErrorResponse(response, 404, { status: 404, message: 'No authorization request could be found' })
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
let responseState
|
|
131
|
-
if (requestState.status === 'authorization_request_created') {
|
|
132
|
-
responseState = (await context.agent.siopGetAuthResponseState({ correlationId, errorOnNotFound: false }))
|
|
133
|
-
}
|
|
134
|
-
const overallState = responseState ?? requestState
|
|
135
|
-
|
|
136
|
-
const statusBody = {
|
|
137
|
-
status: overallState.status,
|
|
138
|
-
correlation_id: overallState.correlationId,
|
|
139
|
-
query_id: overallState.queryId,
|
|
140
|
-
last_updated: overallState.lastUpdated,
|
|
141
|
-
...((responseState?.status === AuthorizationResponseStateStatus.VERIFIED && responseState.verifiedData !== undefined) && { verifiedData: responseState.verifiedData }),
|
|
142
|
-
...(overallState.error && { message: overallState.error.message })
|
|
143
|
-
} satisfies GetAuthStatusResponse
|
|
144
|
-
console.debug(`Will send auth status: ${JSON.stringify(statusBody)}`)
|
|
145
|
-
|
|
146
|
-
if (overallState.status === 'error') {
|
|
147
|
-
return response.status(500).json(statusBody)
|
|
148
|
-
}
|
|
149
|
-
return response.status(200).json(statusBody)
|
|
150
|
-
} catch (error) {
|
|
151
|
-
return sendErrorResponse(response, 500, { status: 500, message: error.message }, error)
|
|
152
|
-
}
|
|
153
|
-
})
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
export function getDefinitionsEndpoint(router: Router, context: IRequiredContext, opts?: ISingleEndpointOpts) {
|
|
157
|
-
if (opts?.enabled === false) {
|
|
158
|
-
console.log(`getDefinitions universal OID4VP endpoint is disabled`)
|
|
159
|
-
return
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
const path = opts?.path ?? '/backend/definitions'
|
|
163
|
-
router.get(path, checkAuth(opts?.endpoint), async (request: Request, response: Response) => {
|
|
164
|
-
try {
|
|
165
|
-
const definitions = await context.agent.pdmGetDefinitions()
|
|
166
|
-
response.statusCode = 200
|
|
167
|
-
return response.json(definitions)
|
|
168
|
-
} catch (error) {
|
|
169
|
-
return sendErrorResponse(response, 500, { status: 500, message: error.message }, error)
|
|
170
|
-
}
|
|
171
|
-
})
|
|
172
|
-
}
|