-
Notifications
You must be signed in to change notification settings - Fork 0
/
keys.data-sign-utils.ts
442 lines (396 loc) · 12.8 KB
/
keys.data-sign-utils.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
import {IKeyValue, stringify} from '@pashoo2/serialization-utils';
import {typedArrayToString, isTypedArray} from '@pashoo2/typed-array-utils';
import {
DATA_SIGN_CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS,
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_USAGES,
DATA_SIGN_CRYPTO_UTIL_PUBLIC_KEY_USAGE,
DATA_SIGN_CRYPTO_UTIL_PRIVATE_KEY_USAGE,
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT,
DATA_SIGN_CRYPTO_UTIL_KEY_DESC,
DATA_SIGN_CRYPTO_UTIL_KEYS_EXTRACTABLE,
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME,
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME,
KEY_NOT_FOUND_ERROR_MESSAGE,
} from './data-sign-utils.const';
import {
TDataSignUtilKeyExportFormatType,
TDataSignUtilKeypairExportFormatType,
TDataSignUtilKeypairImportFormatType,
TDataSignUtilSignKeyTypes,
TDataSignUtilImportKeyTypes,
} from './data-sign-utils.types';
import {cryptoModuleDataSign} from '../init';
import {
isCryptoKeyPair,
getJWKOrBool,
} from '../encryption-keys-utils/encryption-keys-utils';
import {generateSalt} from '../encryption-utils/salt-utils';
import {encryptDataWithPassword} from '../password-utils/encrypt.password-utils';
import {decryptDataByPassword} from '../password-utils/decrypt.password-utils';
import {TDataSignUtilKeypairImportType} from './data-sign-utils.types';
import {DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME} from './data-sign-utils.const';
import {TEncryptionKeyStoreFormatType} from '../types';
import {isCryptoKey} from '../encryption-keys-utils/encryption-keys-utils';
export const dataSignIsCryptoKeyPairImported = (
key: any,
checkPrivateKey = true
): key is TDataSignUtilKeypairExportFormatType => {
return (
typeof key === 'object' &&
!!key[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME] &&
(!checkPrivateKey || !!key[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME])
);
};
export const dataSignGenerateKeyPair = (): PromiseLike<CryptoKeyPair> =>
cryptoModuleDataSign.generateKey(
DATA_SIGN_CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS,
DATA_SIGN_CRYPTO_UTIL_KEYS_EXTRACTABLE,
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_USAGES
);
export const dataSignExportKey = async (
key: CryptoKey
): Promise<TDataSignUtilKeyExportFormatType | Error> => {
try {
return await cryptoModuleDataSign.exportKey(
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT,
key
);
} catch (err) {
return err;
}
};
export const dataSignExportKeyAsString = async (
key: CryptoKey
): Promise<string | Error> => {
const keyExported = await dataSignExportKey(key);
if (keyExported instanceof Error) {
return keyExported;
}
try {
return stringify(keyExported as IKeyValue);
} catch (err) {
return err;
}
};
export const dataSignExportPublicKey = async (
keyPair: CryptoKeyPair
): Promise<TDataSignUtilKeyExportFormatType | Error> => {
if (isCryptoKeyPair(keyPair)) {
return dataSignExportKey(keyPair.publicKey);
}
return new Error('Argument must be a CryptoKeyPair');
};
export const dataSignExportPublicKeyAsString = async (
keyPair: CryptoKeyPair
): Promise<Error | string> => {
try {
const keyPublicExported = await dataSignExportPublicKey(keyPair);
if (keyPublicExported instanceof Error) {
return keyPublicExported;
}
return stringify(keyPublicExported as IKeyValue);
} catch (err) {
return err;
}
};
export const dataSignExportKeyPair = async (
keyPair: CryptoKeyPair,
password?: string
): Promise<TDataSignUtilKeypairExportFormatType | Error> => {
try {
if (isCryptoKeyPair(keyPair, !!password)) {
// do it in parallel
const [privateKey, publicKey] = await Promise.all([
password || keyPair.privateKey
? dataSignExportKey(keyPair.privateKey)
: Promise.resolve(undefined),
dataSignExportKey(keyPair.publicKey),
]).catch(err => [err, err]);
if (privateKey instanceof Error) {
return privateKey;
}
if (publicKey instanceof Error) {
return publicKey;
}
const result: TDataSignUtilKeypairExportFormatType = {
[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME]: publicKey,
[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME]: privateKey,
};
if (password) {
const salt = generateSalt();
if (salt instanceof Error) {
return new Error('Failed to generate a unique salt value');
}
const encryptedPrivateKey = await encryptDataWithPassword(
password,
salt,
privateKey
);
if (encryptedPrivateKey instanceof Error) {
return new Error(
'Failed to encrypt private key with password provided'
);
}
let saltStringified: string;
try {
saltStringified = typedArrayToString(salt);
} catch (err) {
return err;
}
const decryptedPrivateKey = await decryptDataByPassword(
password,
saltStringified,
encryptedPrivateKey
);
if (decryptedPrivateKey instanceof Error) {
return new Error('Failed to decrypt private key for data encryption');
}
result[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME] = saltStringified;
result[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME] =
encryptedPrivateKey;
}
return result;
}
return new Error('Argument given must be a CryptoKeyPair');
} catch (err) {
return err;
}
};
export const dataSignExportKeyPairAsString = async (
keyPair: CryptoKeyPair,
password?: string
): Promise<string | Error> => {
try {
const res = await dataSignExportKeyPair(keyPair, password);
if (res instanceof Error) {
return res;
}
if (isTypedArray(res)) {
return typedArrayToString(res);
}
return stringify(res as JsonWebKey as IKeyValue);
} catch (err) {
return err;
}
};
export const dataSignImportKey = async (
key: TDataSignUtilImportKeyTypes,
isPublic = true
): Promise<CryptoKey | Error> => {
try {
if (typeof key !== 'object') {
return new Error('Unsupported argument type');
}
const res = await cryptoModuleDataSign.importKey(
DATA_SIGN_CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT,
key,
DATA_SIGN_CRYPTO_UTIL_KEY_DESC,
DATA_SIGN_CRYPTO_UTIL_KEYS_EXTRACTABLE,
[
isPublic
? DATA_SIGN_CRYPTO_UTIL_PUBLIC_KEY_USAGE
: DATA_SIGN_CRYPTO_UTIL_PRIVATE_KEY_USAGE,
]
);
if (!isCryptoKey(res)) {
return new Error("Can't import the key");
}
return res;
} catch (err) {
return err;
}
};
export const dataSignImportPublicKey = (
key: TDataSignUtilImportKeyTypes
): PromiseLike<CryptoKey | Error> => dataSignImportKey(key, true);
export const dataSignImportPrivateKey = (
key: TDataSignUtilImportKeyTypes
): PromiseLike<CryptoKey | Error> => dataSignImportKey(key, false);
export const dataSignImportKeyPair = async (
keyPair: TDataSignUtilKeypairImportType,
checkPrivateKey = true
): Promise<TDataSignUtilKeypairImportFormatType | Error> => {
try {
if (dataSignIsCryptoKeyPairImported(keyPair, checkPrivateKey)) {
const privateKeyToImport =
keyPair[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME];
if (checkPrivateKey && !privateKeyToImport) {
return new Error('The private key is empty');
}
const importResult = await Promise.all([
dataSignImportPublicKey(
keyPair[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME]
),
checkPrivateKey || privateKeyToImport
? dataSignImportPrivateKey(privateKeyToImport!)
: (Promise.resolve(undefined) as any),
]).catch(err => [err, err]);
const publicKey = importResult[0];
let privateKey = importResult[1];
if (publicKey instanceof Error) {
return publicKey;
}
if (privateKey instanceof Error) {
if (checkPrivateKey) {
return privateKey;
}
privateKey = undefined;
}
return {
[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME]: publicKey,
[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME]: privateKey,
};
}
return new Error('The argument must be an instance of CryptoKeyPair');
} catch (err) {
return err;
}
};
export const dataSignImportKeyPairFromString = async (
keyPairString: string,
password?: string
): Promise<TDataSignUtilKeypairImportFormatType | Error> => {
try {
if (typeof keyPairString === 'string') {
const keyPairObject = JSON.parse(keyPairString);
if (
password &&
keyPairObject[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME]
) {
if (
typeof keyPairObject[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME] !==
'string'
) {
return new Error('A salt value must be a string');
}
const decryptedPrivateKey = await decryptDataByPassword(
password,
keyPairObject[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME],
keyPairObject[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME]
);
if (decryptedPrivateKey instanceof Error) {
console.error('Failed to decrypt the data sign private key');
return decryptedPrivateKey;
}
try {
keyPairObject[DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME] =
JSON.parse(decryptedPrivateKey);
} catch (err) {
console.error(err);
return new Error(
'Failed to parse datasign Private key from the string decrypted'
);
}
}
if (dataSignIsCryptoKeyPairImported(keyPairObject, !!password)) {
return await dataSignImportKeyPair(
keyPairObject as TDataSignUtilKeypairImportType,
!!password
);
}
return new Error('There is a wrong format for the imported key pair');
}
return new Error('The key must be a string');
} catch (err) {
return err;
}
};
export const dataSignImportKeyFromString = (
keyString: string,
isPublic = true
): PromiseLike<CryptoKey | Error> | Error => {
try {
if (typeof keyString !== 'string') {
return new Error('The key must be a string');
}
const parsedKey = JSON.parse(keyString);
return dataSignImportKey(parsedKey, isPublic);
} catch (err) {
return err;
}
};
export const dataSignImportPublicKeyFromString = (
key: string
): PromiseLike<CryptoKey | Error> | Error =>
dataSignImportKeyFromString(key, true);
export const dataSignImportPrivateKeyFromString = (
key: string
): PromiseLike<CryptoKey | Error> | Error =>
dataSignImportKeyFromString(key, false);
export const dataSignCheckIfStringIsKeyPair = (keyString: string): boolean => {
return (
keyString.includes(DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME) &&
keyString.includes(DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME)
);
};
export const dataSignGetKeyOfType = async (
key: TDataSignUtilSignKeyTypes,
type: KeyType
): Promise<CryptoKey | Error> => {
if (typeof key === 'string') {
if (dataSignCheckIfStringIsKeyPair(key)) {
const keyPair = await dataSignImportKeyPairFromString(key);
if (keyPair instanceof Error) {
return keyPair;
}
return dataSignGetKeyOfType(keyPair, type);
} else {
const keyFromString = await dataSignImportKeyFromString(
key,
type === 'public'
);
if (keyFromString instanceof Error) {
return keyFromString;
}
return dataSignGetKeyOfType(keyFromString, type);
}
}
if (isCryptoKey(key)) {
return key.type === type ? key : new Error(KEY_NOT_FOUND_ERROR_MESSAGE);
}
if (typeof key === 'object') {
const keys = Object.values(key);
const keyResulted = keys.find(
(k: CryptoKey) => k && k.type && k.type === type
);
return keyResulted || new Error(KEY_NOT_FOUND_ERROR_MESSAGE);
}
return new Error('There is an unsupported type of the key given');
};
/**
* import an encryption key from a
* supported format of an exported key
* and returns a crypto key in native
* format
* @param {} key
*/
export const dataSignImportEncryptionKey = async (
key: TEncryptionKeyStoreFormatType
): Promise<CryptoKey | Error> => {
if (isTypedArray(key)) {
return dataSignImportKey(key);
} else {
const jwk = getJWKOrBool(key);
if (typeof jwk === 'object') {
return dataSignImportKey(jwk);
} else if (typeof key === 'string') {
return dataSignImportKeyFromString(key);
}
}
return new Error('There is an unknown key format');
};
/**
* import an encryption key from a
* supported format of an exported key
* and returns a crypto key as a string
* @param {} key
*/
export const dataSignConvertAndExportKeyAsString = async (
key: TEncryptionKeyStoreFormatType
): Promise<string | Error> => {
const cryptoKeyImported = await dataSignImportEncryptionKey(key);
if (cryptoKeyImported instanceof Error) {
return cryptoKeyImported;
}
return dataSignExportKeyAsString(cryptoKeyImported);
};