Example for reading and writing encrypted blobs.

Jerjou Cheng · garrettjonesgoogle · commit 37ca9863b9f3 · 2016-12-01T10:02:37.000-08:00
diff --git a/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/StorageSnippets.java b/google-cloud-examples/src/main/java/com/google/cloud/examples/storage/snippets/StorageSnippets.java
@@ -44,6 +44,7 @@
 import com.google.cloud.storage.Storage.BlobListOption;
 import com.google.cloud.storage.Storage.BlobSourceOption;
 import com.google.cloud.storage.Storage.BlobTargetOption;
+import com.google.cloud.storage.Storage.BlobWriteOption;
 import com.google.cloud.storage.Storage.BucketGetOption;
 import com.google.cloud.storage.Storage.BucketListOption;
 import com.google.cloud.storage.Storage.BucketSourceOption;
@@ -153,6 +154,26 @@ public Blob createBlobFromInputStream(String bucketName, String blobName) {
     return blob;
   }
 
+  /**
+   * Example of uploading an encrypted blob.
+   */
+  // [TARGET create(BlobInfo, InputStream, BlobWriteOption...)]
+  // [VARIABLE "my_unique_bucket"]
+  // [VARIABLE "my_blob_name"]
+  // [VARIABLE "my_encryption_key"]
+  public Blob createEncryptedBlob(String bucketName, String blobName, String encryptionKey) {
+    // [START storageUploadEncryptedFile]
+    InputStream content = new ByteArrayInputStream("Hello, World!".getBytes(UTF_8));
+
+    BlobId blobId = BlobId.of(bucketName, blobName);
+    BlobInfo blobInfo = BlobInfo.newBuilder(blobId)
+        .setContentType("text/plain")
+        .build();
+    Blob blob = storage.create(blobInfo, content, BlobWriteOption.encryptionKey(encryptionKey));
+    // [END storageUploadEncryptedFile]
+    return blob;
+  }
+
   /**
    * Example of getting information on a bucket, only if its metageneration matches a value,
    * otherwise a {@link StorageException} is thrown.
@@ -470,7 +491,7 @@ public byte[] readBlobFromStringsWithGeneration(String bucketName, String blobNa
   // [TARGET readAllBytes(BlobId, BlobSourceOption...)]
   // [VARIABLE "my_unique_bucket"]
   // [VARIABLE "my_blob_name"]
-  // [VARIABLE 42"]
+  // [VARIABLE 42]
   public byte[] readBlobFromId(String bucketName, String blobName, long blobGeneration) {
     // [START readBlobFromId]
     BlobId blobId = BlobId.of(bucketName, blobName, blobGeneration);
@@ -479,6 +500,21 @@ public byte[] readBlobFromId(String bucketName, String blobName, long blobGenera
     return content;
   }
 
+  /**
+   * Example of reading all bytes of an encrypted blob.
+   */
+  // [TARGET readAllBytes(BlobId, BlobSourceOption...)]
+  // [VARIABLE "my_unique_bucket"]
+  // [VARIABLE "my_blob_name"]
+  // [VARIABLE "my_encryption_key"]
+  public byte[] readEncryptedBlob(String bucketName, String blobName, String decryptionKey) {
+    // [START readEncryptedBlob]
+    byte[] content = storage.readAllBytes(
+        bucketName, blobName, BlobSourceOption.decryptionKey(decryptionKey));
+    // [END readEncryptedBlob]
+    return content;
+  }
+
   /**
    * Example of using a batch request to delete, update and get a blob.
    */
diff --git a/google-cloud-examples/src/test/java/com/google/cloud/examples/storage/snippets/ITStorageSnippets.java b/google-cloud-examples/src/test/java/com/google/cloud/examples/storage/snippets/ITStorageSnippets.java
@@ -145,6 +145,20 @@ public void testBlob() throws InterruptedException {
     copiedBlob.delete();
   }
 
+  @Test
+  public void testCreateEncryptedBlob() throws InterruptedException {
+    // Note: DO NOT put your encryption key in your code, like it is here. Store it somewhere safe,
+    // and read it in when you need it. This key is just here to make the code easier to read.
+    String encryptionKey = "0mMWhFvQOdS4AmxRpo8SJxXn5MjFhbz7DkKBUdUIef8=";
+
+    String blobName = "encrypted-blob";
+    Blob blob = storageSnippets.createEncryptedBlob(BUCKET, blobName, encryptionKey);
+
+    assertNotNull(blob);
+    byte[] encryptedContent = storageSnippets.readEncryptedBlob(BUCKET, blobName, encryptionKey);
+    assertEquals("Hello, World!", new String(encryptedContent));
+  }
+
   @Test
   public void testCreateCopyAndGetBlob() {
     String blobName = "test-create-copy-get-blob";
diff --git a/google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java b/google-cloud-storage/src/main/java/com/google/cloud/storage/Storage.java
@@ -1566,6 +1566,20 @@ public static Builder newBuilder() {
    * Blob blob = storage.create(blobInfo, content);
    * }</pre>
    *
+   * <p>Example of uploading an encrypted blob.
+   * <pre> {@code
+   * String bucketName = "my_unique_bucket";
+   * String blobName = "my_blob_name";
+   * String encryptionKey = "my_encryption_key";
+   * InputStream content = new ByteArrayInputStream("Hello, World!".getBytes(UTF_8));
+   * 
+   * BlobId blobId = BlobId.of(bucketName, blobName);
+   * BlobInfo blobInfo = BlobInfo.newBuilder(blobId)
+   *     .setContentType("text/plain")
+   *     .build();
+   * Blob blob = storage.create(blobInfo, content, BlobWriteOption.encryptionKey(encryptionKey));
+   * }</pre>
+   *
    * @return a [@code Blob} with complete information
    * @throws StorageException upon failure
    */
@@ -1921,11 +1935,20 @@ public static Builder newBuilder() {
    * <pre> {@code
    * String bucketName = "my_unique_bucket";
    * String blobName = "my_blob_name";
-   * long blobGeneration = 42";
+   * long blobGeneration = 42;
    * BlobId blobId = BlobId.of(bucketName, blobName, blobGeneration);
    * byte[] content = storage.readAllBytes(blobId);
    * }</pre>
    *
+   * <p>Example of reading all bytes of an encrypted blob.
+   * <pre> {@code
+   * String bucketName = "my_unique_bucket";
+   * String blobName = "my_blob_name";
+   * String decryptionKey = "my_encryption_key";
+   * byte[] content = storage.readAllBytes(
+   *     bucketName, blobName, BlobSourceOption.decryptionKey(decryptionKey));
+   * }</pre>
+   *
    * @return the blob's content
    * @throws StorageException upon failure
    */
