storage: add v4 post policy (GoogleCloudPlatform#1049)

Author: jkwlui

storage/composer.json

@@ -34,6 +34,7 @@
             "src/enable_requester_pays.php",
             "src/activate_hmac_key.php",
             "src/generate_encryption_key.php",
+            "src/generate_v4_post_policy.php",
             "src/bucket_metadata.php",
             "src/get_bucket_acl.php",
             "src/get_bucket_acl_for_entity.php",

storage/src/generate_v4_post_policy.php

@@ -0,0 +1,63 @@
+<?php
+/**
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_generate_signed_post_policy_v4]
+use Google\Cloud\Storage\StorageClient;
+
+/**
+ * Generates a V4 POST Policy to be used in an HTML form and echo's form.
+ *
+ * @param string $bucketName the name of your Google Cloud bucket.
+ * @param string $objectName the name of your Google Cloud object.
+ *
+ * @return void
+ */
+function generate_v4_post_policy($bucketName, $objectName)
+{
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    
+    $response = $bucket->generateSignedPostPolicyV4(
+        $objectName,
+        new \DateTime('10 min'),
+        [
+            'fields' => [
+                'x-goog-meta-test' => 'data'
+            ]
+        ]
+    );
+
+    $url = $response['url'];
+    $output = "<form action='$url' method='POST' enctype='multipart/form-data'>" . PHP_EOL;
+    foreach ($response['fields'] as $name => $value) {
+        $output .= "  <input name='$name' value='$value' type='hidden'/>" . PHP_EOL;
+    }
+    $output .= "  <input type='file' name='file'/><br />" . PHP_EOL;
+    $output .= "  <input type='submit' value='Upload File' name='submit'/><br />" . PHP_EOL;
+    $output .= "</form>" . PHP_EOL;
+
+    echo $output;
+}
+# [END storage_generate_signed_post_policy_v4]

storage/storage.php

@@ -618,6 +618,23 @@
         upload_object_v4_signed_url($bucketName, $objectName);
     });
 
+$application->add(new Command('generate-v4-post-policy'))
+    ->setDescription('Generate a v4 post policy form for uploading an object.')
+    ->setHelp(<<<EOF
+The <info>%command.name%</info> command generates a v4 post policy form for uploading an object.
+
+<info>php %command.full_name% --help</info>
+
+EOF
+    )
+    ->addArgument('bucket', InputArgument::REQUIRED, 'The Cloud Storage bucket name')
+    ->addArgument('object', InputArgument::REQUIRED, 'The Cloud Storage object name')
+    ->setCode(function ($input, $output) {
+        $bucketName = $input->getArgument('bucket');
+        $objectName = $input->getArgument('object');
+        generate_v4_post_policy($bucketName, $objectName);
+    });
+
 // for testing
 if (getenv('PHPUNIT_TESTS') === '1') {
     return $application;

storage/test/GenerateV4PostPolicy.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright 2020 Google LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Google\Cloud\Samples\Storage\Tests;
+
+use Google\Cloud\TestUtils\TestTrait;
+use Google\Cloud\TestUtils\ExecuteCommandTrait;
+use Google\Cloud\Storage\StorageClient;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Unit Tests for GenerateV4PostPolicy.
+ */
+class GenerateV4PostPolicy extends TestCase
+{
+    use TestTrait;
+    use ExecuteCommandTrait;
+
+    private static $storage;
+    private static $bucketName;
+    private static $objectName;
+    private static $commandFile = __DIR__ . '/../storage.php';
+
+    /** @beforeClass */
+    public static function setUpObject()
+    {
+        self::$storage = new StorageClient();
+        self::$bucketName = self::requireEnv('GOOGLE_STORAGE_BUCKET');
+        self::$objectName = sprintf('test-object-%s', time());
+    }
+
+    public function testGenerateSignedPostPolicy()
+    {
+        $bucketName = self::$bucketName;
+        $objectName = self::$objectName;
+        $output = $this->runCommand('generate-v4-post-policy', [
+            'bucket' => $bucketName,
+            'object' => $objectName,
+        ]);
+
+        $this->assertContains("<form action='https://storage.googleapis.com/$bucketName/", $output);
+        $this->assertContains("<input name='key' value='$objectName'", $output);
+        $this->assertContains("<input name='x-goog-signature'", $output);
+        $this->assertContains("<input name='x-goog-date'", $output);
+        $this->assertContains("<input name='x-goog-credential'", $output);
+        $this->assertContains("<input name='x-goog-algorithm' value='GOOG4-RSA-SHA256'", $output);
+        $this->assertContains("<input name='policy'", $output);
+        $this->assertContains("<input name='x-goog-meta-test' value='data'", $output);
+        $this->assertContains("<input type='file' name='file'/>", $output);
+    }
+}

storage/test/ObjectSignedUrlTest.php

@@ -24,7 +24,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * Unit Tests for RequesterPaysCommand.
+ * Unit Tests for ObjectSignedUrl.
  */
 class ObjectSignedUrlTest extends TestCase
 {