cloud.google.com/go/kms v1.35.0: kmspb.CryptoKeyVersion

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion in pkg:golang/cloud.google.com/go/kms@v1.35.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/cloud.google.com/go/kms@v1.35.0
Demonstrate these symbols/APIs:
  - cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:289d067949919b5e6109365519cc4d116ae93fe6d6124b9a0ffb84605f9664c5","contract":["kmspb.CryptoKeyVersion initializes with default empty/unspecified fields and valid proto descriptor","kmspb.CryptoKeyVersion getters return populated field values","kmspb.CryptoKeyVersion getters for nil receiver return zero values safely without panicking","kmspb.CryptoKeyVersion marshals and unmarshals via google.golang.org/protobuf/proto preserving fields","kmspb.CryptoKeyVersion supports proto.Clone producing an isolated deep copy","kmspb.CryptoKeyVersion.Reset clears all fields to their zero values"],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion in pkg:golang/cloud.google.com/go/kms@v1.35.0","kind":"HOW","packages":["pkg:golang/cloud.google.com/go/kms@v1.35.0"],"schemaVersion":1,"symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/cloud.google.com/go/kms@v1.35.0"],"schemaVersion":1,"subject":"pkg:golang/cloud.google.com/go/kms@v1.35.0","symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require (
	cloud.google.com/go/kms v1.35.0
	google.golang.org/protobuf v1.36.12
)

require (
	cloud.google.com/go/longrunning v1.2.0 // indirect
	golang.org/x/net v0.58.0 // indirect
	golang.org/x/sys v0.47.0 // indirect
	golang.org/x/text v0.41.0 // indirect
	google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7 // indirect
	google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7 // indirect
	google.golang.org/grpc v1.83.2 // indirect
)

cloud.google.com/go/kms v1.35.0 h1:nJ/ktaqspx1nPM9vIcO0SHbhqCAm8nvAxL1siuVgKm0=
cloud.google.com/go/kms v1.35.0/go.mod h1:0++71pIHvJL+GmMa8K4jOWFq7gNOX3jm2PRMSJwTKJw=
cloud.google.com/go/longrunning v1.2.0 h1:WjYH3YHBGCxGJP9M4dWGHBfXr/cFIjMkNgWcJj7/iMM=
cloud.google.com/go/longrunning v1.2.0/go.mod h1:5KMQALFGOCtFoi2xSOA1u3H7WKlhmckgiyFw7+LGQp0=
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI=
github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64=
go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y=
go.opentelemetry.io/otel v1.44.0 h1:JjwHmHpA4iZ3wBxluu2fbbE7j4kqlE8jXyAyPXH7HqU=
go.opentelemetry.io/otel v1.44.0/go.mod h1:BMgjTHL9WPRlRjL2oZCBTL4whCGtXch2H4BhOPIAyYc=
go.opentelemetry.io/otel/metric v1.44.0 h1:1w0gILTcHdr3YI+ixLyjemwrVnsMURbTZFrSYCdDdmc=
go.opentelemetry.io/otel/metric v1.44.0/go.mod h1:8O7hanEPBNgEMmybD3s2VBKcgWOCsA6tzHBPODAiquo=
go.opentelemetry.io/otel/sdk v1.44.0 h1:nHYwb9lK+fJPU/dnT6s7W7Z8itMWyqrnVfbheVYrZ58=
go.opentelemetry.io/otel/sdk v1.44.0/go.mod h1:Osuydd3Se74nqjAKxid74N5eC+jfEqfTegHRnq58oK0=
go.opentelemetry.io/otel/sdk/metric v1.44.0 h1:3LlKgI+VjbVsjNRFZJZAJ30WjXC5VkNRks6si09iEfI=
go.opentelemetry.io/otel/sdk/metric v1.44.0/go.mod h1:5B5pMARnXxKhltooO4xUuCBorl65a4EpnTalObqOigA=
go.opentelemetry.io/otel/trace v1.44.0 h1:jxF5CsGYCe74MCRx2X4g7WsY/VBKRqqpNvXlX/6gtIk=
go.opentelemetry.io/otel/trace v1.44.0/go.mod h1:oLl1jrMQAVo6v3GAggN+1VH9VIz9iUSvW53sW1Q8PIE=
golang.org/x/net v0.58.0 h1:ynWG7rqYi4ccpTEuPZ2QGWHktVEM9DMCj9yzDE0Q7To=
golang.org/x/net v0.58.0/go.mod h1:YwCddHnFlT7eLQqVprV19OnhLGtc5xOKgE0RyqgfWAU=
golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.41.0 h1:vz/seA0lnX87Othu2f/0L24RcgrXD9/YFTSuGjj3rH8=
golang.org/x/text v0.41.0/go.mod h1:jvf1O8ajNzZqhSrQBPbutR/EB83Cc0CFrezNQIwbb5M=
gonum.org/v1/gonum v0.17.0 h1:VbpOemQlsSMrYmn7T2OUvQ4dqxQXU+ouZFQsZOx50z4=
gonum.org/v1/gonum v0.17.0/go.mod h1:El3tOrEuMpv2UdMrbNlKEh9vd86bmQ6vqIcDwxEOc1E=
google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7 h1:jQ9p21COKWjP3VwuFrNRiiOTMh3mPpN45R7SLrH/HUU=
google.golang.org/genproto/googleapis/api v0.0.0-20260630182238-925bb5da69e7/go.mod h1:KqHwBx2upmfa1XSi1WuRvC+2VGCLtooKkfmyvRbUmqA=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7 h1:eM/YSd5bBFagF51o1E745Ta7RwzpW0h+z+QDNZOgmQ8=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260630182238-925bb5da69e7/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/grpc v1.83.2 h1:EManeRomTObA0BU7I8vXgg/78uE5MJ9M8B39EX2WscU=
google.golang.org/grpc v1.83.2/go.mod h1:YPI1hK3kDked6iHvgX3tR0y+nX/qpMFKhPgFsokw1S8=
google.golang.org/protobuf v1.36.12 h1:pJOKDDOyeXErUroCihFAd5LQuwXBSpVnKGrj5o/fwxc=
google.golang.org/protobuf v1.36.12/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=

{
  "schemaVersion": 1,
  "goal": "verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion in pkg:golang/cloud.google.com/go/kms@v1.35.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/cloud.google.com/go/kms@v1.35.0"
  ],
  "symbols": [
    "cloud.google.com/go/kms/apiv1/kmspb.CryptoKeyVersion"
  ],
  "runtimeConditions": {
    "ecosystem": "golang",
    "language": "go",
    "packageManager": "go@1.26.6",
    "runtime": "go@1.26.6"
  }
}

package main

import (
	"fmt"
	"os"

	"cloud.google.com/go/kms/apiv1/kmspb"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/timestamppb"
)

func main() {
	if err := runContractTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All CryptoKeyVersion contract tests passed.")
}

func runContractTests() error {
	// 1. kmspb.CryptoKeyVersion initializes with default empty/unspecified fields and valid proto descriptor
	{
		empty := &kmspb.CryptoKeyVersion{}
		if empty.GetName() != "" {
			return fmt.Errorf("expected empty Name, got %q", empty.GetName())
		}
		if empty.GetState() != kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_STATE_UNSPECIFIED {
			return fmt.Errorf("expected CRYPTO_KEY_VERSION_STATE_UNSPECIFIED, got %v", empty.GetState())
		}
		if empty.GetProtectionLevel() != kmspb.ProtectionLevel_PROTECTION_LEVEL_UNSPECIFIED {
			return fmt.Errorf("expected PROTECTION_LEVEL_UNSPECIFIED, got %v", empty.GetProtectionLevel())
		}
		if empty.GetAlgorithm() != kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED {
			return fmt.Errorf("expected CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED, got %v", empty.GetAlgorithm())
		}
		ref := empty.ProtoReflect()
		if ref == nil || !ref.IsValid() {
			return fmt.Errorf("expected valid ProtoReflect message")
		}
		if string(ref.Descriptor().FullName()) != "google.cloud.kms.v1.CryptoKeyVersion" {
			return fmt.Errorf("expected full name google.cloud.kms.v1.CryptoKeyVersion, got %q", ref.Descriptor().FullName())
		}
	}

	// 2. kmspb.CryptoKeyVersion getters return populated field values
	resourceName := "projects/test-proj/locations/us-central1/keyRings/ring1/cryptoKeys/key1/cryptoKeyVersions/1"
	createTime := timestamppb.Now()
	version := &kmspb.CryptoKeyVersion{
		Name:            resourceName,
		State:           kmspb.CryptoKeyVersion_ENABLED,
		ProtectionLevel: kmspb.ProtectionLevel_HSM,
		Algorithm:       kmspb.CryptoKeyVersion_GOOGLE_SYMMETRIC_ENCRYPTION,
		CreateTime:      createTime,
		ReimportEligible: true,
	}
	{
		if version.GetName() != resourceName {
			return fmt.Errorf("expected Name %q, got %q", resourceName, version.GetName())
		}
		if version.GetState() != kmspb.CryptoKeyVersion_ENABLED {
			return fmt.Errorf("expected State ENABLED, got %v", version.GetState())
		}
		if version.GetProtectionLevel() != kmspb.ProtectionLevel_HSM {
			return fmt.Errorf("expected ProtectionLevel HSM, got %v", version.GetProtectionLevel())
		}
		if version.GetAlgorithm() != kmspb.CryptoKeyVersion_GOOGLE_SYMMETRIC_ENCRYPTION {
			return fmt.Errorf("expected Algorithm GOOGLE_SYMMETRIC_ENCRYPTION, got %v", version.GetAlgorithm())
		}
		if version.GetCreateTime().GetSeconds() != createTime.GetSeconds() {
			return fmt.Errorf("expected CreateTime seconds %d, got %d", createTime.GetSeconds(), version.GetCreateTime().GetSeconds())
		}
		if !version.GetReimportEligible() {
			return fmt.Errorf("expected ReimportEligible true")
		}
	}

	// 3. kmspb.CryptoKeyVersion getters for nil receiver return zero values safely without panicking
	{
		var nilVersion *kmspb.CryptoKeyVersion
		if nilVersion.GetName() != "" {
			return fmt.Errorf("nil GetName expected empty, got %q", nilVersion.GetName())
		}
		if nilVersion.GetState() != kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_STATE_UNSPECIFIED {
			return fmt.Errorf("nil GetState expected UNSPECIFIED, got %v", nilVersion.GetState())
		}
		if nilVersion.GetProtectionLevel() != kmspb.ProtectionLevel_PROTECTION_LEVEL_UNSPECIFIED {
			return fmt.Errorf("nil GetProtectionLevel expected UNSPECIFIED, got %v", nilVersion.GetProtectionLevel())
		}
		if nilVersion.GetAlgorithm() != kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED {
			return fmt.Errorf("nil GetAlgorithm expected UNSPECIFIED, got %v", nilVersion.GetAlgorithm())
		}
		if nilVersion.GetCreateTime() != nil {
			return fmt.Errorf("nil GetCreateTime expected nil, got %v", nilVersion.GetCreateTime())
		}
		if nilVersion.GetReimportEligible() != false {
			return fmt.Errorf("nil GetReimportEligible expected false, got %v", nilVersion.GetReimportEligible())
		}
	}

	// 4. kmspb.CryptoKeyVersion marshals and unmarshals via google.golang.org/protobuf/proto preserving fields
	{
		data, err := proto.Marshal(version)
		if err != nil {
			return fmt.Errorf("proto.Marshal failed: %w", err)
		}
		var decoded kmspb.CryptoKeyVersion
		if err := proto.Unmarshal(data, &decoded); err != nil {
			return fmt.Errorf("proto.Unmarshal failed: %w", err)
		}
		if !proto.Equal(version, &decoded) {
			return fmt.Errorf("decoded message does not equal original message")
		}
	}

	// 5. kmspb.CryptoKeyVersion supports proto.Clone producing an isolated deep copy
	{
		clonedRaw := proto.Clone(version)
		cloned, ok := clonedRaw.(*kmspb.CryptoKeyVersion)
		if !ok {
			return fmt.Errorf("proto.Clone did not return *kmspb.CryptoKeyVersion")
		}
		if !proto.Equal(version, cloned) {
			return fmt.Errorf("cloned message does not equal original")
		}
		cloned.State = kmspb.CryptoKeyVersion_DESTROYED
		if version.GetState() == kmspb.CryptoKeyVersion_DESTROYED {
			return fmt.Errorf("mutating clone modified original version state")
		}
	}

	// 6. kmspb.CryptoKeyVersion.Reset clears all fields to their zero values
	{
		v := &kmspb.CryptoKeyVersion{
			Name:  resourceName,
			State: kmspb.CryptoKeyVersion_ENABLED,
		}
		v.Reset()
		if v.GetName() != "" || v.GetState() != kmspb.CryptoKeyVersion_CRYPTO_KEY_VERSION_STATE_UNSPECIFIED {
			return fmt.Errorf("Reset did not clear fields: name=%q, state=%v", v.GetName(), v.GetState())
		}
	}

	return nil
}