SharedAccessSignature.php
10.2 KB
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
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Service_WindowsAzure
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: SharedAccessSignature.php 23775 2011-03-01 17:25:24Z ralph $
*/
/**
* @see Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
*/
require_once 'Zend/Service/WindowsAzure/Credentials/CredentialsAbstract.php';
/**
* @see Zend_Service_WindowsAzure_Storage
*/
require_once 'Zend/Service/WindowsAzure/Storage.php';
/**
* @see Zend_Http_Client
*/
require_once 'Zend/Http/Client.php';
/**
* @category Zend
* @package Zend_Service_WindowsAzure
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
extends Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
{
/**
* Permission set
*
* @var array
*/
protected $_permissionSet = array();
/**
* Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance
*
* @param string $accountName Account name for Windows Azure
* @param string $accountKey Account key for Windows Azure
* @param boolean $usePathStyleUri Use path-style URI's
* @param array $permissionSet Permission set
*/
public function __construct(
$accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT,
$accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY,
$usePathStyleUri = false, $permissionSet = array()
) {
parent::__construct($accountName, $accountKey, $usePathStyleUri);
$this->_permissionSet = $permissionSet;
}
/**
* Get permission set
*
* @return array
*/
public function getPermissionSet()
{
return $this->_permissionSet;
}
/**
* Set permisison set
*
* Warning: fine-grained permissions should be added prior to coarse-grained permissions.
* For example: first add blob permissions, end with container-wide permissions.
*
* Warning: the signed access signature URL must match the account name of the
* Zend_Service_WindowsAzure_Credentials_Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance
*
* @param array $value Permission set
* @return void
*/
public function setPermissionSet($value = array())
{
foreach ($value as $url) {
if (strpos($url, $this->_accountName) === false) {
throw new Zend_Service_WindowsAzure_Exception('The permission set can only contain URLs for the account name specified in the Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance.');
}
}
$this->_permissionSet = $value;
}
/**
* Create signature
*
* @param string $path Path for the request
* @param string $resource Signed resource - container (c) - blob (b)
* @param string $permissions Signed permissions - read (r), write (w), delete (d) and list (l)
* @param string $start The time at which the Shared Access Signature becomes valid.
* @param string $expiry The time at which the Shared Access Signature becomes invalid.
* @param string $identifier Signed identifier
* @return string
*/
public function createSignature(
$path = '/',
$resource = 'b',
$permissions = 'r',
$start = '',
$expiry = '',
$identifier = ''
) {
// Determine path
if ($this->_usePathStyleUri) {
$path = substr($path, strpos($path, '/'));
}
// Add trailing slash to $path
if (substr($path, 0, 1) !== '/') {
$path = '/' . $path;
}
// Build canonicalized resource string
$canonicalizedResource = '/' . $this->_accountName;
/*if ($this->_usePathStyleUri) {
$canonicalizedResource .= '/' . $this->_accountName;
}*/
$canonicalizedResource .= $path;
// Create string to sign
$stringToSign = array();
$stringToSign[] = $permissions;
$stringToSign[] = $start;
$stringToSign[] = $expiry;
$stringToSign[] = $canonicalizedResource;
$stringToSign[] = $identifier;
$stringToSign = implode("\n", $stringToSign);
$signature = base64_encode(hash_hmac('sha256', $stringToSign, $this->_accountKey, true));
return $signature;
}
/**
* Create signed query string
*
* @param string $path Path for the request
* @param string $queryString Query string for the request
* @param string $resource Signed resource - container (c) - blob (b)
* @param string $permissions Signed permissions - read (r), write (w), delete (d) and list (l)
* @param string $start The time at which the Shared Access Signature becomes valid.
* @param string $expiry The time at which the Shared Access Signature becomes invalid.
* @param string $identifier Signed identifier
* @return string
*/
public function createSignedQueryString(
$path = '/',
$queryString = '',
$resource = 'b',
$permissions = 'r',
$start = '',
$expiry = '',
$identifier = ''
) {
// Parts
$parts = array();
if ($start !== '') {
$parts[] = 'st=' . urlencode($start);
}
$parts[] = 'se=' . urlencode($expiry);
$parts[] = 'sr=' . $resource;
$parts[] = 'sp=' . $permissions;
if ($identifier !== '') {
$parts[] = 'si=' . urlencode($identifier);
}
$parts[] = 'sig=' . urlencode($this->createSignature($path, $resource, $permissions, $start, $expiry, $identifier));
// Assemble parts and query string
if ($queryString != '') {
$queryString .= '&';
}
$queryString .= implode('&', $parts);
return $queryString;
}
/**
* Permission matches request?
*
* @param string $permissionUrl Permission URL
* @param string $requestUrl Request URL
* @param string $resourceType Resource type
* @param string $requiredPermission Required permission
* @return string Signed request URL
*/
public function permissionMatchesRequest(
$permissionUrl = '',
$requestUrl = '',
$resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
$requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ
) {
// Build requirements
$requiredResourceType = $resourceType;
if ($requiredResourceType == Zend_Service_WindowsAzure_Storage::RESOURCE_BLOB) {
$requiredResourceType .= Zend_Service_WindowsAzure_Storage::RESOURCE_CONTAINER;
}
// Parse permission url
$parsedPermissionUrl = parse_url($permissionUrl);
// Parse permission properties
$permissionParts = explode('&', $parsedPermissionUrl['query']);
// Parse request url
$parsedRequestUrl = parse_url($requestUrl);
// Check if permission matches request
$matches = true;
foreach ($permissionParts as $part) {
list($property, $value) = explode('=', $part, 2);
if ($property == 'sr') {
$matches = $matches && (strpbrk($value, $requiredResourceType) !== false);
}
if ($property == 'sp') {
$matches = $matches && (strpbrk($value, $requiredPermission) !== false);
}
}
// Ok, but... does the resource match?
$matches = $matches && (strpos($parsedRequestUrl['path'], $parsedPermissionUrl['path']) !== false);
// Return
return $matches;
}
/**
* Sign request URL with credentials
*
* @param string $requestUrl Request URL
* @param string $resourceType Resource type
* @param string $requiredPermission Required permission
* @return string Signed request URL
*/
public function signRequestUrl(
$requestUrl = '',
$resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
$requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ
) {
// Look for a matching permission
foreach ($this->getPermissionSet() as $permittedUrl) {
if ($this->permissionMatchesRequest($permittedUrl, $requestUrl, $resourceType, $requiredPermission)) {
// This matches, append signature data
$parsedPermittedUrl = parse_url($permittedUrl);
if (strpos($requestUrl, '?') === false) {
$requestUrl .= '?';
} else {
$requestUrl .= '&';
}
$requestUrl .= $parsedPermittedUrl['query'];
// Return url
return $requestUrl;
}
}
// Return url, will be unsigned...
return $requestUrl;
}
/**
* Sign request with credentials
*
* @param string $httpVerb HTTP verb the request will use
* @param string $path Path for the request
* @param string $queryString Query string for the request
* @param array $headers x-ms headers to add
* @param boolean $forTableStorage Is the request for table storage?
* @param string $resourceType Resource type
* @param string $requiredPermission Required permission
* @param mixed $rawData Raw post data
* @return array Array of headers
*/
public function signRequestHeaders(
$httpVerb = Zend_Http_Client::GET,
$path = '/',
$queryString = '',
$headers = null,
$forTableStorage = false,
$resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
$requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ,
$rawData = null
) {
return $headers;
}
}