-
Notifications
You must be signed in to change notification settings - Fork 197
/
w3cAnonCredsUtils.ts
223 lines (199 loc) · 8.6 KB
/
w3cAnonCredsUtils.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
import type { AnonCredsClaimRecord } from './credential'
import type { W3cAnonCredsCredentialMetadata } from './metadata'
import type { AnonCredsCredentialInfo, AnonCredsSchema } from '../models'
import type { AnonCredsCredentialRecord } from '../repository'
import type { StoreCredentialOptions } from '../services'
import type { DefaultW3cCredentialTags, W3cCredentialSubject } from '@credo-ts/core'
import { CredoError, W3cCredentialRecord, utils } from '@credo-ts/core'
import { mapAttributeRawValuesToAnonCredsCredentialValues } from './credential'
import {
getQualifiedDidIndyCredentialDefinition,
getQualifiedDidIndyDid,
getQualifiedDidIndyRevocationRegistryDefinition,
getQualifiedDidIndySchema,
isUnqualifiedDidIndyCredentialDefinition,
isUnqualifiedDidIndyRevocationRegistryDefinition,
isUnqualifiedDidIndySchema,
isUnqualifiedCredentialDefinitionId,
isUnqualifiedRevocationRegistryId,
isIndyDid,
getUnQualifiedDidIndyDid,
} from './indyIdentifiers'
import { W3cAnonCredsCredentialMetadataKey } from './metadata'
export type AnonCredsCredentialTags = {
anonCredsLinkSecretId: string
anonCredsCredentialRevocationId?: string
anonCredsMethodName: string
// the following keys can be used for every `attribute name` in credential.
[key: `anonCredsAttr::${string}::marker`]: true | undefined
[key: `anonCredsAttr::${string}::value`]: string | undefined
anonCredsSchemaName: string
anonCredsSchemaVersion: string
anonCredsSchemaId: string
anonCredsSchemaIssuerId: string
anonCredsCredentialDefinitionId: string
anonCredsRevocationRegistryId?: string
anonCredsUnqualifiedIssuerId?: string
anonCredsUnqualifiedSchemaId?: string
anonCredsUnqualifiedSchemaIssuerId?: string
anonCredsUnqualifiedCredentialDefinitionId?: string
anonCredsUnqualifiedRevocationRegistryId?: string
}
function anonCredsCredentialInfoFromW3cRecord(w3cCredentialRecord: W3cCredentialRecord): AnonCredsCredentialInfo {
if (Array.isArray(w3cCredentialRecord.credential.credentialSubject)) {
throw new CredoError('Credential subject must be an object, not an array.')
}
const anonCredsTags = getAnonCredsTagsFromRecord(w3cCredentialRecord)
if (!anonCredsTags) throw new CredoError('AnonCreds tags not found on credential record.')
const anonCredsCredentialMetadata = w3cCredentialRecord.metadata.get<W3cAnonCredsCredentialMetadata>(
W3cAnonCredsCredentialMetadataKey
)
if (!anonCredsCredentialMetadata) throw new CredoError('AnonCreds metadata not found on credential record.')
return {
attributes: (w3cCredentialRecord.credential.credentialSubject.claims as AnonCredsClaimRecord) ?? {},
credentialId: w3cCredentialRecord.id,
credentialDefinitionId: anonCredsTags.anonCredsCredentialDefinitionId,
schemaId: anonCredsTags.anonCredsSchemaId,
credentialRevocationId: anonCredsCredentialMetadata.credentialRevocationId ?? null,
revocationRegistryId: anonCredsTags.anonCredsRevocationRegistryId ?? null,
methodName: anonCredsCredentialMetadata.methodName,
linkSecretId: anonCredsCredentialMetadata.linkSecretId,
createdAt: w3cCredentialRecord.createdAt,
updatedAt: w3cCredentialRecord.updatedAt ?? w3cCredentialRecord.createdAt,
}
}
function anonCredsCredentialInfoFromAnonCredsRecord(
anonCredsCredentialRecord: AnonCredsCredentialRecord
): AnonCredsCredentialInfo {
const attributes: { [key: string]: string } = {}
for (const attribute in anonCredsCredentialRecord.credential) {
attributes[attribute] = anonCredsCredentialRecord.credential.values[attribute].raw
}
return {
attributes,
credentialDefinitionId: anonCredsCredentialRecord.credential.cred_def_id,
credentialId: anonCredsCredentialRecord.credentialId,
schemaId: anonCredsCredentialRecord.credential.schema_id,
credentialRevocationId: anonCredsCredentialRecord.credentialRevocationId ?? null,
revocationRegistryId: anonCredsCredentialRecord.credential.rev_reg_id ?? null,
methodName: anonCredsCredentialRecord.methodName,
linkSecretId: anonCredsCredentialRecord.linkSecretId,
createdAt: anonCredsCredentialRecord.createdAt,
updatedAt: anonCredsCredentialRecord.updatedAt ?? anonCredsCredentialRecord.createdAt,
}
}
export function getAnoncredsCredentialInfoFromRecord(
credentialRecord: W3cCredentialRecord | AnonCredsCredentialRecord
): AnonCredsCredentialInfo {
if (credentialRecord instanceof W3cCredentialRecord) {
return anonCredsCredentialInfoFromW3cRecord(credentialRecord)
} else {
return anonCredsCredentialInfoFromAnonCredsRecord(credentialRecord)
}
}
export function getAnonCredsTagsFromRecord(record: W3cCredentialRecord) {
const anoncredsMetadata = record.metadata.get<W3cAnonCredsCredentialMetadata>(W3cAnonCredsCredentialMetadataKey)
if (!anoncredsMetadata) return undefined
const tags = record.getTags() as DefaultW3cCredentialTags & Partial<AnonCredsCredentialTags>
if (
!tags.anonCredsLinkSecretId ||
!tags.anonCredsMethodName ||
!tags.anonCredsSchemaId ||
!tags.anonCredsSchemaName ||
!tags.anonCredsSchemaVersion ||
!tags.anonCredsSchemaIssuerId ||
!tags.anonCredsCredentialDefinitionId
) {
return undefined
}
return Object.fromEntries(
Object.entries(tags).filter(([key]) => key.startsWith('anonCreds'))
) as AnonCredsCredentialTags
}
export function getStoreCredentialOptions(
options: StoreCredentialOptions,
indyNamespace?: string
): StoreCredentialOptions {
const {
credentialRequestMetadata,
credentialDefinitionId,
schema,
credential,
credentialDefinition,
revocationRegistry,
} = options
const storeCredentialOptions = {
credentialId: utils.uuid(),
credentialRequestMetadata,
credential,
credentialDefinitionId: isUnqualifiedCredentialDefinitionId(credentialDefinitionId)
? getQualifiedDidIndyDid(credentialDefinitionId, indyNamespace as string)
: credentialDefinitionId,
credentialDefinition: isUnqualifiedDidIndyCredentialDefinition(credentialDefinition)
? getQualifiedDidIndyCredentialDefinition(credentialDefinition, indyNamespace as string)
: credentialDefinition,
schema: isUnqualifiedDidIndySchema(schema) ? getQualifiedDidIndySchema(schema, indyNamespace as string) : schema,
revocationRegistry: revocationRegistry?.definition
? {
definition: isUnqualifiedDidIndyRevocationRegistryDefinition(revocationRegistry.definition)
? getQualifiedDidIndyRevocationRegistryDefinition(revocationRegistry.definition, indyNamespace as string)
: revocationRegistry.definition,
id: isUnqualifiedRevocationRegistryId(revocationRegistry.id)
? getQualifiedDidIndyDid(revocationRegistry.id, indyNamespace as string)
: revocationRegistry.id,
}
: undefined,
}
return storeCredentialOptions
}
export function getW3cRecordAnonCredsTags(options: {
credentialSubject: W3cCredentialSubject
issuerId: string
schemaId: string
schema: Omit<AnonCredsSchema, 'attrNames'>
credentialDefinitionId: string
revocationRegistryId?: string
credentialRevocationId?: string
linkSecretId: string
methodName: string
}) {
const {
credentialSubject,
issuerId,
schema,
schemaId,
credentialDefinitionId,
revocationRegistryId,
credentialRevocationId,
linkSecretId,
methodName,
} = options
const anonCredsCredentialRecordTags: AnonCredsCredentialTags = {
anonCredsLinkSecretId: linkSecretId,
anonCredsCredentialDefinitionId: credentialDefinitionId,
anonCredsSchemaId: schemaId,
anonCredsSchemaName: schema.name,
anonCredsSchemaIssuerId: schema.issuerId,
anonCredsSchemaVersion: schema.version,
anonCredsMethodName: methodName,
anonCredsRevocationRegistryId: revocationRegistryId,
anonCredsCredentialRevocationId: credentialRevocationId,
...(isIndyDid(issuerId) && {
anonCredsUnqualifiedIssuerId: getUnQualifiedDidIndyDid(issuerId),
anonCredsUnqualifiedCredentialDefinitionId: getUnQualifiedDidIndyDid(credentialDefinitionId),
anonCredsUnqualifiedSchemaId: getUnQualifiedDidIndyDid(schemaId),
anonCredsUnqualifiedSchemaIssuerId: getUnQualifiedDidIndyDid(schema.issuerId),
anonCredsUnqualifiedRevocationRegistryId: revocationRegistryId
? getUnQualifiedDidIndyDid(revocationRegistryId)
: undefined,
}),
}
const values = mapAttributeRawValuesToAnonCredsCredentialValues(
(credentialSubject.claims as AnonCredsClaimRecord) ?? {}
)
for (const [key, value] of Object.entries(values)) {
anonCredsCredentialRecordTags[`anonCredsAttr::${key}::value`] = value.raw
anonCredsCredentialRecordTags[`anonCredsAttr::${key}::marker`] = true
}
return anonCredsCredentialRecordTags
}