Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]

Source for file Credentials.php

Documentation is available at Credentials.php

  1. <?php
  2. /**
  3.  * Copyright (c) 2009, RealDolmen
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions are met:
  8.  *     * Redistributions of source code must retain the above copyright
  9.  *       notice, this list of conditions and the following disclaimer.
  10.  *     * Redistributions in binary form must reproduce the above copyright
  11.  *       notice, this list of conditions and the following disclaimer in the
  12.  *       documentation and/or other materials provided with the distribution.
  13.  *     * Neither the name of RealDolmen nor the
  14.  *       names of its contributors may be used to endorse or promote products
  15.  *       derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY RealDolmen ''AS IS'' AND ANY
  18.  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20.  * DISCLAIMED. IN NO EVENT SHALL RealDolmen BE LIABLE FOR ANY
  21.  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22.  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  *
  28.  * @category   Microsoft
  29.  * @package    Microsoft_WindowsAzure
  30.  * @copyright  Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
  31.  * @license    http://phpazure.codeplex.com/license
  32.  * @version    $Id: SharedKeyCredentials.php 14561 2009-05-07 08:05:12Z unknown $
  33.  */
  34.  
  35. /**
  36.  * @see Microsoft_Http_Transport
  37.  */
  38. require_once 'Microsoft/Http/Transport.php';
  39.  
  40. /**
  41.  * @category   Microsoft
  42.  * @package    Microsoft_WindowsAzure
  43.  * @copyright  Copyright (c) 2009, RealDolmen (http://www.realdolmen.com)
  44.  * @license    http://phpazure.codeplex.com/license
  45.  */ 
  46. {
  47.     /**
  48.      * Development storage account and key
  49.      */
  50.     const DEVSTORE_ACCOUNT       "devstoreaccount1";
  51.     const DEVSTORE_KEY           "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
  52.     
  53.     /**
  54.      * HTTP header prefixes
  55.      */
  56.     const PREFIX_PROPERTIES      "x-ms-prop-";
  57.     const PREFIX_METADATA        "x-ms-meta-";
  58.     const PREFIX_STORAGE_HEADER  "x-ms-";
  59.     
  60.     /**
  61.      * Permissions
  62.      */
  63.     const PERMISSION_READ        "r";
  64.     const PERMISSION_WRITE       "w";
  65.     const PERMISSION_DELETE      "d";
  66.     const PERMISSION_LIST        "l";
  67.  
  68.     /**
  69.      * Account name for Windows Azure
  70.      *
  71.      * @var string 
  72.      */
  73.     protected $_accountName = '';
  74.     
  75.     /**
  76.      * Account key for Windows Azure
  77.      *
  78.      * @var string 
  79.      */
  80.     protected $_accountKey = '';
  81.     
  82.     /**
  83.      * Use path-style URI's
  84.      *
  85.      * @var boolean 
  86.      */
  87.     protected $_usePathStyleUri = false;
  88.     
  89.     /**
  90.      * Creates a new Microsoft_WindowsAzure_Credentials instance
  91.      *
  92.      * @param string $accountName Account name for Windows Azure
  93.      * @param string $accountKey Account key for Windows Azure
  94.      * @param boolean $usePathStyleUri Use path-style URI's
  95.      */
  96.     public function __construct($accountName Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT$accountKey Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY$usePathStyleUri false)
  97.     {
  98.         $this->_accountName = $accountName;
  99.         $this->_accountKey = base64_decode($accountKey);
  100.         $this->_usePathStyleUri = $usePathStyleUri;
  101.     }
  102.     
  103.     /**
  104.      * Set account name for Windows Azure
  105.      *
  106.      * @param string $value 
  107.      */
  108.     public function setAccountName($value Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT)
  109.     {
  110.         $this->_accountName = $value;
  111.     }
  112.     
  113.     /**
  114.      * Set account key for Windows Azure
  115.      *
  116.      * @param string $value 
  117.      */
  118.     public function setAccountkey($value Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY)
  119.     {
  120.         $this->_accountKey = base64_decode($value);
  121.     }
  122.     
  123.     /**
  124.      * Set use path-style URI's
  125.      *
  126.      * @param boolean $value 
  127.      */
  128.     public function setUsePathStyleUri($value false)
  129.     {
  130.         $this->_usePathStyleUri = $value;
  131.     }
  132.     
  133.     /**
  134.      * Sign request URL with credentials
  135.      *
  136.      * @param string $requestUrl Request URL
  137.      * @param string $resourceType Resource type
  138.      * @param string $requiredPermission Required permission
  139.      * @return string Signed request URL
  140.      */
  141.     public abstract function signRequestUrl($requestUrl '');
  142.     
  143.     /**
  144.      * Sign request headers with credentials
  145.      *
  146.      * @param string $httpVerb HTTP verb the request will use
  147.      * @param string $path Path for the request
  148.      * @param string $queryString Query string for the request
  149.      * @param array $headers x-ms headers to add
  150.      * @param boolean $forTableStorage Is the request for table storage?
  151.      * @param string $resourceType Resource type
  152.      * @param string $requiredPermission Required permission
  153.      * @return array Array of headers
  154.      */
  155.     public abstract function signRequestHeaders($httpVerb Microsoft_Http_Transport::VERB_GET$path '/'$queryString ''$headers null$forTableStorage false$resourceType Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN$requiredPermission Microsoft_WindowsAzure_Credentials::PERMISSION_READ);
  156.     
  157.     
  158.     /**
  159.      * Prepare query string for signing
  160.      * 
  161.      * @param  string $value Original query string
  162.      * @return string        Query string for signing
  163.      */
  164.     protected function prepareQueryStringForSigning($value)
  165.     {
  166.         // Check for 'comp='
  167.         if (strpos($value'comp='=== false)
  168.         {
  169.             // If not found, no query string needed
  170.             return '';
  171.         }
  172.         else
  173.         {
  174.             // If found, make sure it is the only parameter being used      
  175.             if (strlen($value&& strpos($value'?'=== 0)
  176.                 $value substr($value1);
  177.             
  178.             // Split parts
  179.             $queryParts explode('&'$value);
  180.             foreach ($queryParts as $queryPart)
  181.             {
  182.                 if (strpos($queryPart'comp='!== false)
  183.                     return '?' $queryPart;
  184.             }
  185.  
  186.             // Should never happen...
  187.             return '';
  188.         }
  189.     }
  190. }

Documentation generated on Thu, 26 Nov 2009 08:04:49 +0100 by phpDocumentor 1.4.3