-
Notifications
You must be signed in to change notification settings - Fork 186
/
AskarWallet.ts
422 lines (359 loc) · 13.4 KB
/
AskarWallet.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
import type { WalletConfig, WalletConfigRekey, WalletExportImportConfig } from '@credo-ts/core'
import {
WalletExportPathExistsError,
WalletInvalidKeyError,
WalletDuplicateError,
CredoError,
Logger,
WalletError,
InjectionSymbols,
SigningProviderRegistry,
FileSystem,
WalletNotFoundError,
KeyDerivationMethod,
WalletImportPathExistsError,
WalletExportUnsupportedError,
} from '@credo-ts/core'
import { Store } from '@hyperledger/aries-askar-shared'
import { inject, injectable } from 'tsyringe'
import { AskarErrorCode, isAskarError, keyDerivationMethodToStoreKeyMethod, uriFromWalletConfig } from '../utils'
import { AskarBaseWallet } from './AskarBaseWallet'
import { isAskarWalletSqliteStorageConfig } from './AskarWalletStorageConfig'
/**
* @todo: rename after 0.5.0, as we now have multiple types of AskarWallet
*/
@injectable()
export class AskarWallet extends AskarBaseWallet {
private fileSystem: FileSystem
private walletConfig?: WalletConfig
private _store?: Store
public constructor(
@inject(InjectionSymbols.Logger) logger: Logger,
@inject(InjectionSymbols.FileSystem) fileSystem: FileSystem,
signingKeyProviderRegistry: SigningProviderRegistry
) {
super(logger, signingKeyProviderRegistry)
this.fileSystem = fileSystem
}
public get isProvisioned() {
return this.walletConfig !== undefined
}
public get isInitialized() {
return this._store !== undefined
}
public get store() {
if (!this._store) {
throw new CredoError(
'Wallet has not been initialized yet. Make sure to await agent.initialize() before using the agent.'
)
}
return this._store
}
public get profile() {
if (!this.walletConfig) {
throw new WalletError('No profile configured.')
}
return this.walletConfig.id
}
/**
* Dispose method is called when an agent context is disposed.
*/
public async dispose() {
if (this.isInitialized) {
await this.close()
}
}
/**
* @throws {WalletDuplicateError} if the wallet already exists
* @throws {WalletError} if another error occurs
*/
public async create(walletConfig: WalletConfig): Promise<void> {
await this.createAndOpen(walletConfig)
await this.close()
}
/**
* @throws {WalletDuplicateError} if the wallet already exists
* @throws {WalletError} if another error occurs
*/
public async createAndOpen(walletConfig: WalletConfig): Promise<void> {
this.logger.debug(`Creating wallet '${walletConfig.id}`)
const askarWalletConfig = await this.getAskarWalletConfig(walletConfig)
// Check if database exists
const { path: filePath } = uriFromWalletConfig(walletConfig, this.fileSystem.dataPath)
if (filePath && (await this.fileSystem.exists(filePath))) {
throw new WalletDuplicateError(`Wallet '${walletConfig.id}' already exists.`, {
walletType: 'AskarWallet',
})
}
try {
// Make sure path exists before creating the wallet
if (filePath) {
await this.fileSystem.createDirectory(filePath)
}
this._store = await Store.provision({
recreate: false,
uri: askarWalletConfig.uri,
profile: askarWalletConfig.profile,
keyMethod: askarWalletConfig.keyMethod,
passKey: askarWalletConfig.passKey,
})
// TODO: Should we do something to check if it exists?
// Like this.withSession()?
this.walletConfig = walletConfig
} catch (error) {
// FIXME: Askar should throw a Duplicate error code, but is currently returning Encryption
// And if we provide the very same wallet key, it will open it without any error
if (
isAskarError(error) &&
(error.code === AskarErrorCode.Encryption || error.code === AskarErrorCode.Duplicate)
) {
const errorMessage = `Wallet '${walletConfig.id}' already exists`
this.logger.debug(errorMessage)
throw new WalletDuplicateError(errorMessage, {
walletType: 'AskarWallet',
cause: error,
})
}
const errorMessage = `Error creating wallet '${walletConfig.id}'`
this.logger.error(errorMessage, {
error,
errorMessage: error.message,
})
throw new WalletError(errorMessage, { cause: error })
}
this.logger.debug(`Successfully created wallet '${walletConfig.id}'`)
}
/**
* @throws {WalletNotFoundError} if the wallet does not exist
* @throws {WalletError} if another error occurs
*/
public async open(walletConfig: WalletConfig): Promise<void> {
await this._open(walletConfig)
}
/**
* @throws {WalletNotFoundError} if the wallet does not exist
* @throws {WalletError} if another error occurs
*/
public async rotateKey(walletConfig: WalletConfigRekey): Promise<void> {
if (!walletConfig.rekey) {
throw new WalletError('Wallet rekey undefined!. Please specify the new wallet key')
}
await this._open(
{
id: walletConfig.id,
key: walletConfig.key,
keyDerivationMethod: walletConfig.keyDerivationMethod,
},
walletConfig.rekey,
walletConfig.rekeyDerivationMethod
)
}
/**
* @throws {WalletNotFoundError} if the wallet does not exist
* @throws {WalletError} if another error occurs
*/
private async _open(
walletConfig: WalletConfig,
rekey?: string,
rekeyDerivation?: KeyDerivationMethod
): Promise<void> {
if (this._store) {
throw new WalletError(
'Wallet instance already opened. Close the currently opened wallet before re-opening the wallet'
)
}
const askarWalletConfig = await this.getAskarWalletConfig(walletConfig)
try {
this._store = await Store.open({
uri: askarWalletConfig.uri,
keyMethod: askarWalletConfig.keyMethod,
passKey: askarWalletConfig.passKey,
})
if (rekey) {
await this._store.rekey({
passKey: rekey,
keyMethod: keyDerivationMethodToStoreKeyMethod(rekeyDerivation ?? KeyDerivationMethod.Argon2IMod),
})
}
// TODO: Should we do something to check if it exists?
// Like this.withSession()?
this.walletConfig = walletConfig
} catch (error) {
if (
isAskarError(error) &&
(error.code === AskarErrorCode.NotFound ||
(error.code === AskarErrorCode.Backend &&
isAskarWalletSqliteStorageConfig(walletConfig.storage) &&
walletConfig.storage.config?.inMemory))
) {
const errorMessage = `Wallet '${walletConfig.id}' not found`
this.logger.debug(errorMessage)
throw new WalletNotFoundError(errorMessage, {
walletType: 'AskarWallet',
cause: error,
})
} else if (isAskarError(error) && error.code === AskarErrorCode.Encryption) {
const errorMessage = `Incorrect key for wallet '${walletConfig.id}'`
this.logger.debug(errorMessage)
throw new WalletInvalidKeyError(errorMessage, {
walletType: 'AskarWallet',
cause: error,
})
}
throw new WalletError(`Error opening wallet ${walletConfig.id}: ${error.message}`, { cause: error })
}
this.logger.debug(`Wallet '${walletConfig.id}' opened with handle '${this._store.handle.handle}'`)
}
/**
* @throws {WalletNotFoundError} if the wallet does not exist
* @throws {WalletError} if another error occurs
*/
public async delete(): Promise<void> {
if (!this.walletConfig) {
throw new WalletError(
'Can not delete wallet that does not have wallet config set. Make sure to call create wallet before deleting the wallet'
)
}
this.logger.info(`Deleting wallet '${this.walletConfig.id}'`)
if (this._store) {
await this.close()
}
try {
const { uri } = uriFromWalletConfig(this.walletConfig, this.fileSystem.dataPath)
await Store.remove(uri)
} catch (error) {
const errorMessage = `Error deleting wallet '${this.walletConfig.id}': ${error.message}`
this.logger.error(errorMessage, {
error,
errorMessage: error.message,
})
throw new WalletError(errorMessage, { cause: error })
}
}
public async export(exportConfig: WalletExportImportConfig) {
if (!this.walletConfig) {
throw new WalletError(
'Can not export wallet that does not have wallet config set. Make sure to open it before exporting'
)
}
const { path: destinationPath, key: exportKey } = exportConfig
const { path: sourcePath } = uriFromWalletConfig(this.walletConfig, this.fileSystem.dataPath)
if (isAskarWalletSqliteStorageConfig(this.walletConfig.storage) && this.walletConfig.storage?.inMemory) {
throw new WalletExportUnsupportedError('Export is not supported for in memory wallet')
}
if (!sourcePath) {
throw new WalletExportUnsupportedError('Export is only supported for SQLite backend')
}
try {
// Export path already exists
if (await this.fileSystem.exists(destinationPath)) {
throw new WalletExportPathExistsError(
`Unable to create export, wallet export at path '${exportConfig.path}' already exists`
)
}
const exportedWalletConfig = await this.getAskarWalletConfig({
...this.walletConfig,
key: exportKey,
storage: { type: 'sqlite', config: { path: destinationPath } },
})
// Make sure destination path exists
await this.fileSystem.createDirectory(destinationPath)
await this.store.copyTo({
recreate: false,
uri: exportedWalletConfig.uri,
keyMethod: exportedWalletConfig.keyMethod,
passKey: exportedWalletConfig.passKey,
})
} catch (error) {
const errorMessage = `Error exporting wallet '${this.walletConfig.id}': ${error.message}`
this.logger.error(errorMessage, {
error,
errorMessage: error.message,
})
if (error instanceof WalletExportPathExistsError) throw error
throw new WalletError(errorMessage, { cause: error })
}
}
public async import(walletConfig: WalletConfig, importConfig: WalletExportImportConfig) {
const { path: sourcePath, key: importKey } = importConfig
const { path: destinationPath } = uriFromWalletConfig(walletConfig, this.fileSystem.dataPath)
if (!destinationPath) {
throw new WalletError('Import is only supported for SQLite backend')
}
let sourceWalletStore: Store | undefined = undefined
try {
const importWalletConfig = await this.getAskarWalletConfig(walletConfig)
// Import path already exists
if (await this.fileSystem.exists(destinationPath)) {
throw new WalletExportPathExistsError(`Unable to import wallet. Path '${destinationPath}' already exists`)
}
// Make sure destination path exists
await this.fileSystem.createDirectory(destinationPath)
// Open imported wallet and copy to destination
sourceWalletStore = await Store.open({
uri: `sqlite://${sourcePath}`,
keyMethod: importWalletConfig.keyMethod,
passKey: importKey,
})
const defaultProfile = await sourceWalletStore.getDefaultProfile()
if (defaultProfile !== importWalletConfig.profile) {
throw new WalletError(
`Trying to import wallet with walletConfig.id ${importWalletConfig.profile}, however the wallet contains a default profile with id ${defaultProfile}. The walletConfig.id MUST match with the default profile. In the future this behavior may be changed. See https://github.com/hyperledger/aries-askar/issues/221 for more information.`
)
}
await sourceWalletStore.copyTo({
recreate: false,
uri: importWalletConfig.uri,
keyMethod: importWalletConfig.keyMethod,
passKey: importWalletConfig.passKey,
})
await sourceWalletStore.close()
} catch (error) {
await sourceWalletStore?.close()
const errorMessage = `Error importing wallet '${walletConfig.id}': ${error.message}`
this.logger.error(errorMessage, {
error,
errorMessage: error.message,
})
if (error instanceof WalletImportPathExistsError) throw error
// Cleanup any wallet file we could have created
if (await this.fileSystem.exists(destinationPath)) {
await this.fileSystem.delete(destinationPath)
}
throw new WalletError(errorMessage, { cause: error })
}
}
/**
* @throws {WalletError} if the wallet is already closed or another error occurs
*/
public async close(): Promise<void> {
this.logger.debug(`Closing wallet ${this.walletConfig?.id}`)
if (!this._store) {
throw new WalletError('Wallet is in invalid state, you are trying to close wallet that has no handle.')
}
try {
await this.store.close()
this._store = undefined
} catch (error) {
const errorMessage = `Error closing wallet': ${error.message}`
this.logger.error(errorMessage, {
error,
errorMessage: error.message,
})
throw new WalletError(errorMessage, { cause: error })
}
}
private async getAskarWalletConfig(walletConfig: WalletConfig) {
const { uri, path } = uriFromWalletConfig(walletConfig, this.fileSystem.dataPath)
return {
uri,
path,
profile: walletConfig.id,
// FIXME: Default derivation method should be set somewhere in either agent config or some constants
keyMethod: keyDerivationMethodToStoreKeyMethod(
walletConfig.keyDerivationMethod ?? KeyDerivationMethod.Argon2IMod
),
passKey: walletConfig.key,
}
}
}