/
keysModels.ts
489 lines (463 loc) · 12.4 KB
/
keysModels.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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import * as coreHttp from "@azure/core-http";
import { JsonWebKeyOperation, JsonWebKeyCurveName, JsonWebKeyType } from "./core/models";
import { DeletionRecoveryLevel } from "./core/models";
/**
* @internal
* @ignore
* @interface
* An interface representing the KeyClient. For internal use.
*/
export interface KeyClientInterface {
/**
* Recovers the deleted key in the specified vault. This operation can only be performed on a
* soft-delete enabled vault.
*/
recoverDeletedKey(name: string, options?: RecoverDeletedKeyOptions): Promise<KeyVaultKey>;
/**
* The get method gets a specified key and is applicable to any key stored in Azure Key Vault.
* This operation requires the keys/get permission.
*/
getKey(name: string, options?: GetKeyOptions): Promise<KeyVaultKey>;
/**
* The delete operation applies to any key stored in Azure Key Vault. Individual versions
* of a key can not be deleted, only all versions of a given key at once.
*/
deleteKey(name: string, options?: DeleteKeyOptions): Promise<DeletedKey>;
/**
* The getDeletedKey method returns the specified deleted key along with its properties.
* This operation requires the keys/get permission.
*/
getDeletedKey(name: string, options?: GetDeletedKeyOptions): Promise<DeletedKey>;
}
/**
* As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
*/
export interface JsonWebKey {
/**
* Key identifier.
*/
kid?: string;
/**
* JsonWebKey Key Type (kty), as defined in
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:
* 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*/
kty?: JsonWebKeyType;
/**
* Json web key operations. For more
* information on possible key operations, see JsonWebKeyOperation.
*/
keyOps?: JsonWebKeyOperation[];
/**
* RSA modulus.
*/
n?: Uint8Array;
/**
* RSA public exponent.
*/
e?: Uint8Array;
/**
* RSA private exponent, or the D component of an EC private key.
*/
d?: Uint8Array;
/**
* RSA private key parameter.
*/
dp?: Uint8Array;
/**
* RSA private key parameter.
*/
dq?: Uint8Array;
/**
* RSA private key parameter.
*/
qi?: Uint8Array;
/**
* RSA secret prime.
*/
p?: Uint8Array;
/**
* RSA secret prime, with p < q.
*/
q?: Uint8Array;
/**
* Symmetric key.
*/
k?: Uint8Array;
/**
* HSM Token, used with 'Bring Your Own Key'.
*/
t?: Uint8Array;
/**
* Elliptic curve name. For valid values, see JsonWebKeyCurveName. Possible values include:
* 'P-256', 'P-384', 'P-521', 'P-256K'
*/
crv?: JsonWebKeyCurveName;
/**
* X component of an EC public key.
*/
x?: Uint8Array;
/**
* Y component of an EC public key.
*/
y?: Uint8Array;
}
/**
* @interface
* An interface representing a KeyVault Key, with its name, value and {@link KeyProperties}.
*/
export interface KeyVaultKey {
/**
* The key value.
*/
key?: JsonWebKey;
/**
* The name of the key.
*/
name: string;
/**
* Key identifier.
*/
id?: string;
/**
* JsonWebKey Key Type (kty), as defined in
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:
* 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*/
keyType?: JsonWebKeyType;
/**
* Operations allowed on this key
*/
keyOperations?: JsonWebKeyOperation[];
/**
* The properties of the key.
*/
properties: KeyProperties;
}
/**
* @interface
* An interface representing the Properties of {@link KeyVaultKey}
*/
export interface KeyProperties {
/**
* Key identifier.
*/
id?: string;
/**
* The name of the key.
*/
name: string;
/**
* The vault URI.
*/
vaultUrl: string;
/**
* The version of the key. May be undefined.
*/
version?: string;
/**
* Determines whether the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in UTC.
*/
notBefore?: Date;
/**
* Expiry date in UTC.
*/
expiresOn?: Date;
/**
* Application specific metadata in the form of key-value pairs.
*/
tags?: { [propertyName: string]: string };
/**
* Creation time in UTC.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly createdOn?: Date;
/**
* Last updated time in UTC.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly updatedOn?: Date;
/**
* Reflects the deletion recovery level currently in effect for keys in the current vault.
* If it contains 'Purgeable' the key can be permanently deleted by a privileged
* user; otherwise, only the system can purge the key, at the end of the
* retention interval. Possible values include: 'Purgeable',
* 'Recoverable+Purgeable', 'Recoverable',
* 'Recoverable+ProtectedSubscription'
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly recoveryLevel?: DeletionRecoveryLevel;
}
/**
* @interface
* An interface representing a deleted KeyVault Key.
*/
export interface DeletedKey {
/**
* The key value.
*/
key?: JsonWebKey;
/**
* The name of the key.
*/
name: string;
/**
* Key identifier.
*/
id?: string;
/**
* JsonWebKey Key Type (kty), as defined in
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Possible values include:
* 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'
*/
keyType?: JsonWebKeyType;
/**
* Operations allowed on this key
*/
keyOperations?: JsonWebKeyOperation[];
/**
* The properties of the key.
*/
properties: KeyProperties & {
/**
* The url of the recovery object, used to
* identify and recover the deleted key.
*/
readonly recoveryId?: string;
/**
* The time when the key is scheduled to be purged, in UTC
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly scheduledPurgeDate?: Date;
/**
* The time when the key was deleted, in UTC
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
deletedOn?: Date;
};
}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link createKey}
*/
export interface CreateKeyOptions extends coreHttp.OperationOptions {
/**
* Application specific metadata in the form of key-value pairs.
*/
tags?: { [propertyName: string]: string };
/**
* Json web key operations. For more
* information on possible key operations, see JsonWebKeyOperation.
*/
keyOps?: JsonWebKeyOperation[];
/**
* Determines whether the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in UTC.
*/
notBefore?: Date;
/**
* Expiry date in UTC.
*/
readonly expiresOn?: Date;
/**
* Size of the key
*/
keySize?: number;
}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link beginDeleteKey} and {@link beginRecoverDeletedKey}
*/
export interface KeyPollerOptions extends coreHttp.OperationOptions {
/**
* Time between each polling
*/
intervalInMs?: number;
/**
* A serialized poller, used to resume an existing operation
*/
resumeFrom?: string;
}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link beginDeleteKey}
*/
export interface BeginDeleteKeyOptions extends KeyPollerOptions {}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link beginRecoverDeletedKey}
*/
export interface BeginRecoverDeletedKeyOptions extends KeyPollerOptions {}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link createEcKey}
*/
export interface CreateEcKeyOptions extends CreateKeyOptions {
/**
* Elliptic curve name. For valid values, see JsonWebKeyCurveName.
* Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'
*/
curve?: JsonWebKeyCurveName;
/**
* Whether to import as a hardware key (HSM) or software key.
*/
hsm?: boolean;
}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link createRsaKey}
*/
export interface CreateRsaKeyOptions extends CreateKeyOptions {
/**
* The key size in bits. For example: 2048, 3072, or 4096 for RSA.
*/
keySize?: number;
/**
* Whether to import as a hardware key (HSM) or software key.
*/
hsm?: boolean;
}
/**
* @interface
* An interface representing the optional parameters that can be
* passed to {@link importKey}
*/
export interface ImportKeyOptions extends coreHttp.OperationOptions {
/**
* Application specific metadata in the form of key-value pairs.
*/
tags?: { [propertyName: string]: string };
/**
* Whether to import as a hardware key (HSM) or software key.
*/
hardwareProtected?: boolean;
/**
* Determines whether the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in UTC.
*/
notBefore?: Date;
/**
* Expiry date in UTC.
*/
expiresOn?: Date;
}
/**
* @interface
* An interface representing optional parameters that can be passed to {@link updateKeyProperties}.
*/
export interface UpdateKeyPropertiesOptions extends coreHttp.OperationOptions {
/**
* Json web key operations. For more
* information on possible key operations, see JsonWebKeyOperation.
*/
keyOps?: JsonWebKeyOperation[];
/**
* Determines whether the object is enabled.
*/
enabled?: boolean;
/**
* Not before date in UTC.
*/
notBefore?: Date;
/**
* Expiry date in UTC.
*/
expiresOn?: Date;
/**
* Application specific metadata in the form of key-value pairs.
*/
tags?: { [propertyName: string]: string };
}
/**
* @interface
* An interface representing optional parameters that can be passed to {@link getKey}.
*/
export interface GetKeyOptions extends coreHttp.OperationOptions {
/**
* The version of the secret to retrieve. If not
* specified the latest version of the secret will be retrieved.
*/
version?: string;
}
/**
* @interface
* An interface representing optional parameters for KeyClient paged operations passed to {@link listKeys}.
*/
export interface ListKeysOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeys}.
*/
export interface ListPropertiesOfKeysOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing optional parameters for KeyClient paged operations passed to {@link listPropertiesOfKeyVersions}.
*/
export interface ListPropertiesOfKeyVersionsOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing optional parameters for KeyClient paged operations passed to {@link listDeletedKeys}.
*/
export interface ListDeletedKeysOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing the optional parameters that can be passed to {@link getDeletedKey}.
*/
export interface GetDeletedKeyOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing the optional parameters that can be passed to {@link purgeDeletedKey}.
*/
export interface PurgeDeletedKeyOptions extends coreHttp.OperationOptions {}
/**
* @internal
* @ignore
* @interface
* An interface representing the optional parameters that can be passed to {@link recoverDeletedKey}.
*/
export interface RecoverDeletedKeyOptions extends coreHttp.OperationOptions {}
/**
* @internal
* @ignore
* @interface
* An interface representing the optional parameters that can be passed to {@link deleteKey}.
*/
export interface DeleteKeyOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing the optional parameters that can be passed to {@link backupKey}.
*/
export interface BackupKeyOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing the optional parameters that can be passed to {@link restoreKeyBackup}.
*/
export interface RestoreKeyBackupOptions extends coreHttp.OperationOptions {}
/**
* @interface
* An interface representing the options of the cryptography API methods, go to the {@link CryptographyClient} for more information.
*/
export interface CryptographyOptions extends coreHttp.OperationOptions {}