Add Secret Manager samples

secretmanager/README.md

@@ -0,0 +1,65 @@
+# Google Secret Manager PHP Sample Application
+
+[![Open in Cloud Shell][shell_img]][shell_link]
+
+[shell_img]: http://gstatic.com/cloudssh/images/open-btn.svg
+[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googlecloudplatform/php-docs-samples&page=editor&working_dir=secretmanager
+
+## Description
+
+This simple command-line application demonstrates how to invoke
+[Google Secret Manager][secretmanager] from PHP.
+
+## Build and Run
+
+1.  **Enable APIs** - [Enable the Secret Manager
+    API](https://console.cloud.google.com/flows/enableapi?apiid=secretmanager.googleapis.com)
+    and create a new project or select an existing project.
+
+1.  **Download The Credentials** - Click "Go to credentials" after enabling the
+    APIs. Click "New Credentials" and select "Service Account Key". Create a new
+    service account, use the JSON key type, and select "Create". Once
+    downloaded, set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to
+    the path of the JSON key that was downloaded.
+
+1.  **Clone the repo** and cd into this directory
+
+    ```text
+    $ git clone https://github.com/GoogleCloudPlatform/php-docs-samples
+    $ cd php-docs-samples/secretmanager
+    ```
+
+1.  **Install dependencies** via [Composer][install-composer]. If composer is
+    installed locally:
+
+
+    ```text
+    $ php composer.phar install
+    ```
+
+    If composer is installed globally:
+
+    ```text
+    $ composer install
+    ```
+
+1.  Execute the snippets in the [src/](src/) directory by running:
+
+    ```text
+    $ php src/SNIPPET_NAME.php
+    ```
+
+    The usage will print for each if no arguments are provided.
+
+See the [Secret Manager Documentation](https://cloud.google.com/secret-manager/docs) for more information.
+
+## Contributing changes
+
+* See [CONTRIBUTING.md](../CONTRIBUTING.md)
+
+## Licensing
+
+* See [LICENSE](../LICENSE)
+
+[install-composer]: http://getcomposer.org/doc/00-intro.md
+[secretmanager]: https://cloud.google.com/secret-manager

secretmanager/composer.json

@@ -0,0 +1,5 @@
+{
+    "require": {
+        "google/cloud-secret-manager": "^0.1.0"
+    }
+}

secretmanager/phpunit.xml.dist

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  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.
+-->
+<phpunit bootstrap="../testing/bootstrap.php">
+  <testsuites>
+    <testsuite name="PHP Secret Manager test">
+      <directory>test</directory>
+    </testsuite>
+  </testsuites>
+  <logging>
+    <log type="coverage-clover" target="build/logs/clover.xml"/>
+  </logging>
+  <filter>
+    <whitelist>
+      <directory suffix=".php">./src</directory>
+      <exclude>
+        <directory>./vendor</directory>
+      </exclude>
+    </whitelist>
+  </filter>
+  <php>
+    <env name="PHPUNIT_TESTS" value="1"/>
+  </php>
+</phpunit>

secretmanager/quickstart.php

@@ -0,0 +1,68 @@
+<?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.
+ */
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/vendor/autoload.php';
+
+if (count($argv) != 3) {
+    return printf("Usage: php %s PROJECT_ID SECRET_ID\n", basename(__FILE__));
+}
+list($_, $projectId, $secretId) = $argv;
+
+// [START secretmanager_quickstart]
+// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1beta1\Replication;
+use Google\Cloud\SecretManager\V1beta1\Replication\Automatic;
+use Google\Cloud\SecretManager\V1beta1\Secret;
+use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1beta1\SecretPayload;
+
+/** Uncomment and populate these variables in your code */
+// $projectId = 'YOUR_GOOGLE_CLOUD_PROJECT' (e.g. 'my-project');
+// $secretId = 'YOUR_SECRET_ID' (e.g. 'my-secret');
+
+// Create the Secret Manager client.
+$client = new SecretManagerServiceClient();
+
+// Build the parent name from the project.
+$parent = $client->projectName($projectId);
+
+// Create the parent secret.
+$secret = $client->createSecret($parent, $secretId, [
+    'secret' => new Secret([
+        'replication' => new Replication([
+            'automatic' => new Automatic(),
+        ]),
+    ]),
+]);
+
+// Add the secret version.
+$version = $client->addSecretVersion($secret->getName(), new SecretPayload([
+    'data' => 'hello world',
+]));
+
+// Access the secret version.
+$response = $client->accessSecretVersion($version->getName());
+
+// Print the secret payload.
+//
+// WARNING: Do not print the secret in a production environment - this
+// snippet is showing how to access the secret material.
+$payload = $response->getPayload()->getData();
+printf('Plaintext: %s' . PHP_EOL, $payload);
+// [END secretmanager_quickstart]

secretmanager/src/access_secret_version.php

@@ -0,0 +1,57 @@
+<?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/secretmanager/README.md
+ */
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 4) {
+    return printf("Usage: php %s PROJECT_ID SECRET_ID VERSION_ID\n", basename(__FILE__));
+}
+list($_, $projectId, $secretId, $versionId) = $argv;
+
+// [START secretmanager_access_secret_version]
+// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
+
+/** Uncomment and populate these variables in your code */
+// $projectId = 'YOUR_GOOGLE_CLOUD_PROJECT' (e.g. 'my-project');
+// $secretId = 'YOUR_SECRET_ID' (e.g. 'my-secret');
+// $versionId = 'YOUR_VERSION_ID' (e.g. 'latest' or '5');
+
+// Create the Secret Manager client.
+$client = new SecretManagerServiceClient();
+
+// Build the resource name of the secret version.
+$name = $client->secretVersionName($projectId, $secretId, $versionId);
+
+// Access the secret version.
+$response = $client->accessSecretVersion($name);
+
+// Print the secret payload.
+//
+// WARNING: Do not print the secret in a production environment - this
+// snippet is showing how to access the secret material.
+$payload = $response->getPayload()->getData();
+printf('Plaintext: %s', $payload);
+// [END secretmanager_access_secret_version]

secretmanager/src/add_secret_version.php

@@ -0,0 +1,55 @@
+<?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/secretmanager/README.md
+ */
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 3) {
+    return printf("Usage: php %s PROJECT_ID SECRET_ID\n", basename(__FILE__));
+}
+list($_, $projectId, $secretId) = $argv;
+
+// [START secretmanager_add_secret_version]
+// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
+use Google\Cloud\SecretManager\V1beta1\SecretPayload;
+
+/** Uncomment and populate these variables in your code */
+// $projectId = 'YOUR_GOOGLE_CLOUD_PROJECT' (e.g. 'my-project');
+// $secretId = 'YOUR_SECRET_ID' (e.g. 'my-secret');
+
+// Create the Secret Manager client.
+$client = new SecretManagerServiceClient();
+
+// Build the resource name of the parent secret.
+$parent = $client->secretName($projectId, $secretId);
+
+// Access the secret version.
+$response = $client->addSecretVersion($parent, new SecretPayload([
+    'data' => 'my super secret data',
+]));
+
+// Print the new secret version name.
+printf('Added secret version: %s', $response->getName());
+// [END secretmanager_add_secret_version]

secretmanager/src/create_secret.php

@@ -0,0 +1,61 @@
+<?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/secretmanager/README.md
+ */
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+if (count($argv) != 3) {
+    return printf("Usage: php %s PROJECT_ID SECRET_ID\n", basename(__FILE__));
+}
+list($_, $projectId, $secretId) = $argv;
+
+// [START secretmanager_create_secret]
+// Import the Secret Manager client library.
+use Google\Cloud\SecretManager\V1beta1\Replication;
+use Google\Cloud\SecretManager\V1beta1\Replication\Automatic;
+use Google\Cloud\SecretManager\V1beta1\Secret;
+use Google\Cloud\SecretManager\V1beta1\SecretManagerServiceClient;
+
+/** Uncomment and populate these variables in your code */
+// $projectId = 'YOUR_GOOGLE_CLOUD_PROJECT' (e.g. 'my-project');
+// $secretId = 'YOUR_SECRET_ID' (e.g. 'my-secret');
+
+// Create the Secret Manager client.
+$client = new SecretManagerServiceClient();
+
+// Build the resource name of the parent project.
+$parent = $client->projectName($projectId);
+
+// Create the secret.
+$secret = $client->createSecret($parent, $secretId, [
+    'secret' => new Secret([
+        'replication' => new Replication([
+            'automatic' => new Automatic(),
+        ]),
+    ]),
+]);
+
+// Print the new secret name.
+printf('Created secret: %s', $secret->getName());
+// [END secretmanager_create_secret]