/
BlobSASPermissions.ts
269 lines (242 loc) · 6.23 KB
/
BlobSASPermissions.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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting
* a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
* the values are set, this should be serialized with toString and set as the permissions field on a
* {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but
* the order of the permissions is particular and this class guarantees correctness.
*/
export class BlobSASPermissions {
/**
* Creates a {@link BlobSASPermissions} from the specified permissions string. This method will throw an
* Error if it encounters a character that does not correspond to a valid permission.
*
* @param permissions -
*/
public static parse(permissions: string): BlobSASPermissions {
const blobSASPermissions = new BlobSASPermissions();
for (const char of permissions) {
switch (char) {
case "r":
blobSASPermissions.read = true;
break;
case "a":
blobSASPermissions.add = true;
break;
case "c":
blobSASPermissions.create = true;
break;
case "w":
blobSASPermissions.write = true;
break;
case "d":
blobSASPermissions.delete = true;
break;
case "x":
blobSASPermissions.deleteVersion = true;
break;
case "t":
blobSASPermissions.tag = true;
break;
case "m":
blobSASPermissions.move = true;
break;
case "e":
blobSASPermissions.execute = true;
break;
case "i":
blobSASPermissions.setImmutabilityPolicy = true;
break;
case "y":
blobSASPermissions.permanentDelete = true;
break;
default:
throw new RangeError(`Invalid permission: ${char}`);
}
}
return blobSASPermissions;
}
/**
* Creates a {@link BlobSASPermissions} from a raw object which contains same keys as it
* and boolean values for them.
*
* @param permissionLike -
*/
public static from(permissionLike: BlobSASPermissionsLike): BlobSASPermissions {
const blobSASPermissions = new BlobSASPermissions();
if (permissionLike.read) {
blobSASPermissions.read = true;
}
if (permissionLike.add) {
blobSASPermissions.add = true;
}
if (permissionLike.create) {
blobSASPermissions.create = true;
}
if (permissionLike.write) {
blobSASPermissions.write = true;
}
if (permissionLike.delete) {
blobSASPermissions.delete = true;
}
if (permissionLike.deleteVersion) {
blobSASPermissions.deleteVersion = true;
}
if (permissionLike.tag) {
blobSASPermissions.tag = true;
}
if (permissionLike.move) {
blobSASPermissions.move = true;
}
if (permissionLike.execute) {
blobSASPermissions.execute = true;
}
if (permissionLike.setImmutabilityPolicy) {
blobSASPermissions.setImmutabilityPolicy = true;
}
if (permissionLike.permanentDelete) {
blobSASPermissions.permanentDelete = true;
}
return blobSASPermissions;
}
/**
* Specifies Read access granted.
*/
public read: boolean = false;
/**
* Specifies Add access granted.
*/
public add: boolean = false;
/**
* Specifies Create access granted.
*/
public create: boolean = false;
/**
* Specifies Write access granted.
*/
public write: boolean = false;
/**
* Specifies Delete access granted.
*/
public delete: boolean = false;
/**
* Specifies Delete version access granted.
*/
public deleteVersion: boolean = false;
/**
* Specfies Tag access granted.
*/
public tag: boolean = false;
/**
* Specifies Move access granted.
*/
public move: boolean = false;
/**
* Specifies Execute access granted.
*/
public execute: boolean = false;
/**
* Specifies SetImmutabilityPolicy access granted.
*/
public setImmutabilityPolicy: boolean = false;
/**
* Specifies that Permanent Delete is permitted.
*/
public permanentDelete: boolean = false;
/**
* Converts the given permissions to a string. Using this method will guarantee the permissions are in an
* order accepted by the service.
*
* @returns A string which represents the BlobSASPermissions
*/
public toString(): string {
const permissions: string[] = [];
if (this.read) {
permissions.push("r");
}
if (this.add) {
permissions.push("a");
}
if (this.create) {
permissions.push("c");
}
if (this.write) {
permissions.push("w");
}
if (this.delete) {
permissions.push("d");
}
if (this.deleteVersion) {
permissions.push("x");
}
if (this.tag) {
permissions.push("t");
}
if (this.move) {
permissions.push("m");
}
if (this.execute) {
permissions.push("e");
}
if (this.setImmutabilityPolicy) {
permissions.push("i");
}
if (this.permanentDelete) {
permissions.push("y");
}
return permissions.join("");
}
}
/**
* A type that looks like a Blob SAS permission.
* Used in {@link BlobSASPermissions} to parse SAS permissions from raw objects.
*/
export interface BlobSASPermissionsLike {
/**
* Specifies Read access granted.
*/
read?: boolean;
/**
* Specifies Add access granted.
*/
add?: boolean;
/**
* Specifies Create access granted.
*/
create?: boolean;
/**
* Specifies Write access granted.
*/
write?: boolean;
/**
* Specifies Delete access granted.
*/
delete?: boolean;
/**
* Specifies Delete version access granted.
*/
deleteVersion?: boolean;
/**
* Specfies Tag access granted.
*/
tag?: boolean;
/**
* Specifies Move access granted.
*/
move?: boolean;
/**
* Specifies Execute access granted.
*/
execute?: boolean;
/**
* Specifies SetImmutabilityPolicy access granted.
*/
setImmutabilityPolicy?: boolean;
/**
* Specifies that Permanent Delete is permitted.
*/
permanentDelete?: boolean;
}