cloud.google.com/go/kms v1.34.0: kmspb.CryptoKey_CryptoKeyPurpose

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.CryptoKey_CryptoKeyPurpose in pkg:golang/cloud.google.com/go/kms@v1.34.0
Kind: HOW

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

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.

{"buildCommand":["sh","-c","GOMEMLIMIT=256MiB go build -p 1 -o testbin ./test"],"case":{"caseId":"case:sha256:11c6df9458e30d6eda26c9542e7485ead9b55a3bf77c3e0d927e6462ac6c0fea","contract":["kmspb.CryptoKey_CryptoKeyPurpose enum constants map correctly to their defined integer values (UNSPECIFIED=0, ENCRYPT_DECRYPT=1, ASYMMETRIC_SIGN=5, ASYMMETRIC_DECRYPT=6, RAW_ENCRYPT_DECRYPT=7, MAC=9, KEY_ENCAPSULATION=10, AES_WRAPPING=11)","kmspb.CryptoKey_CryptoKeyPurpose.String() returns valid identifier strings matching enum constant names","kmspb.CryptoKey_CryptoKeyPurpose is registered in CryptoKey_CryptoKeyPurpose_name and CryptoKey_CryptoKeyPurpose_value lookup maps","kmspb.CryptoKey message with Purpose set returns assigned CryptoKey_CryptoKeyPurpose via GetPurpose(), and returns CRYPTO_KEY_PURPOSE_UNSPECIFIED when nil","kmspb.CryptoKey_CryptoKeyPurpose implements protoreflect enum interfaces returning correct Number(), non-nil Enum() pointer, and valid Descriptor()"],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose in pkg:golang/cloud.google.com/go/kms@v1.34.0","kind":"HOW","packages":["pkg:golang/cloud.google.com/go/kms@v1.34.0"],"schemaVersion":1,"symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose"]},"contractCommand":["./testbin"],"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.34.0"],"schemaVersion":1,"subject":"pkg:golang/cloud.google.com/go/kms@v1.34.0","symbols":["cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require (
	cloud.google.com/go/kms v1.34.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.34.0 h1:mxWcXEiyjxwFH5gclulLx+B8Y2OEpKJRZ5FOF78c2XE=
cloud.google.com/go/kms v1.34.0/go.mod h1:FbxZWUiihmyjxlaBha84OK5+fmJHPrS6F5/mBFdJk6A=
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.CryptoKey_CryptoKeyPurpose in pkg:golang/cloud.google.com/go/kms@v1.34.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/cloud.google.com/go/kms@v1.34.0"
  ],
  "symbols": [
    "cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose"
  ]
}

package main

import (
	"fmt"
	"os"

	"cloud.google.com/go/kms/apiv1/kmspb"
	"google.golang.org/protobuf/reflect/protoreflect"
)

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

func runTests() error {
	// 1. Verify defined enum constants have expected integer values
	expectedValues := map[kmspb.CryptoKey_CryptoKeyPurpose]int32{
		kmspb.CryptoKey_CRYPTO_KEY_PURPOSE_UNSPECIFIED: 0,
		kmspb.CryptoKey_ENCRYPT_DECRYPT:                1,
		kmspb.CryptoKey_ASYMMETRIC_SIGN:                5,
		kmspb.CryptoKey_ASYMMETRIC_DECRYPT:             6,
		kmspb.CryptoKey_RAW_ENCRYPT_DECRYPT:            7,
		kmspb.CryptoKey_MAC:                            9,
		kmspb.CryptoKey_KEY_ENCAPSULATION:              10,
		kmspb.CryptoKey_AES_WRAPPING:                   11,
	}

	for purpose, expectedVal := range expectedValues {
		if int32(purpose) != expectedVal {
			return fmt.Errorf("expected enum value for %v to be %d, got %d", purpose, expectedVal, int32(purpose))
		}
	}

	// 2. Verify String() representations match expected names
	expectedStrings := map[kmspb.CryptoKey_CryptoKeyPurpose]string{
		kmspb.CryptoKey_CRYPTO_KEY_PURPOSE_UNSPECIFIED: "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
		kmspb.CryptoKey_ENCRYPT_DECRYPT:                "ENCRYPT_DECRYPT",
		kmspb.CryptoKey_ASYMMETRIC_SIGN:                "ASYMMETRIC_SIGN",
		kmspb.CryptoKey_ASYMMETRIC_DECRYPT:             "ASYMMETRIC_DECRYPT",
		kmspb.CryptoKey_RAW_ENCRYPT_DECRYPT:            "RAW_ENCRYPT_DECRYPT",
		kmspb.CryptoKey_MAC:                            "MAC",
		kmspb.CryptoKey_KEY_ENCAPSULATION:              "KEY_ENCAPSULATION",
		kmspb.CryptoKey_AES_WRAPPING:                   "AES_WRAPPING",
	}

	for purpose, expectedStr := range expectedStrings {
		if str := purpose.String(); str != expectedStr {
			return fmt.Errorf("expected String() to return %q, got %q", expectedStr, str)
		}
	}

	// 3. Verify CryptoKey_CryptoKeyPurpose_name and CryptoKey_CryptoKeyPurpose_value maps
	for purpose, expectedStr := range expectedStrings {
		val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value[expectedStr]
		if !ok || val != int32(purpose) {
			return fmt.Errorf("expected CryptoKey_CryptoKeyPurpose_value[%q] == %d, got %d (ok=%v)", expectedStr, int32(purpose), val, ok)
		}
		name, ok := kmspb.CryptoKey_CryptoKeyPurpose_name[int32(purpose)]
		if !ok || name != expectedStr {
			return fmt.Errorf("expected CryptoKey_CryptoKeyPurpose_name[%d] == %q, got %q (ok=%v)", int32(purpose), expectedStr, name, ok)
		}
	}

	// 4. Verify CryptoKey message struct integration
	{
		key := &kmspb.CryptoKey{
			Name:    "projects/example-project/locations/global/keyRings/example-ring/cryptoKeys/example-key",
			Purpose: kmspb.CryptoKey_ENCRYPT_DECRYPT,
		}
		if key.GetPurpose() != kmspb.CryptoKey_ENCRYPT_DECRYPT {
			return fmt.Errorf("expected key.GetPurpose() to return ENCRYPT_DECRYPT, got %v", key.GetPurpose())
		}

		var nilKey *kmspb.CryptoKey
		if nilKey.GetPurpose() != kmspb.CryptoKey_CRYPTO_KEY_PURPOSE_UNSPECIFIED {
			return fmt.Errorf("expected nilKey.GetPurpose() to return CRYPTO_KEY_PURPOSE_UNSPECIFIED, got %v", nilKey.GetPurpose())
		}
	}

	// 5. Verify protoreflect Enum methods (Number, Enum, Descriptor, Type)
	{
		purpose := kmspb.CryptoKey_ENCRYPT_DECRYPT
		if purpose.Number() != protoreflect.EnumNumber(1) {
			return fmt.Errorf("expected Number() to return 1, got %v", purpose.Number())
		}

		ptr := purpose.Enum()
		if ptr == nil || *ptr != kmspb.CryptoKey_ENCRYPT_DECRYPT {
			return fmt.Errorf("expected Enum() to return pointer to ENCRYPT_DECRYPT, got %v", ptr)
		}

		desc := purpose.Descriptor()
		if desc == nil || desc.FullName() != "google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose" {
			return fmt.Errorf("expected Descriptor().FullName() to be 'google.cloud.kms.v1.CryptoKey.CryptoKeyPurpose', got %v", desc)
		}

		enumType := purpose.Type()
		if enumType == nil || enumType.Descriptor() != desc {
			return fmt.Errorf("expected Type().Descriptor() to match Descriptor(), got %v", enumType)
		}
	}

	return nil
}