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

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

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:878f22e13b02f15b84b4b098f5de2f3f37abee6f0d11657831fdec6e7a1fca43","contract":["kmspb.ProtectionLevel_HSM has integer value 2","kmspb.ProtectionLevel_HSM string representation is HSM","kmspb.ProtectionLevel_value maps HSM to kmspb.ProtectionLevel_HSM enum value","kmspb.ProtectionLevel_name maps ProtectionLevel_HSM to string HSM","kmspb.CryptoKeyVersionTemplate can be configured with ProtectionLevel_HSM"],"goal":"verify cloud.google.com/go/kms/apiv1/kmspb.ProtectionLevel_HSM 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_HSM"]},"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_HSM"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

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

package main

import (
	"fmt"

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

// IsHSMProtection checks if the given ProtectionLevel is HSM.
func IsHSMProtection(level kmspb.ProtectionLevel) bool {
	return level == kmspb.ProtectionLevel_HSM
}

// CreateHSMKeyTemplate constructs a CryptoKeyVersionTemplate configured with HSM protection.
func CreateHSMKeyTemplate(algorithm kmspb.CryptoKeyVersion_CryptoKeyVersionAlgorithm) *kmspb.CryptoKeyVersionTemplate {
	return &kmspb.CryptoKeyVersionTemplate{
		ProtectionLevel: kmspb.ProtectionLevel_HSM,
		Algorithm:       algorithm,
	}
}

func main() {
	hsmLevel := kmspb.ProtectionLevel_HSM
	fmt.Printf("KMS ProtectionLevel: %s (%d)\n", hsmLevel.String(), int32(hsmLevel))
	tmpl := CreateHSMKeyTemplate(kmspb.CryptoKeyVersion_GOOGLE_SYMMETRIC_ENCRYPTION)
	fmt.Printf("Template ProtectionLevel: %s\n", tmpl.GetProtectionLevel().String())
}

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

package main

import (
	"fmt"
	"os"

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

func main() {
	// Assertion 1: kmspb.ProtectionLevel_HSM has integer value 2
	{
		val := int32(kmspb.ProtectionLevel_HSM)
		if val != 2 {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected ProtectionLevel_HSM value 2, got %d\n", val)
			os.Exit(1)
		}
	}

	// Assertion 2: kmspb.ProtectionLevel_HSM string representation is HSM
	{
		str := kmspb.ProtectionLevel_HSM.String()
		if str != "HSM" {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected String() to be %q, got %q\n", "HSM", str)
			os.Exit(1)
		}
	}

	// Assertion 3: kmspb.ProtectionLevel_value maps HSM to kmspb.ProtectionLevel_HSM enum value
	{
		if kmspb.ProtectionLevel_value == nil {
			fmt.Fprintln(os.Stderr, "Assertion 3 failed: ProtectionLevel_value map is nil")
			os.Exit(1)
		}
		val, ok := kmspb.ProtectionLevel_value["HSM"]
		if !ok {
			fmt.Fprintln(os.Stderr, "Assertion 3 failed: key 'HSM' not found in ProtectionLevel_value")
			os.Exit(1)
		}
		if val != int32(kmspb.ProtectionLevel_HSM) {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected HSM value %d, got %d\n", int32(kmspb.ProtectionLevel_HSM), val)
			os.Exit(1)
		}
	}

	// Assertion 4: kmspb.ProtectionLevel_name maps ProtectionLevel_HSM to string HSM
	{
		if kmspb.ProtectionLevel_name == nil {
			fmt.Fprintln(os.Stderr, "Assertion 4 failed: ProtectionLevel_name map is nil")
			os.Exit(1)
		}
		name, ok := kmspb.ProtectionLevel_name[int32(kmspb.ProtectionLevel_HSM)]
		if !ok {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: key %d not found in ProtectionLevel_name\n", int32(kmspb.ProtectionLevel_HSM))
			os.Exit(1)
		}
		if name != "HSM" {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: expected name %q, got %q\n", "HSM", name)
			os.Exit(1)
		}
	}

	// Assertion 5: kmspb.CryptoKeyVersionTemplate can be configured with ProtectionLevel_HSM
	{
		tmpl := &kmspb.CryptoKeyVersionTemplate{
			ProtectionLevel: kmspb.ProtectionLevel_HSM,
			Algorithm:       kmspb.CryptoKeyVersion_RSA_SIGN_PSS_2048_SHA256,
		}
		if tmpl.GetProtectionLevel() != kmspb.ProtectionLevel_HSM {
			fmt.Fprintf(os.Stderr, "Assertion 5 failed: expected GetProtectionLevel() to be %v, got %v\n", kmspb.ProtectionLevel_HSM, tmpl.GetProtectionLevel())
			os.Exit(1)
		}
	}

	fmt.Println("PASS: all ProtectionLevel_HSM contract assertions passed")
}