@sudoplatform/sudo-common 8.0.0 → 8.0.1

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.
Files changed (39) hide show
  1. package/package.json +17 -8
  2. package/{cjs → types}/configurationManager/defaultConfigurationManager.d.ts +0 -0
  3. package/{cjs → types}/errors/error.d.ts +0 -0
  4. package/{cjs → types}/index.d.ts +0 -0
  5. package/{cjs → types}/logging/bunyanLogger.d.ts +0 -0
  6. package/{cjs → types}/logging/logger.d.ts +0 -0
  7. package/{cjs → types}/sudoKeyArchive/index.d.ts +0 -0
  8. package/{cjs → types}/sudoKeyArchive/keyArchive.d.ts +0 -0
  9. package/{cjs → types}/sudoKeyArchive/keyInfo.d.ts +0 -0
  10. package/{cjs → types}/sudoKeyArchive/keyType.d.ts +0 -0
  11. package/{cjs → types}/sudoKeyArchive/sudoKeyArchive.d.ts +0 -0
  12. package/{cjs → types}/sudoKeyManager/index.d.ts +0 -0
  13. package/{cjs → types}/sudoKeyManager/keyData.d.ts +0 -0
  14. package/{cjs → types}/sudoKeyManager/publicKey.d.ts +0 -0
  15. package/{cjs → types}/sudoKeyManager/sudoCryptoProvider.d.ts +0 -0
  16. package/{cjs → types}/sudoKeyManager/sudoKeyManager.d.ts +0 -0
  17. package/{cjs → types}/types/types.d.ts +0 -0
  18. package/{cjs → types}/utils/base64.d.ts +0 -0
  19. package/{cjs → types}/utils/buffer.d.ts +0 -0
  20. package/{cjs → types}/utils/stream.d.ts +0 -0
  21. package/lib/configurationManager/defaultConfigurationManager.d.ts +0 -123
  22. package/lib/errors/error.d.ts +0 -263
  23. package/lib/index.d.ts +0 -9
  24. package/lib/logging/bunyanLogger.d.ts +0 -8
  25. package/lib/logging/logger.d.ts +0 -87
  26. package/lib/sudoKeyArchive/index.d.ts +0 -4
  27. package/lib/sudoKeyArchive/keyArchive.d.ts +0 -137
  28. package/lib/sudoKeyArchive/keyInfo.d.ts +0 -41
  29. package/lib/sudoKeyArchive/keyType.d.ts +0 -13
  30. package/lib/sudoKeyArchive/sudoKeyArchive.d.ts +0 -190
  31. package/lib/sudoKeyManager/index.d.ts +0 -4
  32. package/lib/sudoKeyManager/keyData.d.ts +0 -56
  33. package/lib/sudoKeyManager/publicKey.d.ts +0 -8
  34. package/lib/sudoKeyManager/sudoCryptoProvider.d.ts +0 -324
  35. package/lib/sudoKeyManager/sudoKeyManager.d.ts +0 -344
  36. package/lib/types/types.d.ts +0 -115
  37. package/lib/utils/base64.d.ts +0 -44
  38. package/lib/utils/buffer.d.ts +0 -13
  39. package/lib/utils/stream.d.ts +0 -6
@@ -1,324 +0,0 @@
1
- import { EncryptionAlgorithm } from '../types/types';
2
- import { KeyData } from './keyData';
3
- import { PublicKey } from './publicKey';
4
- export declare class SudoCryptoProviderDefaults {
5
- static readonly aesIVSize = 16;
6
- static readonly aesKeySize = 256;
7
- static readonly rsaKeySize = 2048;
8
- static readonly pbkdfRounds = 10000;
9
- static readonly pbkdfSaltSize = 16;
10
- }
11
- /**
12
- * Optional arguments for symmetric encryption..
13
- */
14
- export interface SymmetricEncryptionOptions {
15
- iv?: ArrayBuffer;
16
- algorithm?: EncryptionAlgorithm;
17
- }
18
- /**
19
- * Optional arguments for public key encryption.
20
- */
21
- export interface AsymmetricEncryptionOptions {
22
- algorithm?: EncryptionAlgorithm;
23
- }
24
- /**
25
- * CryptoProvider instance interface
26
- */
27
- export interface SudoCryptoProvider {
28
- getNamespace(): string;
29
- getServiceName(): string;
30
- /**
31
- * Adds as password to the secure store.
32
- *
33
- * @param password The password to store.
34
- * @param name The name of the password.
35
- */
36
- addPassword(password: ArrayBuffer, name: string): Promise<void>;
37
- /**
38
- * Retrieves a password from the secure store.
39
- *
40
- * @param name The name of the password to retrieve.
41
- *
42
- * @returns The password or undefined if a password with the given name was not found.
43
- */
44
- getPassword(name: string): Promise<ArrayBuffer | undefined>;
45
- /**
46
- * Deletes a password from the secure store.
47
- *
48
- * @param name The name of the password to delete.
49
- */
50
- deletePassword(name: string): Promise<void>;
51
- /**
52
- * Updates a password stored in the secure store.
53
- *
54
- * @param password The new password.
55
- * @param name The name of the password to update.
56
- */
57
- updatePassword(password: ArrayBuffer, name: string): Promise<void>;
58
- /**
59
- * Adds a symmetric key to the secure store.
60
- *
61
- * @param key The symmetric key.
62
- * @param name The name for the symmetric key.
63
- */
64
- addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
65
- /**
66
- * Retrieves a symmetric key from the secure store.
67
- *
68
- * @param name The name of the symmetric key.
69
- *
70
- * @returns The symmetric key or undefined if not found.
71
- */
72
- getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
73
- /**
74
- * Checks to see if the specified symmetric key exists.
75
- *
76
- * @param name The name of the symmetric key.
77
- */
78
- doesSymmetricKeyExist(name: string): Promise<boolean>;
79
- /**
80
- * Deletes a symmetric key from the secure store.
81
- *
82
- * @param name The name of the symmetric key.
83
- */
84
- deleteSymmetricKey(name: string): Promise<void>;
85
- /**
86
- * Generates a symmetric key and stores it securely.
87
- *
88
- * @param name The name for the symmetric key.
89
- */
90
- generateSymmetricKey(name: string): Promise<void>;
91
- /**
92
- * Generates a symmetric key from a password using PBKDF2.
93
- *
94
- * @param password The password from which to generate the symmetric key
95
- * @param salt Salt to use in generation of the key
96
- * @param rounds The number of rounds of PBKDF2 to perform. Default: per getDefaultPBKDF2Rounds
97
- *
98
- * @returns The generated symmetric key.
99
- */
100
- generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
101
- rounds?: number;
102
- }): Promise<ArrayBuffer>;
103
- /**
104
- * Generate random bytes using a secure random number generator.
105
- *
106
- * @param size Number of random bytes to generate
107
- *
108
- * @returns ArrayBuffer containing the random bytes.
109
- */
110
- generateRandomData(size: number): Promise<ArrayBuffer>;
111
- /**
112
- * Deletes a key pair from the secure store.
113
- *
114
- * @param name The name of the key pair to be deleted.
115
- */
116
- deleteKeyPair(name: string): Promise<void>;
117
- /**
118
- * Generates a signature for the given data with the specified private key.
119
- *
120
- * @param name The name of the private key to use for generation.
121
- * @param data The data to sign.
122
- *
123
- * @returns Data signature
124
- *
125
- * @throws {@link KeyNotFoundError}
126
- */
127
- generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
128
- /**
129
- * Verifies the given data against the provided signature using the specified public key.
130
- *
131
- * @param name The name of the public key to use for validation.
132
- * @param data The data to verify
133
- * @param signature The signature to verify against
134
- *
135
- * @returns True if the data and signature could be successfully verified
136
- */
137
- verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
138
- /**
139
- * Adds a private key to the secure store.
140
- *
141
- * @param key The private key to store securely.
142
- * @param name The name of the private key to be stored.
143
- */
144
- addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
145
- /**
146
- * Retrieves a private key from the secure store.
147
- *
148
- * @param name The name of the private key to be retrieved.
149
- *
150
- * @returns Requested private key or undefined if the key was not found.
151
- */
152
- getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
153
- /**
154
- * Checks to see if the specified private key exists.
155
- *
156
- * @param name The name of the private key.
157
- */
158
- doesPrivateKeyExist(name: string): Promise<boolean>;
159
- /**
160
- * Adds a public key to the secure store.
161
- *
162
- * @param key The public key to store securely.
163
- * @param name The name of the public key to be stored.
164
- */
165
- addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
166
- /**
167
- * Deletes the specified public key from the secure store.
168
- *
169
- * @param name The name of the public key to be removed.
170
- */
171
- deletePublicKey(name: string): Promise<void>;
172
- /**
173
- * Retrieves the public key from the secure store.
174
- *
175
- * @param name The name of the public key.
176
- *
177
- * @returns The public key or undefined if the key was not found.
178
- */
179
- getPublicKey(name: string): Promise<PublicKey | undefined>;
180
- /**
181
- * Clear all types of keys
182
- */
183
- removeAllKeys(): Promise<void>;
184
- /**
185
- * @deprecated Use version with `options` param.
186
- *
187
- * Encrypts the given data with the specified symmetric key stored in the secure store.
188
- *
189
- * @param name The name of the symmetric key to use to encrypt.
190
- * @param data Data to encrypt.
191
- * @param iv Optional Initialization Vector.
192
- *
193
- * @returns Encrypted data and IV
194
- */
195
- encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
196
- /**
197
- * Encrypts the given data with the specified symmetric key stored in the secure store.
198
- *
199
- * @param name The name of the symmetric key to use to encrypt.
200
- * @param data Data to encrypt.
201
- *
202
- *
203
- * @returns Encrypted data and IV
204
- *
205
- * @throws {@link UnrecognizedAlgorithmError}
206
- * @throws {@link KeyNotFoundError}
207
- */
208
- encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
209
- /**
210
- * @deprecated Use version with `options` param.
211
- *
212
- * Decrypt the given data with the specified symmetric key stored in the secure store.
213
- *
214
- * @param name The name of the symmetric key to use to decrypt.
215
- * @param data The data to decrypt.
216
- * @param iv Optional Initialization Vector.
217
- *
218
- * @returns Decrypted data
219
- */
220
- decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
221
- /**
222
- * Decrypt the given data with the specified symmetric key stored in the secure store.
223
- *
224
- * @param name The name of the symmetric key to use to decrypt.
225
- * @param data The data to decrypt.
226
- *
227
- * @returns Decrypted data
228
- *
229
- * @throws {@link UnrecognizedAlgorithmError}
230
- * @throws {@link KeyNotFoundError}
231
- */
232
- decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
233
- /**
234
- * @deprecated Use version with `options` param.
235
- *
236
- * Encrypts the given data with the specified key
237
- *
238
- * @param name The name of the symmetric key to use to encrypt.
239
- * @param data Data to encrypt.
240
- * @param iv Optional Initialization Vector.
241
- *
242
- * @returns Encrypted data and IV
243
- */
244
- encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
245
- /**
246
- * Encrypts the given data with the specified key
247
- *
248
- * @param name The name of the symmetric key to use to encrypt.
249
- * @param data Data to encrypt.
250
- *
251
- * @returns Encrypted data and IV
252
- *
253
- * @throws {@link UnrecognizedAlgorithmError}
254
- */
255
- encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
256
- /**
257
- * @deprecated Use version with `options` param.
258
- *
259
- * Decrypt the given data with the specified symmetric key stored in the secure store.
260
- *
261
- * @param name The name of the symmetric key to use to decrypt.
262
- * @param data The data to decrypt.
263
- * @param iv Optional Initialization Vector.
264
- *
265
- * @returns Decrypted data
266
- */
267
- decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
268
- /**
269
- * Decrypt the given data with the specified symmetric key stored in the secure store.
270
- *
271
- * @param name The name of the symmetric key to use to decrypt.
272
- * @param data The data to decrypt.
273
- *
274
- * @returns Decrypted data
275
- *
276
- * @throws {@link UnrecognizedAlgorithmError}
277
- */
278
- decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
279
- /**
280
- * Encrypts the given data with the specified public key.
281
- *
282
- * @param name The name of the public key to use for encryption.
283
- * @param data The data to encrypt.
284
- *
285
- * @returns Encrypted data
286
- *
287
- * @throws {@link UnrecognizedAlgorithmError}
288
- * @throws {@link KeyNotFoundError}
289
- */
290
- encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
291
- /**
292
- * Decrypts the given data with the specified private key.
293
- *
294
- * @param name The name of the private key to use for decryption.
295
- * @param data The data to decrypt.
296
- *
297
- * @returns Decrypted data.
298
- *
299
- * @throws {@link UnrecognizedAlgorithmError}
300
- * @throws {@link KeyNotFoundError}
301
- */
302
- decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
303
- /**
304
- * Generates and securely stores a key pair for public key cryptography.
305
- *
306
- * @param name The name of the key pair to be generated.
307
- */
308
- generateKeyPair(name: string): Promise<void>;
309
- /**
310
- * Creates a SHA256 hash of the specified data.
311
- *
312
- * @param data Data to hash.
313
- *
314
- * @returns The SHA256 hash of data
315
- */
316
- generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
317
- /**
318
- * Export all keys and passwords from the key store as an
319
- * array of KeyData items.
320
- *
321
- * @returns Array of exported keys and passwords
322
- */
323
- exportKeys(): Promise<KeyData[]>;
324
- }
@@ -1,344 +0,0 @@
1
- import { KeyData } from './keyData';
2
- import { PublicKey } from './publicKey';
3
- import { AsymmetricEncryptionOptions, SudoCryptoProvider, SymmetricEncryptionOptions } from './sudoCryptoProvider';
4
- /**
5
- * Interface for a set of methods for securely storing keys and performing
6
- * cryptographic operations.
7
- */
8
- export interface SudoKeyManager {
9
- readonly namespace: string;
10
- readonly serviceName: string;
11
- /**
12
- * Adds as password to the secure store.
13
- *
14
- * @param password
15
- * @param name
16
- */
17
- addPassword(password: ArrayBuffer, name: string): Promise<void>;
18
- /**
19
- * Retrieves a password from the secure store.
20
- *
21
- * @param name The name of the password to retrieve
22
- *
23
- * @returns The password or undefined if the password was not found.
24
- */
25
- getPassword(name: string): Promise<ArrayBuffer | undefined>;
26
- /**
27
- * Deletes a password from the secure store.
28
- *
29
- * @param name
30
- */
31
- deletePassword(name: string): Promise<void>;
32
- /**
33
- * Updates a password stored in the secure store.
34
- *
35
- * @param password
36
- * @param name
37
- */
38
- updatePassword(password: ArrayBuffer, name: string): Promise<void>;
39
- /**
40
- * Adds a symmetric key to the secure store.
41
- *
42
- * @param key The symmetric key.
43
- * @param name The name for the symmetric key.
44
- */
45
- addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
46
- /**
47
- * Retrieves a symmetric key from the secure store.
48
- *
49
- * @param name The name of the symmetric key.
50
- *
51
- * @returns The symmetric key or undefined if not found.
52
- */
53
- getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
54
- /**
55
- * Checks to see if the specified symmetric key exists.
56
- *
57
- * @param name The name of the symmetric key.
58
- */
59
- doesSymmetricKeyExist(name: string): Promise<boolean>;
60
- /**
61
- * Deletes a symmetric key from the secure store.
62
- *
63
- * @param name The name of the symmetric key.
64
- */
65
- deleteSymmetricKey(name: string): Promise<void>;
66
- /**
67
- * Adds a private key to the secure store.
68
- *
69
- * @param key The private key to store securely.
70
- * @param name The name of the private key to be stored.
71
- */
72
- addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
73
- /**
74
- * Retrieves a private key from the secure store.
75
- *
76
- * @param name The name of the private key to be retrieved.
77
- *
78
- * @returns Requested private key or undefined if the key was not found.
79
- */
80
- getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
81
- /**
82
- * Checks to see if the specified private key exists.
83
- *
84
- * @param name The name of the private key.
85
- */
86
- doesPrivateKeyExist(name: string): Promise<boolean>;
87
- /**
88
- * Adds a public key to the secure store.
89
- *
90
- * The format of the public key should be SubjectPublicKeyInfo (spki)
91
- *
92
- * @param key The public key to store securely.
93
- * @param name The name of the public key to be stored.
94
- */
95
- addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
96
- /**
97
- * Deletes the specified public key from the secure store.
98
- *
99
- * @param name The name of the public key to be removed.
100
- */
101
- deletePublicKey(name: string): Promise<void>;
102
- /**
103
- * Retrieves the public key from the secure store.
104
- *
105
- * The format of the public key is SubjectPublicKeyInfo (spki)
106
- *
107
- * @param name The name of the public key.
108
- *
109
- * @returns The public key or undefined if the key was not found.
110
- */
111
- getPublicKey(name: string): Promise<PublicKey | undefined>;
112
- /**
113
- * Deletes a key pair from the secure store.
114
- *
115
- * @param name The name of the key pair to be deleted.
116
- */
117
- deleteKeyPair(name: string): Promise<void>;
118
- /**
119
- * Generates a signature for the given data with the specified private key.
120
- *
121
- * @param name The name of the private key to use for generation.
122
- * @param data The data to sign.
123
- *
124
- * @returns Data signature or undefined if the private key is not found.
125
- */
126
- generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
127
- /**
128
- * Verifies the given data against the provided signature using the specified public key.
129
- *
130
- * @param name The name of the public key to use for validation.
131
- * @param data The data to verify
132
- * @param signature The signature to verify against
133
- *
134
- * @returns True if the data and signature could be successfully verified
135
- */
136
- verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
137
- /**
138
- * @deprecated Use version with `options` param.
139
- *
140
- * Encrypts the given data with the specified key
141
- *
142
- * @param name The name of the symmetric key to use to encrypt.
143
- * @param data Data to encrypt.
144
- * @param iv Optional Initialization Vector.
145
- *
146
- * @returns Encrypted data and IV
147
- */
148
- encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
149
- /**
150
- * Encrypts the given data with the specified key
151
- *
152
- * @param name The name of the symmetric key to use to encrypt.
153
- * @param data Data to encrypt.
154
- *
155
- * @returns Encrypted data and IV
156
- *
157
- * @throws {@link UnrecognizedAlgorithmError}
158
- */
159
- encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
160
- /**
161
- * @deprecated Use version with `options` param.
162
- *
163
- * Decrypt the given data with the given symmetric key
164
- *
165
- * @param key The symmetric key to use to decrypt the data.
166
- * @param encryptedData The encrypted data.
167
- * @param iv Optional Initialization Vector.
168
- *
169
- * @returns Decrypted data
170
- */
171
- decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
172
- /**
173
- * Decrypt the given data with the given symmetric key
174
- *
175
- * @param key The symmetric key to use to decrypt the data.
176
- * @param encryptedData The encrypted data.
177
- *
178
- * @returns Decrypted data
179
- *
180
- * @throws {@link UnrecognizedAlgorithmError}
181
- */
182
- decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
183
- /**
184
- * @deprecated Use version with `options` param.
185
- *
186
- * Decrypt the given data with the specified symmetric key stored in the secure store.
187
- *
188
- * @param name The name of the symmetric key to use to decrypt.
189
- * @param data The data to decrypt.
190
- * @param iv Optional Initialization Vector.
191
- *
192
- * @returns Decrypted data
193
- */
194
- encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
195
- /**
196
- * Decrypt the given data with the specified symmetric key stored in the secure store.
197
- *
198
- * @param name The name of the symmetric key to use to decrypt.
199
- * @param data The data to decrypt.
200
- *
201
- * @returns Decrypted data
202
- *
203
- * @throws {@link UnrecognizedAlgorithmError}
204
- */
205
- encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
206
- /**
207
- * @deprecated Use version with `options` param.
208
- * Decrypt the given data with the specified symmetric key stored in the secure store.
209
- *
210
- * @param name The name of the symmetric key to use to decrypt.
211
- * @param data The data to decrypt.
212
- * @param iv Optional Initialization Vector.
213
- *
214
- * @returns Decrypted data
215
- */
216
- decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, iv?: ArrayBuffer): Promise<ArrayBuffer>;
217
- /**
218
- * Decrypt the given data with the specified symmetric key stored in the secure store.
219
- *
220
- * @param name The name of the symmetric key to use to decrypt.
221
- * @param data The data to decrypt.
222
- *
223
- * @returns Decrypted data
224
- *
225
- * @throws {@link UnrecognizedAlgorithmError}
226
- */
227
- decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, options?: SymmetricEncryptionOptions): Promise<ArrayBuffer>;
228
- /**
229
- * Encrypts the given data with the specified public key.
230
- *
231
- * @param name The name of the public key to use for encryption.
232
- * @param data The data to encrypt.
233
- *
234
- * @returns Encrypted data
235
- *
236
- * @throws {@link UnrecognizedAlgorithmError}
237
- */
238
- encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
239
- /**
240
- * Decrypts the given data with the specified private key.
241
- *
242
- * @param name The name of the private key to use for decryption.
243
- * @param data The data to decrypt.
244
- *
245
- * @returns Decrypted data or undefined if the private key is not found.
246
- *
247
- * @throws {@link UnrecognizedAlgorithmError}
248
- */
249
- decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer | undefined>;
250
- /**
251
- * Remove all keys associated with this `SudoKeyManager`
252
- */
253
- removeAllKeys(): Promise<void>;
254
- /**
255
- * Generates and securely stores a symmetric key.
256
- *
257
- * @param name The name of the symmetric key.
258
- */
259
- generateSymmetricKey(name: string): Promise<void>;
260
- /**
261
- * Generates a symmetric key, derived from a password using PBKDF2.
262
- *
263
- * @param name The name to store the symmetric key as
264
- * @param password The password from which to generate the symmetric key
265
- * @param salt Salt to use in generation of the key
266
- * @param rounds The number of rounds of PBKDF2 to perform. Default: per getDefaultPBKDF2Rounds
267
- *
268
- * @returns The generated symmetric key.
269
- */
270
- generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
271
- rounds?: number;
272
- }): Promise<ArrayBuffer>;
273
- /**
274
- * Generate random bytes using a secure random number generator.
275
- *
276
- * @param size Number of random bytes to generate
277
- *
278
- * @returns ArrayBuffer containing the random bytes.
279
- */
280
- generateRandomData(size: number): Promise<ArrayBuffer>;
281
- /**
282
- * Creates a SHA256 hash of the specified data.
283
- *
284
- * @param data Data to hash.
285
- */
286
- generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
287
- /**
288
- * Generates and securely stores a key pair for public key cryptography.
289
- *
290
- * The public key is exported as `SubjectPublicKeyInfo (spki)
291
- * The private key is exported as `pkcs8`
292
- *
293
- * @param name The name of the key pair to be generated.
294
- */
295
- generateKeyPair(name: string): Promise<void>;
296
- /**
297
- * Export all contents of the key manager as an array of KeyArchiveKeyInfo
298
- * ready for archive.
299
- */
300
- exportKeys(): Promise<KeyData[]>;
301
- }
302
- export declare class DefaultSudoKeyManager implements SudoKeyManager {
303
- private readonly sudoCryptoProvider;
304
- /**
305
- * @param namespace A namespace to use as part of the key name. If a namespace is specified then
306
- * a unique identifier for each key will be `<namespace>.<keyName>`. Namespace cannot be an empty string.
307
- * @param sudoCryptoProvider
308
- */
309
- constructor(sudoCryptoProvider: SudoCryptoProvider);
310
- get serviceName(): string;
311
- get namespace(): string;
312
- addPassword(password: ArrayBuffer, name: string): Promise<void>;
313
- getPassword(name: string): Promise<ArrayBuffer | undefined>;
314
- deletePassword(name: string): Promise<void>;
315
- updatePassword(password: ArrayBuffer, name: string): Promise<void>;
316
- addSymmetricKey(key: ArrayBuffer, name: string): Promise<void>;
317
- getSymmetricKey(name: string): Promise<ArrayBuffer | undefined>;
318
- doesSymmetricKeyExist(name: string): Promise<boolean>;
319
- deleteSymmetricKey(name: string): Promise<void>;
320
- generateKeyPair(name: string): Promise<void>;
321
- addPrivateKey(key: ArrayBuffer, name: string): Promise<void>;
322
- getPrivateKey(name: string): Promise<ArrayBuffer | undefined>;
323
- doesPrivateKeyExist(name: string): Promise<boolean>;
324
- addPublicKey(key: ArrayBuffer, name: string): Promise<void>;
325
- deletePublicKey(name: string): Promise<void>;
326
- getPublicKey(name: string): Promise<PublicKey | undefined>;
327
- deleteKeyPair(name: string): Promise<void>;
328
- generateSignatureWithPrivateKey(name: string, data: ArrayBuffer): Promise<ArrayBuffer>;
329
- verifySignatureWithPublicKey(name: string, data: ArrayBuffer, signature: ArrayBuffer): Promise<boolean>;
330
- encryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
331
- decryptWithSymmetricKey(key: ArrayBuffer, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
332
- encryptWithSymmetricKeyName(name: string, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
333
- decryptWithSymmetricKeyName(name: string, data: ArrayBuffer, ivOrOptions?: ArrayBuffer | SymmetricEncryptionOptions): Promise<ArrayBuffer>;
334
- encryptWithPublicKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer>;
335
- decryptWithPrivateKey(name: string, data: ArrayBuffer, options?: AsymmetricEncryptionOptions): Promise<ArrayBuffer | undefined>;
336
- removeAllKeys(): Promise<void>;
337
- generateSymmetricKey(name: string): Promise<void>;
338
- generateSymmetricKeyFromPassword(password: ArrayBuffer, salt: ArrayBuffer, options?: {
339
- rounds?: number;
340
- }): Promise<ArrayBuffer>;
341
- generateRandomData(size: number): Promise<ArrayBuffer>;
342
- generateHash(data: ArrayBuffer): Promise<ArrayBuffer>;
343
- exportKeys(): Promise<KeyData[]>;
344
- }