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

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.ProtectionLevel_SOFTWARE 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.ProtectionLevel_SOFTWARE

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:425349498cecc631a49ae4137a0e0a8c62c83227c8fccf6d7901bd9ab8a4f68b","contract":["kmspb.ProtectionLevel_SOFTWARE equals 1","kmspb.ProtectionLevel_SOFTWARE is a kmspb.ProtectionLevel enum value","kmspb.ProtectionLevel_SOFTWARE String() returns \"SOFTWARE\"","kmspb.ProtectionLevel_name maps 1 to \"SOFTWARE\"","kmspb.ProtectionLevel_value maps \"SOFTWARE\" to 1","IsSoftwareProtectionLevel returns true for ProtectionLevel_SOFTWARE and false for ProtectionLevel_HSM","GetSoftwareProtectionLevel returns ProtectionLevel_SOFTWARE","NewSoftwareCryptoKeyVersionTemplate creates template with ProtectionLevel_SOFTWARE","Protobuf serialization and deserialization preserves ProtectionLevel_SOFTWARE"],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.ProtectionLevel_SOFTWARE 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.ProtectionLevel_SOFTWARE"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","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.ProtectionLevel_SOFTWARE"],"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=

package sample

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

// IsSoftwareProtectionLevel returns true if the given ProtectionLevel is ProtectionLevel_SOFTWARE.
func IsSoftwareProtectionLevel(level kmspb.ProtectionLevel) bool {
	return level == kmspb.ProtectionLevel_SOFTWARE
}

// GetSoftwareProtectionLevel returns the ProtectionLevel_SOFTWARE enum value.
func GetSoftwareProtectionLevel() kmspb.ProtectionLevel {
	return kmspb.ProtectionLevel_SOFTWARE
}

// GetProtectionLevelName returns the string representation of ProtectionLevel_SOFTWARE.
func GetProtectionLevelName() string {
	return kmspb.ProtectionLevel_SOFTWARE.String()
}

// GetProtectionLevelNumber returns the integer value of ProtectionLevel_SOFTWARE.
func GetProtectionLevelNumber() int32 {
	return int32(kmspb.ProtectionLevel_SOFTWARE)
}

// NewSoftwareCryptoKeyVersionTemplate returns a CryptoKeyVersionTemplate configured with SOFTWARE protection.
func NewSoftwareCryptoKeyVersionTemplate() *kmspb.CryptoKeyVersionTemplate {
	return &kmspb.CryptoKeyVersionTemplate{
		ProtectionLevel: kmspb.ProtectionLevel_SOFTWARE,
		Algorithm:       kmspb.CryptoKeyVersion_GOOGLE_SYMMETRIC_ENCRYPTION,
	}
}

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

package main

import (
	"fmt"
	"os"

	"cloud.google.com/go/kms/apiv1/kmspb"
	"google.golang.org/protobuf/proto"
	"sample"
)

func main() {
	if err := runTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All cloud.google.com/go/kms/apiv1/kmspb.ProtectionLevel_SOFTWARE contract assertions passed.")
}

func runTests() error {
	// Assertion 1: kmspb.ProtectionLevel_SOFTWARE equals 1
	if int32(kmspb.ProtectionLevel_SOFTWARE) != 1 {
		return fmt.Errorf("expected ProtectionLevel_SOFTWARE to equal 1, got %d", int32(kmspb.ProtectionLevel_SOFTWARE))
	}

	// Assertion 2: kmspb.ProtectionLevel_SOFTWARE is a kmspb.ProtectionLevel enum value
	var level kmspb.ProtectionLevel = kmspb.ProtectionLevel_SOFTWARE
	if level != kmspb.ProtectionLevel_SOFTWARE {
		return fmt.Errorf("type mismatch for kmspb.ProtectionLevel")
	}

	// Assertion 3: kmspb.ProtectionLevel_SOFTWARE String() returns "SOFTWARE"
	if kmspb.ProtectionLevel_SOFTWARE.String() != "SOFTWARE" {
		return fmt.Errorf("expected ProtectionLevel_SOFTWARE.String() to return 'SOFTWARE', got %q", kmspb.ProtectionLevel_SOFTWARE.String())
	}

	// Assertion 4: kmspb.ProtectionLevel_name maps 1 to "SOFTWARE"
	if name, ok := kmspb.ProtectionLevel_name[int32(kmspb.ProtectionLevel_SOFTWARE)]; !ok || name != "SOFTWARE" {
		return fmt.Errorf("expected ProtectionLevel_name[1] to be 'SOFTWARE', got %q (ok=%v)", name, ok)
	}

	// Assertion 5: kmspb.ProtectionLevel_value maps "SOFTWARE" to 1
	if val, ok := kmspb.ProtectionLevel_value["SOFTWARE"]; !ok || val != int32(kmspb.ProtectionLevel_SOFTWARE) {
		return fmt.Errorf("expected ProtectionLevel_value['SOFTWARE'] to be 1, got %d (ok=%v)", val, ok)
	}

	// Assertion 6: IsSoftwareProtectionLevel returns true for ProtectionLevel_SOFTWARE and false for ProtectionLevel_HSM
	if !sample.IsSoftwareProtectionLevel(kmspb.ProtectionLevel_SOFTWARE) {
		return fmt.Errorf("expected IsSoftwareProtectionLevel(ProtectionLevel_SOFTWARE) to be true")
	}
	if sample.IsSoftwareProtectionLevel(kmspb.ProtectionLevel_HSM) {
		return fmt.Errorf("expected IsSoftwareProtectionLevel(ProtectionLevel_HSM) to be false")
	}

	// Assertion 7: GetSoftwareProtectionLevel returns ProtectionLevel_SOFTWARE
	if sample.GetSoftwareProtectionLevel() != kmspb.ProtectionLevel_SOFTWARE {
		return fmt.Errorf("expected GetSoftwareProtectionLevel() to return ProtectionLevel_SOFTWARE")
	}

	// Assertion 8: NewSoftwareCryptoKeyVersionTemplate creates template with ProtectionLevel_SOFTWARE
	template := sample.NewSoftwareCryptoKeyVersionTemplate()
	if template.GetProtectionLevel() != kmspb.ProtectionLevel_SOFTWARE {
		return fmt.Errorf("expected template.GetProtectionLevel() to return ProtectionLevel_SOFTWARE, got %v", template.GetProtectionLevel())
	}

	// Assertion 9: Protobuf serialization and deserialization preserves ProtectionLevel_SOFTWARE
	data, err := proto.Marshal(template)
	if err != nil {
		return fmt.Errorf("proto.Marshal failed: %w", err)
	}
	unmarshaled := &kmspb.CryptoKeyVersionTemplate{}
	if err := proto.Unmarshal(data, unmarshaled); err != nil {
		return fmt.Errorf("proto.Unmarshal failed: %w", err)
	}
	if unmarshaled.GetProtectionLevel() != kmspb.ProtectionLevel_SOFTWARE {
		return fmt.Errorf("expected unmarshaled.GetProtectionLevel() to be ProtectionLevel_SOFTWARE, got %v", unmarshaled.GetProtectionLevel())
	}

	return nil
}