-
Notifications
You must be signed in to change notification settings - Fork 188
/
BaseCredentialProtocol.ts
348 lines (304 loc) · 12.9 KB
/
BaseCredentialProtocol.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
import type { CredentialProtocol } from './CredentialProtocol'
import type {
CreateCredentialProposalOptions,
CredentialProtocolMsgReturnType,
DeleteCredentialOptions,
AcceptCredentialProposalOptions,
NegotiateCredentialProposalOptions,
CreateCredentialOfferOptions,
NegotiateCredentialOfferOptions,
CreateCredentialRequestOptions,
AcceptCredentialOfferOptions,
AcceptCredentialRequestOptions,
AcceptCredentialOptions,
GetCredentialFormatDataReturn,
CreateCredentialProblemReportOptions,
} from './CredentialProtocolOptions'
import type { AgentContext } from '../../../agent'
import type { AgentMessage } from '../../../agent/AgentMessage'
import type { FeatureRegistry } from '../../../agent/FeatureRegistry'
import type { InboundMessageContext } from '../../../agent/models/InboundMessageContext'
import type { DependencyManager } from '../../../plugins'
import type { Query, QueryOptions } from '../../../storage/StorageService'
import type { ProblemReportMessage } from '../../problem-reports'
import type { CredentialStateChangedEvent } from '../CredentialEvents'
import type { CredentialFormatService, ExtractCredentialFormats } from '../formats'
import type { CredentialRole } from '../models'
import type { CredentialExchangeRecord } from '../repository'
import { EventEmitter } from '../../../agent/EventEmitter'
import { DidCommMessageRepository } from '../../../storage/didcomm'
import { ConnectionService } from '../../connections'
import { CredentialEventTypes } from '../CredentialEvents'
import { CredentialState } from '../models/CredentialState'
import { CredentialRepository } from '../repository'
/**
* Base implementation of the CredentialProtocol that can be used as a foundation for implementing
* the CredentialProtocol interface.
*/
export abstract class BaseCredentialProtocol<CFs extends CredentialFormatService[] = CredentialFormatService[]>
implements CredentialProtocol<CFs>
{
public abstract readonly version: string
protected abstract getFormatServiceForRecordType(credentialRecordType: string): CFs[number]
// methods for proposal
public abstract createProposal(
agentContext: AgentContext,
options: CreateCredentialProposalOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
public abstract processProposal(
messageContext: InboundMessageContext<AgentMessage>
): Promise<CredentialExchangeRecord>
public abstract acceptProposal(
agentContext: AgentContext,
options: AcceptCredentialProposalOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
public abstract negotiateProposal(
agentContext: AgentContext,
options: NegotiateCredentialProposalOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
// methods for offer
public abstract createOffer(
agentContext: AgentContext,
options: CreateCredentialOfferOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
public abstract processOffer(messageContext: InboundMessageContext<AgentMessage>): Promise<CredentialExchangeRecord>
public abstract acceptOffer(
agentContext: AgentContext,
options: AcceptCredentialOfferOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
public abstract negotiateOffer(
agentContext: AgentContext,
options: NegotiateCredentialOfferOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
// methods for request
public abstract createRequest(
agentContext: AgentContext,
options: CreateCredentialRequestOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
public abstract processRequest(messageContext: InboundMessageContext<AgentMessage>): Promise<CredentialExchangeRecord>
public abstract acceptRequest(
agentContext: AgentContext,
options: AcceptCredentialRequestOptions<CFs>
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
// methods for issue
public abstract processCredential(
messageContext: InboundMessageContext<AgentMessage>
): Promise<CredentialExchangeRecord>
public abstract acceptCredential(
agentContext: AgentContext,
options: AcceptCredentialOptions
): Promise<CredentialProtocolMsgReturnType<AgentMessage>>
// methods for ack
public abstract processAck(messageContext: InboundMessageContext<AgentMessage>): Promise<CredentialExchangeRecord>
// methods for problem-report
public abstract createProblemReport(
agentContext: AgentContext,
options: CreateCredentialProblemReportOptions
): Promise<CredentialProtocolMsgReturnType<ProblemReportMessage>>
public abstract findProposalMessage(
agentContext: AgentContext,
credentialExchangeId: string
): Promise<AgentMessage | null>
public abstract findOfferMessage(
agentContext: AgentContext,
credentialExchangeId: string
): Promise<AgentMessage | null>
public abstract findRequestMessage(
agentContext: AgentContext,
credentialExchangeId: string
): Promise<AgentMessage | null>
public abstract findCredentialMessage(
agentContext: AgentContext,
credentialExchangeId: string
): Promise<AgentMessage | null>
public abstract getFormatData(
agentContext: AgentContext,
credentialExchangeId: string
): Promise<GetCredentialFormatDataReturn<ExtractCredentialFormats<CFs>>>
public abstract register(dependencyManager: DependencyManager, featureRegistry: FeatureRegistry): void
/**
* Process a received credential {@link ProblemReportMessage}.
*
* @param messageContext The message context containing a credential problem report message
* @returns credential record associated with the credential problem report message
*/
public async processProblemReport(
messageContext: InboundMessageContext<ProblemReportMessage>
): Promise<CredentialExchangeRecord> {
const { message: credentialProblemReportMessage, agentContext, connection } = messageContext
const connectionService = agentContext.dependencyManager.resolve(ConnectionService)
agentContext.config.logger.debug(`Processing problem report with message id ${credentialProblemReportMessage.id}`)
const credentialRecord = await this.getByProperties(agentContext, {
threadId: credentialProblemReportMessage.threadId,
})
// Assert
await connectionService.assertConnectionOrOutOfBandExchange(messageContext, {
expectedConnectionId: credentialRecord.connectionId,
})
// This makes sure that the sender of the incoming message is authorized to do so.
if (!credentialRecord?.connectionId) {
await connectionService.matchIncomingMessageToRequestMessageInOutOfBandExchange(messageContext, {
expectedConnectionId: credentialRecord?.connectionId,
})
credentialRecord.connectionId = connection?.id
}
// Update record
credentialRecord.errorMessage = `${credentialProblemReportMessage.description.code}: ${credentialProblemReportMessage.description.en}`
await this.updateState(agentContext, credentialRecord, CredentialState.Abandoned)
return credentialRecord
}
/**
* Update the record to a new state and emit an state changed event. Also updates the record
* in storage.
*
* @param credentialRecord The credential record to update the state for
* @param newState The state to update to
*
*/
public async updateState(
agentContext: AgentContext,
credentialRecord: CredentialExchangeRecord,
newState: CredentialState
) {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
agentContext.config.logger.debug(
`Updating credential record ${credentialRecord.id} to state ${newState} (previous=${credentialRecord.state})`
)
const previousState = credentialRecord.state
credentialRecord.state = newState
await credentialRepository.update(agentContext, credentialRecord)
this.emitStateChangedEvent(agentContext, credentialRecord, previousState)
}
protected emitStateChangedEvent(
agentContext: AgentContext,
credentialRecord: CredentialExchangeRecord,
previousState: CredentialState | null
) {
const eventEmitter = agentContext.dependencyManager.resolve(EventEmitter)
eventEmitter.emit<CredentialStateChangedEvent>(agentContext, {
type: CredentialEventTypes.CredentialStateChanged,
payload: {
credentialRecord: credentialRecord.clone(),
previousState: previousState,
},
})
}
/**
* Retrieve a credential record by id
*
* @param credentialRecordId The credential record id
* @throws {RecordNotFoundError} If no record is found
* @return The credential record
*
*/
public getById(agentContext: AgentContext, credentialRecordId: string): Promise<CredentialExchangeRecord> {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.getById(agentContext, credentialRecordId)
}
/**
* Retrieve all credential records
*
* @returns List containing all credential records
*/
public getAll(agentContext: AgentContext): Promise<CredentialExchangeRecord[]> {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.getAll(agentContext)
}
public async findAllByQuery(
agentContext: AgentContext,
query: Query<CredentialExchangeRecord>,
queryOptions?: QueryOptions
): Promise<CredentialExchangeRecord[]> {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.findByQuery(agentContext, query, queryOptions)
}
/**
* Find a credential record by id
*
* @param credentialRecordId the credential record id
* @returns The credential record or null if not found
*/
public findById(agentContext: AgentContext, proofRecordId: string): Promise<CredentialExchangeRecord | null> {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.findById(agentContext, proofRecordId)
}
public async delete(
agentContext: AgentContext,
credentialRecord: CredentialExchangeRecord,
options?: DeleteCredentialOptions
): Promise<void> {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
const didCommMessageRepository = agentContext.dependencyManager.resolve(DidCommMessageRepository)
await credentialRepository.delete(agentContext, credentialRecord)
const deleteAssociatedCredentials = options?.deleteAssociatedCredentials ?? true
const deleteAssociatedDidCommMessages = options?.deleteAssociatedDidCommMessages ?? true
if (deleteAssociatedCredentials) {
for (const credential of credentialRecord.credentials) {
const formatService = this.getFormatServiceForRecordType(credential.credentialRecordType)
await formatService.deleteCredentialById(agentContext, credential.credentialRecordId)
}
}
if (deleteAssociatedDidCommMessages) {
const didCommMessages = await didCommMessageRepository.findByQuery(agentContext, {
associatedRecordId: credentialRecord.id,
})
for (const didCommMessage of didCommMessages) {
await didCommMessageRepository.delete(agentContext, didCommMessage)
}
}
}
/**
* Retrieve a credential record by connection id and thread id
*
* @param properties Properties to query by
*
* @throws {RecordNotFoundError} If no record is found
* @throws {RecordDuplicateError} If multiple records are found
* @returns The credential record
*/
public getByProperties(
agentContext: AgentContext,
properties: {
threadId: string
role?: CredentialRole
connectionId?: string
}
): Promise<CredentialExchangeRecord> {
const { role, connectionId, threadId } = properties
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.getSingleByQuery(agentContext, {
connectionId,
threadId,
role,
})
}
/**
* Find a credential record by connection id and thread id, returns null if not found
*
* @param threadId The thread id
* @param role The role of the record, i.e. holder or issuer
* @param connectionId The connection id
*
* @returns The credential record
*/
public findByProperties(
agentContext: AgentContext,
properties: {
threadId: string
role?: CredentialRole
connectionId?: string
}
): Promise<CredentialExchangeRecord | null> {
const { role, connectionId, threadId } = properties
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return credentialRepository.findSingleByQuery(agentContext, {
connectionId,
threadId,
role,
})
}
public async update(agentContext: AgentContext, credentialRecord: CredentialExchangeRecord) {
const credentialRepository = agentContext.dependencyManager.resolve(CredentialRepository)
return await credentialRepository.update(agentContext, credentialRecord)
}
}