Adds example for generating Cloud CDN Signed URLs (GoogleCloudPlatform#805)

Author: brona

cdn/README.md

@@ -0,0 +1,15 @@
+# Google Cloud CDN Sign URL
+
+PHP implementation of [`gcloud compute sign-url`](https://cloud.google.com/sdk/gcloud/reference/compute/sign-url) based on [Google Cloud CDN Documentation](https://cloud.google.com/cdn/docs/using-signed-urls#signing_urls).
+The provided file includes implementation of base64url encode and decode functions based on [RFC4648 Section 5](https://tools.ietf.org/html/rfc4648#section-5).
+
+## Usage
+
+```
+
+  require_once 'signUrl.php';
+  $base64url_key = 'wpLL7f4VB9RNe_WI0BBGmA=='; // head -c 16 /dev/urandom | base64 | tr +/ -_
+  $signed_url = signUrl('https://example.com/foo', 'my-key', $base64url_key, time() + 1800);
+  echo $signed_url;
+?>
+```

cdn/phpunit.xml.dist

@@ -0,0 +1,31 @@
+xml version="1.0" encoding="UTF-8"?>
+
+<phpunit>
+    <testsuites>
+        <testsuite name="Cloud CDN Sign URL Test">
+            <directory>testdirectory>
+        testsuite>
+    testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    logging>
+    <filter>
+        <whitelist>
+            <file>signUrl.phpfile>
+        whitelist>
+    filter>
+phpunit>

cdn/signUrl.php

@@ -0,0 +1,84 @@
+
+/*
+ * Copyright 2018 Google Inc.
+ *
+ * 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.
+ */
+
+# [START signed_url]
+/**
+ * Decodes base64url (RFC4648 Section 5) string
+ *
+ * @param string $input base64url encoded string
+ *
+ * @return string
+ */
+function base64url_decode($input)
+{
+    $input .= str_repeat('=', (4 - strlen($input) % 4) % 4);
+    return base64_decode(strtr($input, '-_', '+/'));
+}
+
+/**
+* Encodes a string with base64url (RFC4648 Section 5)
+* Keeps the '=' padding by default.
+*
+* @param string $input   String to be encoded
+* @param bool   $padding Keep the '=' padding
+*
+* @return string
+*/
+function base64url_encode($input, $padding = true)
+{
+    $output = strtr(base64_encode($input), '+/', '-_');
+    return ($padding) ? $output : str_replace('=', '',  $output);
+}
+
+/**
+ * Creates signed URL for Google Cloud CDN
+ * Details about order of operations: https://cloud.google.com/cdn/docs/using-signed-urls#creating_signed_urls
+ *
+ * Example function invocation (In production store the key safely with other secrets):
+ *
+ *     
+ *     $base64UrlKey = 'wpLL7f4VB9RNe_WI0BBGmA=='; // head -c 16 /dev/urandom | base64 | tr +/ -_
+ *     $signedUrl = sign_url('https://example.com/foo', 'my-key', $base64UrlKey, time() + 1800);
+ *     echo $signedUrl;
+ *     ?>
+ *
+ * @param string $url             URL of the endpoint served by Cloud CDN
+ * @param string $keyName         Name of the signing key added to the Google Cloud Storage bucket or service
+ * @param string $base64UrlKey    Signing key as base64url (RFC4648 Section 5) encoded string
+ * @param int    $expirationTime  Expiration time as a UNIX timestamp (GMT, e.g. time())
+ *
+ * @return string
+ */
+function sign_url($url, $keyName, $base64UrlKey, $expirationTime)
+{
+    // Decode the key
+    $decodedKey = base64url_decode($base64UrlKey, true);
+
+    // Determine which separator makes sense given a URL
+    $separator = (strpos($url, '?') === false) ? '?' : '&';
+
+    // Concatenate url with expected query parameters Expires and KeyName
+    $url = "{$url}{$separator}Expires={$expirationTime}&KeyName={$keyName}";
+
+    // Sign the url using the key and encode the signature using base64url
+    $signature = hash_hmac('sha1', $url, $decodedKey, true);
+    $encodedSignature = base64url_encode($signature);
+
+    // Concatenate the URL and encoded signature
+    return "{$url}&Signature={$encodedSignature}";
+}
+// [END signed_url]

cdn/test/signUrlTest.php

@@ -0,0 +1,62 @@
+
+/*
+ * Copyright 2018 Google Inc.
+ *
+ * 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.
+ */
+
+use PHPUnit\Framework\TestCase;
+
+require_once __DIR__."/../signUrl.php";
+
+class signUrlTest extends TestCase
+{
+    public function testBase64UrlEncode()
+    {
+        $this->assertEquals(base64url_encode(hex2bin("9d9b51a2174d17d9b770a336e0870ae3")), "nZtRohdNF9m3cKM24IcK4w==");
+    }
+
+    public function testBase64UrlEncodeWithoutPadding()
+    {
+        $this->assertEquals(base64url_encode(hex2bin("9d9b51a2174d17d9b770a336e0870ae3"), false), "nZtRohdNF9m3cKM24IcK4w");
+    }
+
+    public function testBase64UrlDecode()
+    {
+        $this->assertEquals(hex2bin("9d9b51a2174d17d9b770a336e0870ae3"), base64url_decode("nZtRohdNF9m3cKM24IcK4w=="));
+    }
+
+    public function testBase64UrlDecodeWithoutPadding()
+    {
+        $this->assertEquals(hex2bin("9d9b51a2174d17d9b770a336e0870ae3"), base64url_decode("nZtRohdNF9m3cKM24IcK4w"));
+    }
+
+    public function testSignUrl()
+    {
+        $encoded_key="nZtRohdNF9m3cKM24IcK4w=="; // base64url encoded key
+
+        $cases = array(
+            array("http://35.186.234.33/index.html", "my-key", 1558131350,
+                  "http://35.186.234.33/index.html?Expires=1558131350&KeyName=my-key&Signature=fm6JZSmKNsB5sys8VGr-JE4LiiE="),
+            array("https://www.google.com/", "my-key", 1549751401,
+                  "https://www.google.com/?Expires=1549751401&KeyName=my-key&Signature=M_QO7BGHi2sGqrJO-MDr0uhDFuc="),
+            array("https://www.example.com/some/path?some=query&another=param", "my-key", 1549751461,
+                  "https://www.example.com/some/path?some=query&another=param&Expires=1549751461&KeyName=my-key&Signature=sTqqGX5hUJmlRJ84koAIhWW_c3M="),
+        );
+
+        foreach($cases as $c)
+        {
+            $this->assertEquals(sign_url($c[0], $c[1], $encoded_key, $c[2]), $c[3]);
+        }
+    }
+}