Merge pull request #384 from qiniu/features/add-x-qiniu-date

add x qiniu date and fix empty header can't iterate

Author: Mei-Zhao

src/Qiniu/Auth.php

@@ -8,11 +8,19 @@ final class Auth
 {
     private $accessKey;
     private $secretKey;
+    public $options;
 
-    public function __construct($accessKey, $secretKey)
+    public function __construct($accessKey, $secretKey, $options = null)
     {
         $this->accessKey = $accessKey;
         $this->secretKey = $secretKey;
+        $defaultOptions = array(
+            'disableQiniuTimestampSignature' => null
+        );
+        if ($options == null) {
+            $options = $defaultOptions;
+        }
+        $this->options = array_merge($defaultOptions, $options);
     }
 
     public function getAccessKey()
@@ -216,14 +224,29 @@ public function authorization($url, $body = null, $contentType = null)
 
     public function authorizationV2($url, $method, $body = null, $contentType = null)
     {
-        $headers = null;
+        $headers = new Header();
         $result = array();
         if ($contentType != null) {
-            $headers = new Header(array(
-                'Content-Type' => array($contentType),
-            ));
+            $headers['Content-Type'] = $contentType;
             $result['Content-Type'] = $contentType;
         }
+
+        $signDate = gmdate('Ymd\THis\Z', time());
+        if ($this->options['disableQiniuTimestampSignature'] !== null) {
+            if (!$this->options['disableQiniuTimestampSignature']) {
+                $headers['X-Qiniu-Date'] = $signDate;
+                $result['X-Qiniu-Date'] = $signDate;
+            }
+        } elseif (getenv("DISABLE_QINIU_TIMESTAMP_SIGNATURE")) {
+            if (strtolower(getenv("DISABLE_QINIU_TIMESTAMP_SIGNATURE")) !== "true") {
+                $headers['X-Qiniu-Date'] = $signDate;
+                $result['X-Qiniu-Date'] = $signDate;
+            }
+        } else {
+            $headers['X-Qiniu-Date'] = $signDate;
+            $result['X-Qiniu-Date'] = $signDate;
+        }
+
         list($sign) = $this->signQiniuAuthorization($url, $method, $body, $headers);
         $result['Authorization'] = 'Qiniu ' . $sign;
         return $result;

src/Qiniu/Http/Header.php

@@ -8,7 +8,7 @@
 class Header implements \ArrayAccess, \IteratorAggregate, \Countable
 {
     /** @var array normalized key name map */
-    private $data;
+    private $data = array();
 
     /**
      * @param array $obj non-normalized header object

tests/Qiniu/Tests/AuthTest.php

@@ -207,5 +207,39 @@ public function testSignQiniuAuthorization()
             $this->assertNull($err);
             $this->assertEquals("ak:PUFPWsEUIpk_dzUvvxTTmwhp3p4=", $sign);
         }
+
+        public function testDisableQiniuTimestampSignatureDefault()
+        {
+            $auth = new Auth("ak", "sk");
+            $authedHeaders = $auth->authorizationV2("https://example.com", "GET");
+            $this->assertArrayHasKey("X-Qiniu-Date", $authedHeaders);
+        }
+
+        public function testDisableQiniuTimestampSignature()
+        {
+            $auth = new Auth("ak", "sk", array(
+                "disableQiniuTimestampSignature" => true
+            ));
+            $authedHeaders = $auth->authorizationV2("https://example.com", "GET");
+            $this->assertArrayNotHasKey("X-Qiniu-Date", $authedHeaders);
+        }
+        public function testDisableQiniuTimestampSignatureEnv()
+        {
+            putenv("DISABLE_QINIU_TIMESTAMP_SIGNATURE=true");
+            $auth = new Auth("ak", "sk");
+            $authedHeaders = $auth->authorizationV2("https://example.com", "GET");
+            $this->assertArrayNotHasKey("X-Qiniu-Date", $authedHeaders);
+            putenv('DISABLE_QINIU_TIMESTAMP_SIGNATURE');
+        }
+        public function testDisableQiniuTimestampSignatureEnvBeIgnored()
+        {
+            putenv("DISABLE_QINIU_TIMESTAMP_SIGNATURE=true");
+            $auth = new Auth("ak", "sk", array(
+                "disableQiniuTimestampSignature" => false
+            ));
+            $authedHeaders = $auth->authorizationV2("https://example.com", "GET");
+            $this->assertArrayHasKey("X-Qiniu-Date", $authedHeaders);
+            putenv('DISABLE_QINIU_TIMESTAMP_SIGNATURE');
+        }
     }
 }

tests/Qiniu/Tests/HeaderTest.php

@@ -145,6 +145,21 @@ public function testGetIterator()
         $this->assertFalse($hasException);
     }
 
+    public function testEmptyHeaderIterator()
+    {
+        $emptyHeader = new Header();
+
+        $hasException = false;
+        try {
+            foreach ($emptyHeader as $k => $v) {
+                $hasException = !isset($header[$k]);
+            }
+        } catch (\Exception $e) {
+            $hasException = true;
+        }
+        $this->assertFalse($hasException);
+    }
+
     public function testCount()
     {
         $header = new Header($this->heads);