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

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_value 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_value

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:45e078c9d866663ba12233114405fe18ef85a26bacf74191f5301cff18d03c5d","contract":["CryptoKey_CryptoKeyPurpose_value maps standard purpose names to their expected int32 enum constants","CryptoKey_CryptoKeyPurpose_value maps specialized purpose names including RAW_ENCRYPT_DECRYPT, KEY_ENCAPSULATION, and AES_WRAPPING","CryptoKey_CryptoKeyPurpose_value maps CRYPTO_KEY_PURPOSE_UNSPECIFIED to zero","CryptoKey_CryptoKeyPurpose_value returns false when looking up non-existent purpose names","CryptoKey_CryptoKeyPurpose_value entries match the inverse mapping in CryptoKey_CryptoKeyPurpose_name","CryptoKey_CryptoKeyPurpose_value resolved enum values can be assigned to a CryptoKey protobuf message"],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose_value 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_value"]},"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.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_value"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require cloud.google.com/go/kms v1.34.0

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
	google.golang.org/protobuf v1.36.11 // 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/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.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=

package main

import (
	"fmt"

	"cloud.google.com/go/kms/apiv1/kmspb"
)

func main() {
	// Look up the integer enum value from the string name of the purpose
	purposeName := "ENCRYPT_DECRYPT"
	val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value[purposeName]
	if !ok {
		panic(fmt.Sprintf("unknown purpose name: %s", purposeName))
	}
	fmt.Printf("Purpose %s resolved to enum value: %d\n", purposeName, val)

	// Use the resolved value to configure a CryptoKey protobuf message
	key := &kmspb.CryptoKey{
		Purpose: kmspb.CryptoKey_CryptoKeyPurpose(val),
	}
	fmt.Printf("Created CryptoKey with purpose: %s\n", key.GetPurpose().String())
}

{
  "schemaVersion": 1,
  "goal": "verify cloud.google.com/go/kms/apiv1/kmspb.CryptoKey_CryptoKeyPurpose_value 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_value"
  ],
  "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"
)

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

func runContractTests() error {
	// 1. CryptoKey_CryptoKeyPurpose_value maps standard purpose names to their expected int32 enum constants
	{
		standardCases := map[string]kmspb.CryptoKey_CryptoKeyPurpose{
			"ENCRYPT_DECRYPT":    kmspb.CryptoKey_ENCRYPT_DECRYPT,
			"ASYMMETRIC_SIGN":    kmspb.CryptoKey_ASYMMETRIC_SIGN,
			"ASYMMETRIC_DECRYPT": kmspb.CryptoKey_ASYMMETRIC_DECRYPT,
			"MAC":                kmspb.CryptoKey_MAC,
		}
		for name, expectedEnum := range standardCases {
			val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value[name]
			if !ok {
				return fmt.Errorf("expected purpose %q to exist in CryptoKey_CryptoKeyPurpose_value", name)
			}
			if val != int32(expectedEnum) {
				return fmt.Errorf("purpose %q value mismatch: got %d, want %d", name, val, int32(expectedEnum))
			}
		}
	}

	// 2. CryptoKey_CryptoKeyPurpose_value maps specialized purpose names including RAW_ENCRYPT_DECRYPT, KEY_ENCAPSULATION, and AES_WRAPPING
	{
		specializedCases := map[string]kmspb.CryptoKey_CryptoKeyPurpose{
			"RAW_ENCRYPT_DECRYPT": kmspb.CryptoKey_RAW_ENCRYPT_DECRYPT,
			"KEY_ENCAPSULATION":   kmspb.CryptoKey_KEY_ENCAPSULATION,
			"AES_WRAPPING":        kmspb.CryptoKey_AES_WRAPPING,
		}
		for name, expectedEnum := range specializedCases {
			val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value[name]
			if !ok {
				return fmt.Errorf("expected specialized purpose %q to exist in CryptoKey_CryptoKeyPurpose_value", name)
			}
			if val != int32(expectedEnum) {
				return fmt.Errorf("specialized purpose %q value mismatch: got %d, want %d", name, val, int32(expectedEnum))
			}
		}
	}

	// 3. CryptoKey_CryptoKeyPurpose_value maps CRYPTO_KEY_PURPOSE_UNSPECIFIED to zero
	{
		val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value["CRYPTO_KEY_PURPOSE_UNSPECIFIED"]
		if !ok {
			return fmt.Errorf("expected CRYPTO_KEY_PURPOSE_UNSPECIFIED to exist in CryptoKey_CryptoKeyPurpose_value")
		}
		if val != 0 || val != int32(kmspb.CryptoKey_CRYPTO_KEY_PURPOSE_UNSPECIFIED) {
			return fmt.Errorf("CRYPTO_KEY_PURPOSE_UNSPECIFIED value mismatch: got %d, want 0", val)
		}
	}

	// 4. CryptoKey_CryptoKeyPurpose_value returns false when looking up non-existent purpose names
	{
		val, ok := kmspb.CryptoKey_CryptoKeyPurpose_value["NON_EXISTENT_PURPOSE"]
		if ok {
			return fmt.Errorf("expected ok=false for non-existent purpose name, got ok=true with val=%d", val)
		}
		if val != 0 {
			return fmt.Errorf("expected zero value for non-existent key, got %d", val)
		}
	}

	// 5. CryptoKey_CryptoKeyPurpose_value entries match the inverse mapping in CryptoKey_CryptoKeyPurpose_name
	{
		if len(kmspb.CryptoKey_CryptoKeyPurpose_value) == 0 {
			return fmt.Errorf("CryptoKey_CryptoKeyPurpose_value map is unexpectedly empty")
		}
		for name, val := range kmspb.CryptoKey_CryptoKeyPurpose_value {
			resolvedName, ok := kmspb.CryptoKey_CryptoKeyPurpose_name[val]
			if !ok {
				return fmt.Errorf("value %d for purpose %q not found in CryptoKey_CryptoKeyPurpose_name", val, name)
			}
			if resolvedName != name {
				return fmt.Errorf("mismatch between value and name map: value map has %q -> %d, but name map has %d -> %q", name, val, val, resolvedName)
			}
		}
	}

	// 6. CryptoKey_CryptoKeyPurpose_value resolved enum values can be assigned to a CryptoKey protobuf message
	{
		purposeVal, ok := kmspb.CryptoKey_CryptoKeyPurpose_value["ENCRYPT_DECRYPT"]
		if !ok {
			return fmt.Errorf("ENCRYPT_DECRYPT not found in value map")
		}
		key := &kmspb.CryptoKey{
			Purpose: kmspb.CryptoKey_CryptoKeyPurpose(purposeVal),
		}
		if key.GetPurpose() != kmspb.CryptoKey_ENCRYPT_DECRYPT {
			return fmt.Errorf("CryptoKey purpose mismatch: got %v, want %v", key.GetPurpose(), kmspb.CryptoKey_ENCRYPT_DECRYPT)
		}
	}

	return nil
}