This page describes how to use your own encryption key, referred to as acustomer-supplied encryption key, with Cloud Storage. For other encryption
options in Cloud Storage, seeData Encryption Options.
Generate your own encryption key
There are many ways to generate aBase64-encodedAES-256
encryption key. Here are several examples:
// Create a pseudo-random number generator (PRNG), this is included for
// demonstration purposes only. You should consult your security team about
// best practices to initialize PRNG. In particular, you should verify that
// the C++ library and operating system provide enough entropy to meet the
// security policies in your organization.
// Use the Mersenne-Twister Engine in this example:
// https://en.cppreference.com/w/cpp/numeric/random/mersenne_twister_engine
// Any C++ PRNG can be used below, the choice is arbitrary.
using GeneratorType = std::mt19937_64;
// Create the default random device to fetch entropy.
std::random_device rd;
// Compute how much entropy we need to initialize the GeneratorType:
constexpr auto kRequiredEntropyWords =
GeneratorType::state_size *
(GeneratorType::word_size / std::numeric_limits<unsigned int>::digits);
// Capture the entropy bits into a vector.
std::vector<std::uint64_t> entropy(kRequiredEntropyWords);
std::generate(entropy.begin(), entropy.end(), [&rd] { return rd(); });
// Create the PRNG with the fetched entropy.
std::seed_seq seed(entropy.begin(), entropy.end());
// initialized with enough entropy such that the encryption keys are not
// predictable. Note that the default constructor for all the generators in
// the C++ standard library produce predictable keys.
std::mt19937_64 gen(seed);
namespace gcs = ::google::cloud::storage;
gcs::EncryptionKeyData data = gcs::CreateKeyFromGenerator(gen);
std::cout << "Base64 encoded key = " << data.key << "\n"
<< "Base64 encoded SHA256 of key = " << data.sha256 << "\n";
using Google.Cloud.Storage.V1;
using System;
public class GenerateEncryptionKeySample
{
public string GenerateEncryptionKey()
{
var encryptionKey = EncryptionKey.Generate().Base64Key;
Console.WriteLine($"Generated Base64-encoded AES-256 encryption key: {encryptionKey}");
return encryptionKey;
}
}
import (
"crypto/rand"
"encoding/base64"
"fmt"
"io"
)
// generateEncryptionKey generates a 256 bit (32 byte) AES encryption key and
// prints the base64 representation.
func generateEncryptionKey(w io.Writer) error {
// This is included for demonstration purposes. You should generate your own
// key. Please remember that encryption keys should be handled with a
// comprehensive security policy.
key := make([]byte, 32)
if _, err := rand.Read(key); err != nil {
return fmt.Errorf("rand.Read: %w", err)
}
encryptionKey := base64.StdEncoding.EncodeToString(key)
fmt.Fprintf(w, "Generated base64-encoded encryption key: %v\n", encryptionKey)
return nil
}
import com.google.common.io.BaseEncoding;
import java.security.SecureRandom;
public class GenerateEncryptionKey {
/**
* Generates a 256 bit (32 byte) AES encryption key and prints the base64 representation. This is
* included for demonstration purposes only. You should generate your own key, and consult your
* security team about best practices. Please remember that encryption keys should be handled with
* a comprehensive security policy.
*/
public static void generateEncryptionKey() {
byte[] key = new byte[32];
new SecureRandom().nextBytes(key);
String encryptionKey = BaseEncoding.base64().encode(key);
System.out.println("Generated Base64-encoded AES-256 encryption key: " + encryptionKey);
}
}
const crypto = require('crypto');
function generateEncryptionKey() {
/**
* Generates a 256 bit (32 byte) AES encryption key and prints the base64
* representation.
*
* This is included for demonstration purposes. You should generate your own
* key. Please remember that encryption keys should be handled with a
* comprehensive security policy.
*/
const buffer = crypto.randomBytes(32);
const encodedKey = buffer.toString('base64');
console.log(`Base 64 encoded encryption key: ${encodedKey}`);
}
generateEncryptionKey();
import base64
import os
def generate_encryption_key():
"""Generates a 256 bit (32 byte) AES encryption key and prints the
base64 representation.
This is included for demonstration purposes. You should generate your own
key. Please remember that encryption keys should be handled with a
comprehensive security policy.
"""
key = os.urandom(32)
encoded_key = base64.b64encode(key).decode("utf-8")
print(f"Base 64 encoded encryption key: {encoded_key}")
def generate_encryption_key
# Generates a 256 bit (32 byte) AES encryption key and prints the base64 representation.
#
# This is included for demonstration purposes. You should generate your own key.
# Please remember that encryption keys should be handled with a comprehensive security policy.
require "base64"
require "openssl"
encryption_key = OpenSSL::Cipher.new("aes-256-cfb").encrypt.random_key
encoded_enc_key = Base64.encode64 encryption_key
puts "Sample encryption key: #{encoded_enc_key}"
end
Upload with your encryption key
To use customer-supplied encryption keys to upload an object:
Console
The Google Cloud console cannot be used to upload an object with a
customer-supplied encryption key. Use the Google Cloud CLI or the client
libraries instead.
SOURCE_DATAis the source location of the data
you're encrypting. This can be any source location supported by thecpcommand. For example, a local file such asDesktop/dogs.pngor another Cloud Storage object such asgs://my-bucket/pets/old-dog.png.
BUCKET_NAMEis the name of the destination
bucket for this copy command. For example,my-bucket.
OBJECT_NAMEis the name of the final,
encrypted object. For example,pets/new-dog.png.
YOUR_ENCRYPTION_KEYis theAES-256 keythat you want to use for encrypting the uploaded object.
import (
"context"
"fmt"
"io"
"time"
"cloud.google.com/go/storage"
)
// uploadEncryptedFile writes an object using AES-256 encryption key.
func uploadEncryptedFile(w io.Writer, bucket, object string, secretKey []byte) error {
// bucket := "bucket-name"
// object := "object-name"
// secretKey := []byte("secret-key")
ctx := context.Background()
client, err := storage.NewClient(ctx)
if err != nil {
return fmt.Errorf("storage.NewClient: %w", err)
}
defer client.Close()
ctx, cancel := context.WithTimeout(ctx, time.Second*50)
defer cancel()
o := client.Bucket(bucket).Object(object)
// Optional: set a generation-match precondition to avoid potential race
// conditions and data corruptions. The request to upload is aborted if the
// object's generation number does not match your precondition.
// For an object that does not yet exist, set the DoesNotExist precondition.
o = o.If(storage.Conditions{DoesNotExist: true})
// If the live object already exists in your bucket, set instead a
// generation-match precondition using the live object's generation number.
// attrs, err := o.Attrs(ctx)
// if err != nil {
// return fmt.Errorf("object.Attrs: %w", err)
// }
// o = o.If(storage.Conditions{GenerationMatch: attrs.Generation})
// Encrypt the object's contents.
wc := o.Key(secretKey).NewWriter(ctx)
if _, err := wc.Write([]byte("top secret")); err != nil {
return fmt.Errorf("Writer.Write: %w", err)
}
if err := wc.Close(); err != nil {
return fmt.Errorf("Writer.Close: %w", err)
}
fmt.Fprintf(w, "Uploaded encrypted object %v.\n", object)
return nil
}
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
public class UploadEncryptedObject {
public static void uploadEncryptedObject(
String projectId, String bucketName, String objectName, String filePath, String encryptionKey)
throws IOException {
// The ID of your GCP project
// String projectId = "your-project-id";
// The ID of your GCS bucket
// String bucketName = "your-unique-bucket-name";
// The ID of your GCS object
// String objectName = "your-object-name";
// The path to your file to upload
// String filePath = "path/to/your/file"
// The key to encrypt the object with
// String encryptionKey = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=";
Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
BlobId blobId = BlobId.of(bucketName, objectName);
BlobInfo blobInfo = BlobInfo.newBuilder(blobId).build();
// Optional: set a generation-match precondition to avoid potential race
// conditions and data corruptions. The request returns a 412 error if the
// preconditions are not met.
Storage.BlobTargetOption precondition;
if (storage.get(bucketName, objectName) == null) {
// For a target object that does not yet exist, set the DoesNotExist precondition.
// This will cause the request to fail if the object is created before the request runs.
precondition = Storage.BlobTargetOption.doesNotExist();
} else {
// If the destination already exists in your bucket, instead set a generation-match
// precondition. This will cause the request to fail if the existing object's generation
// changes before the request runs.
precondition =
Storage.BlobTargetOption.generationMatch(
storage.get(bucketName, objectName).getGeneration());
}
storage.create(
blobInfo,
Files.readAllBytes(Paths.get(filePath)),
Storage.BlobTargetOption.encryptionKey(encryptionKey),
precondition);
System.out.println(
"File "
+ filePath
+ " uploaded to bucket "
+ bucketName
+ " as "
+ objectName
+ " with supplied encryption key");
}
}
/**
* TODO(developer): Uncomment the following lines before running the sample.
*/
// The ID of your GCS bucket
// const bucketName = 'your-unique-bucket-name';
// The path to your file to upload
// const filePath = 'path/to/your/file';
// The new ID for your GCS file
// const destFileName = 'your-new-file-name';
// The key to encrypt the object with
// const key = 'TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=';
// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');
// Creates a client
const storage = new Storage();
async function uploadEncryptedFile() {
const options = {
destination: destFileName,
encryptionKey: Buffer.from(key, 'base64'),
// Optional:
// Set a generation-match precondition to avoid potential race conditions
// and data corruptions. The request to upload is aborted if the object's
// generation number does not match your precondition. For a destination
// object that does not yet exist, set the ifGenerationMatch precondition to 0
// If the destination object already exists in your bucket, set instead a
// generation-match precondition using its generation number.
preconditionOpts: {ifGenerationMatch: generationMatchPrecondition},
};
await storage.bucket(bucketName).upload(filePath, options);
console.log(
`File ${filePath} uploaded to gs://${bucketName}/${destFileName}`
);
}
uploadEncryptedFile().catch(console.error);
import base64
from google.cloud import storage
def upload_encrypted_blob(
bucket_name,
source_file_name,
destination_blob_name,
base64_encryption_key,
):
"""Uploads a file to a Google Cloud Storage bucket using a custom
encryption key.
The file will be encrypted by Google Cloud Storage and only
retrievable using the provided encryption key.
"""
# bucket_name = "your-bucket-name"
# source_file_name = "local/path/to/file"
# destination_blob_name = "storage-object-name"
# base64_encryption_key = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g="
storage_client = storage.Client()
bucket = storage_client.bucket(bucket_name)
# Encryption key must be an AES256 key represented as a bytestring with
# 32 bytes. Since it's passed in as a base64 encoded string, it needs
# to be decoded.
encryption_key = base64.b64decode(base64_encryption_key)
blob = bucket.blob(
destination_blob_name, encryption_key=encryption_key
)
# Optional: set a generation-match precondition to avoid potential race conditions
# and data corruptions. The request to upload is aborted if the object's
# generation number does not match your precondition. For a destination
# object that does not yet exist, set the if_generation_match precondition to 0.
# If the destination object already exists in your bucket, set instead a
# generation-match precondition using its generation number.
generation_match_precondition = 0
blob.upload_from_filename(source_file_name, if_generation_match=generation_match_precondition)
print(
f"File {source_file_name} uploaded to {destination_blob_name}."
)
def upload_encrypted_file bucket_name:, local_file_path:, file_name: nil, encryption_key:
# The ID of your GCS bucket
# bucket_name = "your-unique-bucket-name"
# The path to your file to upload
# local_file_path = "/local/path/to/file.txt"
# The ID of your GCS object
# file_name = "your-file-name"
# The key to encrypt the object with
# encryption_key = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g="
require "google/cloud/storage"
storage = Google::Cloud::Storage.new
bucket = storage.bucket bucket_name, skip_lookup: true
file = bucket.create_file local_file_path, file_name, encryption_key: encryption_key
puts "Uploaded #{file.name} with encryption key"
end
To download an object stored in Cloud Storage that is encrypted with a
customer-supplied encryption key:
Console
The Google Cloud console cannot be used to download objects encrypted with
customer-supplied encryption keys. Use the Google Cloud CLI or the client
libraries instead.
using Google.Cloud.Storage.V1;
using System;
using System.IO;
public class DownloadEncryptedFileSample
{
public void DownloadEncryptedFile(
string key = "3eFsTXPvqi3BpT2ipFCGirslh1Jgc6ikjoAu2oQ5JcI=",
string bucketName = "your-unique-bucket-name",
string objectName = "my-file-name",
string localPath = "my-local-path/my-file-name")
{
var storage = StorageClient.Create();
using var outputFile = File.OpenWrite(localPath);
storage.DownloadObject(bucketName, objectName, outputFile, new DownloadObjectOptions
{
EncryptionKey = EncryptionKey.Create(Convert.FromBase64String(key))
});
Console.WriteLine($"Downloaded {objectName} to {localPath}.");
}
}
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
import java.io.IOException;
import java.nio.file.Path;
public class DownloadEncryptedObject {
public static void downloadEncryptedObject(
String projectId,
String bucketName,
String objectName,
Path destFilePath,
String decryptionKey)
throws IOException {
// The ID of your GCP project
// String projectId = "your-project-id";
// The ID of your GCS bucket
// String bucketName = "your-unique-bucket-name";
// The ID of your GCS object
// String objectName = "your-object-name";
// The path to which the file should be downloaded
// Path destFilePath = Paths.get("/local/path/to/file.txt");
// The Base64 encoded decryption key, which should be the same key originally used to encrypt
// the object
// String decryptionKey = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=";
Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
Blob blob = storage.get(bucketName, objectName);
blob.downloadTo(destFilePath, Blob.BlobSourceOption.decryptionKey(decryptionKey));
System.out.println(
"Downloaded object "
+ objectName
+ " from bucket name "
+ bucketName
+ " to "
+ destFilePath
+ " using customer-supplied encryption key");
}
}
/**
* TODO(developer): Uncomment the following lines before running the sample.
*/
// The ID of your GCS bucket
// const bucketName = 'your-unique-bucket-name';
// The ID of your GCS file
// const srcFileName = 'your-file-name';
// The path to which the file should be downloaded
// const destFileName = '/local/path/to/file.txt';
// The Base64 encoded decryption key, which should be the same key originally
// used to encrypt the file
// const encryptionKey = 'TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=';
// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');
// Creates a client
const storage = new Storage();
async function downloadEncryptedFile() {
const options = {
destination: destFileName,
};
// Decrypts and downloads the file. This can only be done with the key used
// to encrypt and upload the file.
await storage
.bucket(bucketName)
.file(srcFileName)
.setEncryptionKey(Buffer.from(encryptionKey, 'base64'))
.download(options);
console.log(`File ${srcFileName} downloaded to ${destFileName}`);
}
downloadEncryptedFile().catch(console.error);
use Google\Cloud\Storage\StorageClient;
/**
* Download an encrypted file
*
* @param string $bucketName The name of your Cloud Storage bucket.
* (e.g. 'my-bucket')
* @param string $objectName The name of your Cloud Storage object.
* (e.g. 'my-object')
* @param string $destination The local destination to save the encrypted file.
* (e.g. '/path/to/your/file')
* @param string $base64EncryptionKey The base64 encoded encryption key. Should
* (e.g. 'TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=')
* be the same key originally used to encrypt the object.
*/
function download_encrypted_object(string $bucketName, string $objectName, string $destination, string $base64EncryptionKey): void
{
$storage = new StorageClient();
$bucket = $storage->bucket($bucketName);
$object = $bucket->object($objectName);
$object->downloadToFile($destination, [
'encryptionKey' => $base64EncryptionKey,
]);
printf('Encrypted object gs://%s/%s downloaded to %s' . PHP_EOL,
$bucketName, $objectName, basename($destination));
}
import base64
from google.cloud import storage
def download_encrypted_blob(
bucket_name,
source_blob_name,
destination_file_name,
base64_encryption_key,
):
"""Downloads a previously-encrypted blob from Google Cloud Storage.
The encryption key provided must be the same key provided when uploading
the blob.
"""
# bucket_name = "your-bucket-name"
# source_blob_name = "storage-object-name"
# destination_file_name = "local/path/to/file"
# base64_encryption_key = "base64-encoded-encryption-key"
storage_client = storage.Client()
bucket = storage_client.bucket(bucket_name)
# Encryption key must be an AES256 key represented as a bytestring with
# 32 bytes. Since it's passed in as a base64 encoded string, it needs
# to be decoded.
encryption_key = base64.b64decode(base64_encryption_key)
blob = bucket.blob(source_blob_name, encryption_key=encryption_key)
blob.download_to_filename(destination_file_name)
print(
f"Blob {source_blob_name} downloaded to {destination_file_name}."
)
def download_encrypted_file bucket_name:, file_name:, local_file_path:, encryption_key:
# The ID of your GCS bucket
# bucket_name = "your-unique-bucket-name"
# The ID of your GCS object
# file_name = "your-file-name"
# The path to which the file should be downloaded
# local_file_path = "/local/path/to/file.txt"
# The Base64 encoded decryption key, which should be the same key originally used to encrypt the object
# encryption_key = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g="
require "google/cloud/storage"
storage = Google::Cloud::Storage.new
bucket = storage.bucket bucket_name, skip_lookup: true
file = bucket.file file_name, encryption_key: encryption_key
file.download local_file_path, encryption_key: encryption_key
puts "Downloaded encrypted #{file.name} to #{local_file_path}"
end
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.Storage;
import com.google.cloud.storage.StorageOptions;
public class RotateObjectEncryptionKey {
public static void rotateObjectEncryptionKey(
String projectId,
String bucketName,
String objectName,
String oldEncryptionKey,
String newEncryptionKey) {
// The ID of your GCP project
// String projectId = "your-project-id";
// The ID of your GCS bucket
// String bucketName = "your-unique-bucket-name";
// The ID of your GCS object
// String objectName = "your-object-name";
// The Base64 encoded AES-256 encryption key originally used to encrypt the object. See the
// documentation
// on Customer-Supplied Encryption keys for more info:
// https://cloud.google.com/storage/docs/encryption/using-customer-supplied-keys
// String oldEncryptionKey = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g="
// The new encryption key to use
// String newEncryptionKey = "0mMWhFvQOdS4AmxRpo8SJxXn5MjFhbz7DkKBUdUIef8="
Storage storage = StorageOptions.newBuilder().setProjectId(projectId).build().getService();
BlobId blobId = BlobId.of(bucketName, objectName);
Blob blob = storage.get(blobId);
if (blob == null) {
System.out.println("The object " + objectName + " wasn't found in " + bucketName);
return;
}
// Optional: set a generation-match precondition to avoid potential race
// conditions and data corruptions. The request to upload returns a 412 error if
// the object's generation number does not match your precondition.
Storage.BlobSourceOption precondition =
Storage.BlobSourceOption.generationMatch(blob.getGeneration());
// You can't change an object's encryption key directly, the only way is to overwrite the object
Storage.CopyRequest request =
Storage.CopyRequest.newBuilder()
.setSource(blobId)
.setSourceOptions(
Storage.BlobSourceOption.decryptionKey(oldEncryptionKey), precondition)
.setTarget(blobId, Storage.BlobTargetOption.encryptionKey(newEncryptionKey))
.build();
storage.copy(request);
System.out.println(
"Rotated encryption key for object " + objectName + "in bucket " + bucketName);
}
}
/**
* TODO(developer): Uncomment the following lines before running the sample.
*/
// The ID of your GCS bucket
// const bucketName = 'your-unique-bucket-name';
// The ID of your GCS file
// const fileName = 'your-file-name';
// The Base64 encoded AES-256 encryption key originally used to encrypt the
// object. See the documentation on Customer-Supplied Encryption keys for
// more info:
// https://cloud.google.com/storage/docs/encryption/using-customer-supplied-keys
// The Base64 encoded AES-256 encryption key originally used to encrypt the
// const oldKey = 'TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=';
// The new encryption key to use
// const newKey = '0mMWhFvQOdS4AmxRpo8SJxXn5MjFhbz7DkKBUdUIef8=';
// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');
// Creates a client
const storage = new Storage();
async function rotateEncryptionKey() {
const rotateEncryptionKeyOptions = {
encryptionKey: Buffer.from(newKey, 'base64'),
// Optional: set a generation-match precondition to avoid potential race
// conditions and data corruptions. The request to copy is aborted if the
// object's generation number does not match your precondition.
preconditionOpts: {
ifGenerationMatch: generationMatchPrecondition,
},
};
await storage
.bucket(bucketName)
.file(fileName, {
encryptionKey: Buffer.from(oldKey, 'base64'),
})
.rotateEncryptionKey({
rotateEncryptionKeyOptions,
});
console.log('Encryption key rotated successfully');
}
rotateEncryptionKey().catch(console.error);
use Google\Cloud\Storage\StorageClient;
/**
* Change the encryption key used to store an existing object.
*
* @param string $bucketName The name of your Cloud Storage bucket.
* (e.g. 'my-bucket')
* @param string $objectName The name of your Cloud Storage object.
* (e.g. 'my-object')
* @param string $oldBase64EncryptionKey The Base64 encoded AES-256 encryption
* key originally used to encrypt the object. See the documentation on
* Customer-Supplied Encryption keys for more info:
* https://cloud.google.com/storage/docs/encryption/using-customer-supplied-keys
* (e.g. 'TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g=')
* @param string $newBase64EncryptionKey The new base64 encoded encryption key.
* (e.g. '0mMWhFvQOdS4AmxRpo8SJxXn5MjFhbz7DkKBUdUIef8=')
*/
function rotate_encryption_key(
string $bucketName,
string $objectName,
string $oldBase64EncryptionKey,
string $newBase64EncryptionKey
): void {
$storage = new StorageClient();
$object = $storage->bucket($bucketName)->object($objectName);
$rewrittenObject = $object->rewrite($bucketName, [
'encryptionKey' => $oldBase64EncryptionKey,
'destinationEncryptionKey' => $newBase64EncryptionKey,
]);
printf('Rotated encryption key for object gs://%s/%s' . PHP_EOL,
$bucketName, $objectName);
}
import base64
from google.cloud import storage
def rotate_encryption_key(
bucket_name, blob_name, base64_encryption_key, base64_new_encryption_key
):
"""Performs a key rotation by re-writing an encrypted blob with a new
encryption key."""
storage_client = storage.Client()
bucket = storage_client.bucket(bucket_name)
current_encryption_key = base64.b64decode(base64_encryption_key)
new_encryption_key = base64.b64decode(base64_new_encryption_key)
# Both source_blob and destination_blob refer to the same storage object,
# but destination_blob has the new encryption key.
source_blob = bucket.blob(
blob_name, encryption_key=current_encryption_key
)
destination_blob = bucket.blob(
blob_name, encryption_key=new_encryption_key
)
generation_match_precondition = None
token = None
# Optional: set a generation-match precondition to avoid potential race conditions
# and data corruptions. The request to rewrite is aborted if the object's
# generation number does not match your precondition.
source_blob.reload() # Fetch blob metadata to use in generation_match_precondition.
generation_match_precondition = source_blob.generation
while True:
token, bytes_rewritten, total_bytes = destination_blob.rewrite(
source_blob, token=token, if_generation_match=generation_match_precondition
)
if token is None:
break
print(f"Key rotation complete for Blob {blob_name}")
def rotate_encryption_key bucket_name:, file_name:, current_encryption_key:, new_encryption_key:
# The ID of your GCS bucket
# bucket_name = "your-unique-bucket-name"
# The ID of your GCS object
# file_name = "your-file-name"
# The Base64 encoded AES-256 encryption key originally used to encrypt the object.
# See the documentation on Customer-Supplied Encryption keys for more info:
# https://cloud.google.com/storage/docs/encryption/using-customer-supplied-keys
# current_encryption_key = "TIbv/fjexq+VmtXzAlc63J4z5kFmWJ6NdAPQulQBT7g="
# The new encryption key to use
# new_encryption_key = "0mMWhFvQOdS4AmxRpo8SJxXn5MjFhbz7DkKBUdUIef8="
require "google/cloud/storage"
storage = Google::Cloud::Storage.new
bucket = storage.bucket bucket_name, skip_lookup: true
file = bucket.file file_name, encryption_key: current_encryption_key
file.rotate encryption_key: current_encryption_key,
new_encryption_key: new_encryption_key
puts "The encryption key for #{file.name} in #{bucket.name} was rotated."
end
The XML API does not support rotating a customer-supplied encryption
key through rewriting object. To apply a new customer-supplied key to an
object using the XML API, you should:
