/
BlobSASSignatureValues.ts
859 lines (798 loc) · 30.4 KB
/
BlobSASSignatureValues.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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import { BlobSASPermissions } from "./BlobSASPermissions";
import { UserDelegationKey } from "../BlobServiceClient";
import { ContainerSASPermissions } from "./ContainerSASPermissions";
import { StorageSharedKeyCredential } from "../credentials/StorageSharedKeyCredential";
import { UserDelegationKeyCredential } from "../credentials/UserDelegationKeyCredential";
import { ipRangeToString, SasIPRange } from "./SasIPRange";
import { SASProtocol, SASQueryParameters } from "./SASQueryParameters";
import { SERVICE_VERSION } from "../utils/constants";
import { truncatedISO8061Date } from "../utils/utils.common";
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* BlobSASSignatureValues is used to help generating Blob service SAS tokens for containers or blobs.
*
* @export
* @class BlobSASSignatureValues
*/
export interface BlobSASSignatureValues {
/**
* The version of the service this SAS will target. If not specified, it will default to the version targeted by the
* library.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
version?: string;
/**
* Optional. SAS protocols, HTTPS only or HTTPSandHTTP
*
* @type {SASProtocol}
* @memberof BlobSASSignatureValues
*/
protocol?: SASProtocol;
/**
* Optional. When the SAS will take effect.
*
* @type {Date}
* @memberof BlobSASSignatureValues
*/
startsOn?: Date;
/**
* Optional only when identifier is provided. The time after which the SAS will no longer work.
*
* @type {Date}
* @memberof BlobSASSignatureValues
*/
expiresOn?: Date;
/**
* Optional only when identifier is provided.
* Please refer to either {@link ContainerSASPermissions} or {@link BlobSASPermissions} depending on the resource
* being accessed for help constructing the permissions string.
*
* @type {BlobSASPermissions | ContainerSASPermissions}
* @memberof BlobSASSignatureValues
*/
permissions?: BlobSASPermissions | ContainerSASPermissions;
/**
* Optional. IP ranges allowed in this SAS.
*
* @type {SasIPRange}
* @memberof BlobSASSignatureValues
*/
ipRange?: SasIPRange;
/**
* The name of the container the SAS user may access.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
containerName: string;
/**
* Optional. The blob name of the SAS user may access. Required if snapshotTime or versionId is provided.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
blobName?: string;
/**
* Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
snapshotTime?: string;
/**
* Optional. VersionId of the blob version the SAS user may access. Only supported from API version 2019-10-10.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
versionId?: string;
/**
* Optional. The name of the access policy on the container this SAS references if any.
*
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
identifier?: string;
/**
* Optional. The cache-control header for the SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
cacheControl?: string;
/**
* Optional. The content-disposition header for the SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
contentDisposition?: string;
/**
* Optional. The content-encoding header for the SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
contentEncoding?: string;
/**
* Optional. The content-language header for the SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
contentLanguage?: string;
/**
* Optional. The content-type header for the SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
contentType?: string;
/**
* Optional. Beginning in version 2020-02-10, specifies the Authorized AAD Object ID in GUID format. The AAD Object ID of a user
* authorized by the owner of the user delegation key to perform the action granted by the SAS. The Azure Storage service will
* ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission
* check for the user specified in this value will be performed. This is only used for User Delegation SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
preauthorizedAgentObjectId?: string;
/**
* Optional. Beginning in version 2020-02-10, this is a GUID value that will be logged in the storage diagnostic logs and can be used to
* correlate SAS generation with storage resource access. This is only used for User Delegation SAS.
*
* @type {string}
* @memberof BlobSASSignatureValues
*/
correlationId?: string;
}
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn and identifier.
*
* WARNING: When identifier is not provided, permissions and expiresOn are required.
* You MUST assign value to identifier or expiresOn & permissions manually if you initial with
* this constructor.
*
* Fill in the required details before running the following snippets.
*
* Example usage:
*
* ```js
* // Generate service level SAS for a container
* const containerSAS = generateBlobSASQueryParameters({
* containerName, // Required
* permissions: ContainerSASPermissions.parse("racwdl"), // Required
* startsOn: new Date(), // Optional
* expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
* ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
* protocol: SASProtocol.HttpsAndHttp, // Optional
* version: "2016-05-31" // Optional
* },
* sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
* ).toString();
* ```
*
* Example using an identifier:
*
* ```js
* // Generate service level SAS for a container with identifier
* // startsOn & permissions are optional when identifier is provided
* const identifier = "unique-id";
* await containerClient.setAccessPolicy(undefined, [
* {
* accessPolicy: {
* expiresOn: new Date(new Date().valueOf() + 86400), // Date type
* permissions: ContainerSASPermissions.parse("racwdl").toString(),
* startsOn: new Date() // Date type
* },
* id: identifier
* }
* ]);
*
* const containerSAS = generateBlobSASQueryParameters(
* {
* containerName, // Required
* identifier // Required
* },
* sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
* ).toString();
* ```
*
* Example using a blob name:
*
* ```js
* // Generate service level SAS for a blob
* const blobSAS = generateBlobSASQueryParameters({
* containerName, // Required
* blobName, // Required
* permissions: BlobSASPermissions.parse("racwd"), // Required
* startsOn: new Date(), // Optional
* expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
* cacheControl: "cache-control-override", // Optional
* contentDisposition: "content-disposition-override", // Optional
* contentEncoding: "content-encoding-override", // Optional
* contentLanguage: "content-language-override", // Optional
* contentType: "content-type-override", // Optional
* ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
* protocol: SASProtocol.HttpsAndHttp, // Optional
* version: "2016-05-31" // Optional
* },
* sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
* ).toString();
* ```
*
* @export
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {StorageSharedKeyCredential} sharedKeyCredential
* @returns {SASQueryParameters}
*/
export function generateBlobSASQueryParameters(
blobSASSignatureValues: BlobSASSignatureValues,
sharedKeyCredential: StorageSharedKeyCredential
): SASQueryParameters;
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* Creates an instance of SASQueryParameters.
* WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.
*
* Example usage:
*
* ```js
* // Generate user delegation SAS for a container
* const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
* const containerSAS = generateBlobSASQueryParameters({
* containerName, // Required
* permissions: ContainerSASPermissions.parse("racwdl"), // Required
* startsOn, // Optional. Date type
* expiresOn, // Required. Date type
* ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
* protocol: SASProtocol.HttpsAndHttp, // Optional
* version: "2018-11-09" // Must >= 2018-11-09 to generate user delegation SAS
* },
* userDelegationKey, // UserDelegationKey
* accountName
* ).toString();
* ```
*
* @export
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {UserDelegationKey} userDelegationKey Return value of `blobServiceClient.getUserDelegationKey()`
* @param {string} accountName
* @returns {SASQueryParameters}
*/
export function generateBlobSASQueryParameters(
blobSASSignatureValues: BlobSASSignatureValues,
userDelegationKey: UserDelegationKey,
accountName: string
): SASQueryParameters;
export function generateBlobSASQueryParameters(
blobSASSignatureValues: BlobSASSignatureValues,
sharedKeyCredentialOrUserDelegationKey: StorageSharedKeyCredential | UserDelegationKey,
accountName?: string
): SASQueryParameters {
const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
const sharedKeyCredential =
sharedKeyCredentialOrUserDelegationKey instanceof StorageSharedKeyCredential
? sharedKeyCredentialOrUserDelegationKey
: undefined;
let userDelegationKeyCredential: UserDelegationKeyCredential | undefined;
if (sharedKeyCredential === undefined && accountName !== undefined) {
userDelegationKeyCredential = new UserDelegationKeyCredential(
accountName,
sharedKeyCredentialOrUserDelegationKey as UserDelegationKey
);
}
if (sharedKeyCredential === undefined && userDelegationKeyCredential === undefined) {
throw TypeError("Invalid sharedKeyCredential, userDelegationKey or accountName.");
}
// Version 2019-12-12 adds support for the blob tags permission.
// Version 2018-11-09 adds support for the signed resource and signed blob snapshot time fields.
// https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas#constructing-the-signature-string
if (version >= "2018-11-09") {
if (sharedKeyCredential !== undefined) {
return generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential);
} else {
// Version 2020-02-10 delegation SAS signature construction includes preauthorizedAgentObjectId, agentObjectId, correlationId.
if (version >= "2020-02-10") {
return generateBlobSASQueryParametersUDK20200210(
blobSASSignatureValues,
userDelegationKeyCredential!
);
} else {
return generateBlobSASQueryParametersUDK20181109(
blobSASSignatureValues,
userDelegationKeyCredential!
);
}
}
}
if (version >= "2015-04-05") {
if (sharedKeyCredential !== undefined) {
return generateBlobSASQueryParameters20150405(blobSASSignatureValues, sharedKeyCredential);
} else {
throw new RangeError(
"'version' must be >= '2018-11-09' when generating user delegation SAS using user delegation key."
);
}
}
throw new RangeError("'version' must be >= '2015-04-05'.");
}
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
* IMPLEMENTATION FOR API VERSION FROM 2015-04-05 AND BEFORE 2018-11-09.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn and identifier.
*
* WARNING: When identifier is not provided, permissions and expiresOn are required.
* You MUST assign value to identifier or expiresOn & permissions manually if you initial with
* this constructor.
*
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {StorageSharedKeyCredential} sharedKeyCredential
* @returns {SASQueryParameters}
*/
function generateBlobSASQueryParameters20150405(
blobSASSignatureValues: BlobSASSignatureValues,
sharedKeyCredential: StorageSharedKeyCredential
): SASQueryParameters {
blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
if (
!blobSASSignatureValues.identifier &&
!(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)
) {
throw new RangeError(
"Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided."
);
}
let resource: string = "c";
if (blobSASSignatureValues.blobName) {
resource = "b";
}
// Calling parse and toString guarantees the proper ordering and throws on invalid characters.
let verifiedPermissions: string | undefined;
if (blobSASSignatureValues.permissions) {
if (blobSASSignatureValues.blobName) {
verifiedPermissions = BlobSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
} else {
verifiedPermissions = ContainerSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
}
}
// Signature is generated on the un-url-encoded values.
const stringToSign = [
verifiedPermissions ? verifiedPermissions : "",
blobSASSignatureValues.startsOn
? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
: "",
blobSASSignatureValues.expiresOn
? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
: "",
getCanonicalName(
sharedKeyCredential.accountName,
blobSASSignatureValues.containerName,
blobSASSignatureValues.blobName
),
blobSASSignatureValues.identifier,
blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
blobSASSignatureValues.version,
blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : ""
].join("\n");
const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
return new SASQueryParameters(
blobSASSignatureValues.version!,
signature,
verifiedPermissions,
undefined,
undefined,
blobSASSignatureValues.protocol,
blobSASSignatureValues.startsOn,
blobSASSignatureValues.expiresOn,
blobSASSignatureValues.ipRange,
blobSASSignatureValues.identifier,
resource,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType
);
}
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
* IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn and identifier.
*
* WARNING: When identifier is not provided, permissions and expiresOn are required.
* You MUST assign value to identifier or expiresOn & permissions manually if you initial with
* this constructor.
*
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {StorageSharedKeyCredential} sharedKeyCredential
* @returns {SASQueryParameters}
*/
function generateBlobSASQueryParameters20181109(
blobSASSignatureValues: BlobSASSignatureValues,
sharedKeyCredential: StorageSharedKeyCredential
): SASQueryParameters {
blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
if (
!blobSASSignatureValues.identifier &&
!(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)
) {
throw new RangeError(
"Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided."
);
}
let resource: string = "c";
let timestamp = blobSASSignatureValues.snapshotTime;
if (blobSASSignatureValues.blobName) {
resource = "b";
if (blobSASSignatureValues.snapshotTime) {
resource = "bs";
} else if (blobSASSignatureValues.versionId) {
resource = "bv";
timestamp = blobSASSignatureValues.versionId;
}
}
// Calling parse and toString guarantees the proper ordering and throws on invalid characters.
let verifiedPermissions: string | undefined;
if (blobSASSignatureValues.permissions) {
if (blobSASSignatureValues.blobName) {
verifiedPermissions = BlobSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
} else {
verifiedPermissions = ContainerSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
}
}
// Signature is generated on the un-url-encoded values.
const stringToSign = [
verifiedPermissions ? verifiedPermissions : "",
blobSASSignatureValues.startsOn
? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
: "",
blobSASSignatureValues.expiresOn
? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
: "",
getCanonicalName(
sharedKeyCredential.accountName,
blobSASSignatureValues.containerName,
blobSASSignatureValues.blobName
),
blobSASSignatureValues.identifier,
blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
blobSASSignatureValues.version,
resource,
timestamp,
blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : ""
].join("\n");
const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
return new SASQueryParameters(
blobSASSignatureValues.version!,
signature,
verifiedPermissions,
undefined,
undefined,
blobSASSignatureValues.protocol,
blobSASSignatureValues.startsOn,
blobSASSignatureValues.expiresOn,
blobSASSignatureValues.ipRange,
blobSASSignatureValues.identifier,
resource,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType
);
}
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
* IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn.
*
* WARNING: identifier will be ignored, permissions and expiresOn are required.
*
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {UserDelegationKeyCredential} userDelegationKeyCredential
* @returns {SASQueryParameters}
*/
function generateBlobSASQueryParametersUDK20181109(
blobSASSignatureValues: BlobSASSignatureValues,
userDelegationKeyCredential: UserDelegationKeyCredential
): SASQueryParameters {
blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
// Stored access policies are not supported for a user delegation SAS.
if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
throw new RangeError(
"Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS."
);
}
let resource: string = "c";
let timestamp = blobSASSignatureValues.snapshotTime;
if (blobSASSignatureValues.blobName) {
resource = "b";
if (blobSASSignatureValues.snapshotTime) {
resource = "bs";
} else if (blobSASSignatureValues.versionId) {
resource = "bv";
timestamp = blobSASSignatureValues.versionId;
}
}
// Calling parse and toString guarantees the proper ordering and throws on invalid characters.
let verifiedPermissions: string | undefined;
if (blobSASSignatureValues.permissions) {
if (blobSASSignatureValues.blobName) {
verifiedPermissions = BlobSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
} else {
verifiedPermissions = ContainerSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
}
}
// Signature is generated on the un-url-encoded values.
const stringToSign = [
verifiedPermissions ? verifiedPermissions : "",
blobSASSignatureValues.startsOn
? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
: "",
blobSASSignatureValues.expiresOn
? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
: "",
getCanonicalName(
userDelegationKeyCredential.accountName,
blobSASSignatureValues.containerName,
blobSASSignatureValues.blobName
),
userDelegationKeyCredential.userDelegationKey.signedObjectId,
userDelegationKeyCredential.userDelegationKey.signedTenantId,
userDelegationKeyCredential.userDelegationKey.signedStartsOn
? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
: "",
userDelegationKeyCredential.userDelegationKey.signedExpiresOn
? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
: "",
userDelegationKeyCredential.userDelegationKey.signedService,
userDelegationKeyCredential.userDelegationKey.signedVersion,
blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
blobSASSignatureValues.version,
resource,
timestamp,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType
].join("\n");
const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
return new SASQueryParameters(
blobSASSignatureValues.version!,
signature,
verifiedPermissions,
undefined,
undefined,
blobSASSignatureValues.protocol,
blobSASSignatureValues.startsOn,
blobSASSignatureValues.expiresOn,
blobSASSignatureValues.ipRange,
blobSASSignatureValues.identifier,
resource,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType,
userDelegationKeyCredential.userDelegationKey
);
}
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
* IMPLEMENTATION FOR API VERSION FROM 2020-02-10.
*
* Creates an instance of SASQueryParameters.
*
* Only accepts required settings needed to create a SAS. For optional settings please
* set corresponding properties directly, such as permissions, startsOn.
*
* WARNING: identifier will be ignored, permissions and expiresOn are required.
*
* @param {BlobSASSignatureValues} blobSASSignatureValues
* @param {UserDelegationKeyCredential} userDelegationKeyCredential
* @returns {SASQueryParameters}
*/
function generateBlobSASQueryParametersUDK20200210(
blobSASSignatureValues: BlobSASSignatureValues,
userDelegationKeyCredential: UserDelegationKeyCredential
): SASQueryParameters {
blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
// Stored access policies are not supported for a user delegation SAS.
if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
throw new RangeError(
"Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS."
);
}
let resource: string = "c";
let timestamp = blobSASSignatureValues.snapshotTime;
if (blobSASSignatureValues.blobName) {
resource = "b";
if (blobSASSignatureValues.snapshotTime) {
resource = "bs";
} else if (blobSASSignatureValues.versionId) {
resource = "bv";
timestamp = blobSASSignatureValues.versionId;
}
}
// Calling parse and toString guarantees the proper ordering and throws on invalid characters.
let verifiedPermissions: string | undefined;
if (blobSASSignatureValues.permissions) {
if (blobSASSignatureValues.blobName) {
verifiedPermissions = BlobSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
} else {
verifiedPermissions = ContainerSASPermissions.parse(
blobSASSignatureValues.permissions.toString()
).toString();
}
}
// Signature is generated on the un-url-encoded values.
const stringToSign = [
verifiedPermissions ? verifiedPermissions : "",
blobSASSignatureValues.startsOn
? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
: "",
blobSASSignatureValues.expiresOn
? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
: "",
getCanonicalName(
userDelegationKeyCredential.accountName,
blobSASSignatureValues.containerName,
blobSASSignatureValues.blobName
),
userDelegationKeyCredential.userDelegationKey.signedObjectId,
userDelegationKeyCredential.userDelegationKey.signedTenantId,
userDelegationKeyCredential.userDelegationKey.signedStartsOn
? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
: "",
userDelegationKeyCredential.userDelegationKey.signedExpiresOn
? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
: "",
userDelegationKeyCredential.userDelegationKey.signedService,
userDelegationKeyCredential.userDelegationKey.signedVersion,
blobSASSignatureValues.preauthorizedAgentObjectId,
undefined, // agentObjectId
blobSASSignatureValues.correlationId,
blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
blobSASSignatureValues.version,
resource,
timestamp,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType
].join("\n");
const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
return new SASQueryParameters(
blobSASSignatureValues.version!,
signature,
verifiedPermissions,
undefined,
undefined,
blobSASSignatureValues.protocol,
blobSASSignatureValues.startsOn,
blobSASSignatureValues.expiresOn,
blobSASSignatureValues.ipRange,
blobSASSignatureValues.identifier,
resource,
blobSASSignatureValues.cacheControl,
blobSASSignatureValues.contentDisposition,
blobSASSignatureValues.contentEncoding,
blobSASSignatureValues.contentLanguage,
blobSASSignatureValues.contentType,
userDelegationKeyCredential.userDelegationKey,
blobSASSignatureValues.preauthorizedAgentObjectId,
blobSASSignatureValues.correlationId
);
}
function getCanonicalName(accountName: string, containerName: string, blobName?: string): string {
// Container: "/blob/account/containerName"
// Blob: "/blob/account/containerName/blobName"
const elements: string[] = [`/blob/${accountName}/${containerName}`];
if (blobName) {
elements.push(`/${blobName}`);
}
return elements.join("");
}
function SASSignatureValuesSanityCheckAndAutofill(
blobSASSignatureValues: BlobSASSignatureValues
): BlobSASSignatureValues {
const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
if (blobSASSignatureValues.snapshotTime && version < "2018-11-09") {
throw RangeError("'version' must be >= '2018-11-09' when providing 'snapshotTime'.");
}
if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.snapshotTime) {
throw RangeError("Must provide 'blobName' when providing 'snapshotTime'.");
}
if (blobSASSignatureValues.versionId && version < "2019-10-10") {
throw RangeError("'version' must be >= '2019-10-10' when providing 'versionId'.");
}
if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.versionId) {
throw RangeError("Must provide 'blobName' when providing 'versionId'.");
}
if (
blobSASSignatureValues.permissions &&
blobSASSignatureValues.permissions.deleteVersion &&
version < "2019-10-10"
) {
throw RangeError("'version' must be >= '2019-10-10' when providing 'x' permission.");
}
if (
blobSASSignatureValues.permissions &&
blobSASSignatureValues.permissions.tag &&
version < "2019-12-12"
) {
throw RangeError("'version' must be >= '2019-12-12' when providing 't' permission.");
}
if (
version < "2020-02-10" &&
blobSASSignatureValues.permissions &&
(blobSASSignatureValues.permissions.move || blobSASSignatureValues.permissions.execute)
) {
throw RangeError("'version' must be >= '2020-02-10' when providing the 'm' or 'e' permission.");
}
if (
version < "2020-02-10" &&
(blobSASSignatureValues.preauthorizedAgentObjectId || blobSASSignatureValues.correlationId)
) {
throw RangeError(
"'version' must be >= '2020-02-10' when providing 'preauthorizedAgentObjectId' or 'correlationId'."
);
}
blobSASSignatureValues.version = version;
return blobSASSignatureValues;
}