Service/WindowsAzure/Credentials/SharedAccessSignature.php

Show:

inherited

Classes
- \Zend_Service_WindowsAzure_Credentials_SharedAccessSignature

Table of Contents

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
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service_WindowsAzure
Version: $Id$

\Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
jump to top

Package: Zend_Service_WindowsAzure

Parent(s): \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_permissionSet = array()

Permission set

Default valuearray()Details

Type: array

Methods

__construct(string $accountName = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, string $accountKey = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, boolean $usePathStyleUri = false, array $permissionSet = array()) : void

Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance

Parameters

Name	Type	Description
$accountName	string	Account name for Windows Azure
$accountKey	string	Account key for Windows Azure
$usePathStyleUri	boolean	Use path-style URI's
$permissionSet	array	Permission set

createSignature(string $path = '/', string $resource = 'b', string $permissions = 'r', string $start = '', string $expiry = '', string $identifier = '') : string

Create signature

Parameters

Name	Type	Description
$path	string	Path for the request
$resource	string	Signed resource - container (c) - blob (b)
$permissions	string	Signed permissions - read (r), write (w), delete (d) and list (l)
$start	string	The time at which the Shared Access Signature becomes valid.
$expiry	string	The time at which the Shared Access Signature becomes invalid.
$identifier	string	Signed identifier

Returns

Type	Description
string

createSignedQueryString(string $path = '/', string $queryString = '', string $resource = 'b', string $permissions = 'r', string $start = '', string $expiry = '', string $identifier = '') : string

Create signed query string

Parameters

Name	Type	Description
$path	string	Path for the request
$queryString	string	Query string for the request
$resource	string	Signed resource - container (c) - blob (b)
$permissions	string	Signed permissions - read (r), write (w), delete (d) and list (l)
$start	string	The time at which the Shared Access Signature becomes valid.
$expiry	string	The time at which the Shared Access Signature becomes invalid.
$identifier	string	Signed identifier

Returns

Type	Description
string

getPermissionSet() : array

Get permission set

Returns

Type	Description
array

permissionMatchesRequest(string $permissionUrl = '', string $requestUrl = '', string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) : string

Permission matches request?

Parameters

Name	Type	Description
$permissionUrl	string	Permission URL
$requestUrl	string	Request URL
$resourceType	string	Resource type
$requiredPermission	string	Required permission

Returns

Type	Description
string	Signed request URL

setPermissionSet(array $value = array()) : void

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

Parameters

Name	Type	Description
$value	array	Permission set

signRequestHeaders(string $httpVerb = \Zend_Http_Client::GET, string $path = '/', string $queryString = '', array $headers = null, boolean $forTableStorage = false, string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ, mixed $rawData = null) : array

Sign request with credentials

Parameters

Name	Type	Description
$httpVerb	string	HTTP verb the request will use
$path	string	Path for the request
$queryString	string	Query string for the request
$headers	array	x-ms headers to add
$forTableStorage	boolean	Is the request for table storage?
$resourceType	string	Resource type
$requiredPermission	string	Required permission
$rawData	mixed	Raw post data

Returns

Type	Description
array	Array of headers

signRequestUrl(string $requestUrl = '', string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) : string

Sign request URL with credentials

Parameters

Name	Type	Description
$requestUrl	string	Request URL
$resourceType	string	Resource type
$requiredPermission	string	Required permission

Returns

Type	Description
string	Signed request URL

Service/WindowsAzure/Credentials/SharedAccessSignature.php

\Zend_Service_WindowsAzure_Credentials_SharedAccessSignaturejump to top

Properties

Methods

\Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
jump to top