Skip to content

K
k3s
Unverified Commit 01f205ad authored by Kubernetes Submit Queue's avatar Kubernetes Submit Queue Committed by GitHub
Browse files
Options

Merge pull request #54759 from sakshamsharma/remove-google-kms-in-tree

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Remove Google Cloud KMS's in-tree integration Removes the following introduced by #48574 and others: * `kms.go` which contained the cloudkms-specific code for Google Cloud KMS service. * Registering the Google Cloud KMS in the KMS plugin registry. * Google's `cloudkms` API package from `vendor` folder. The following changes are upcoming: * Removal of KMSPluginRegistry. This would not be needed anymore, since KMS providers will be out-of-tree from now on (so no need of registering them, an address of the process would be enough). * A service which allows encrypt/decrypt functionality (satisfies `envelope.Service` interface) if initialized with an IP/Port of an out-of-tree process serving KMS requests. Will tentatively use gRPC requests to talk to this external service. Reference: https://github.com/kubernetes/kubernetes/pull/54439#issuecomment-340062801 and https://github.com/kubernetes/kubernetes/issues/51965#issuecomment-339333937. ```release-note Google KMS integration was removed from in-tree in favor of a out-of-process extension point that will be used for all KMS providers. ```
parents 9459f475 53f2535b
Hide whitespace changes
Inline Side-by-side
Showing with 0 additions and 1631 deletions
Godeps/Godeps.json
View file @ 01f205ad
...@@ -2845,10 +2845,6 @@ ...@@ -2845,10 +2845,6 @@
"Rev": "2382e3994d48b1d22acc2c86bcad0a2aff028e32" "Rev": "2382e3994d48b1d22acc2c86bcad0a2aff028e32"
}, },
{ {
"ImportPath": "google.golang.org/api/cloudkms/v1",
"Rev": "654f863362977d69086620b5f72f13e911da2410"
},
{
"ImportPath": "google.golang.org/api/cloudmonitoring/v2beta2", "ImportPath": "google.golang.org/api/cloudmonitoring/v2beta2",
"Rev": "654f863362977d69086620b5f72f13e911da2410" "Rev": "654f863362977d69086620b5f72f13e911da2410"
}, },
......
Godeps/LICENSES
View file @ 01f205ad
...@@ -84790,41 +84790,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ...@@ -84790,41 +84790,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
================================================================================ ================================================================================
= vendor/google.golang.org/api/cloudkms/v1 licensed under: =
Copyright (c) 2011 Google Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
= vendor/google.golang.org/api/LICENSE a651bb3d8b1c412632e28823bb432b40
================================================================================
================================================================================
= vendor/google.golang.org/api/cloudmonitoring/v2beta2 licensed under: = = vendor/google.golang.org/api/cloudmonitoring/v2beta2 licensed under: =
Copyright (c) 2011 Google Inc. All rights reserved. Copyright (c) 2011 Google Inc. All rights reserved.
cluster/gce/gci/configure-helper.sh
View file @ 01f205ad
...@@ -1520,10 +1520,6 @@ function start-kube-apiserver { ...@@ -1520,10 +1520,6 @@ function start-kube-apiserver {
if [[ -n "${ENCRYPTION_PROVIDER_CONFIG:-}" ]]; then if [[ -n "${ENCRYPTION_PROVIDER_CONFIG:-}" ]]; then
local encryption_provider_config_path="/etc/srv/kubernetes/encryption-provider-config.yml" local encryption_provider_config_path="/etc/srv/kubernetes/encryption-provider-config.yml"
if [[ -n "${GOOGLE_CLOUD_KMS_CONFIG_FILE_NAME:-}" && -n "${GOOGLE_CLOUD_KMS_CONFIG:-}" ]]; then
echo "${GOOGLE_CLOUD_KMS_CONFIG}" | base64 --decode > "${GOOGLE_CLOUD_KMS_CONFIG_FILE_NAME}"
fi
echo "${ENCRYPTION_PROVIDER_CONFIG}" | base64 --decode > "${encryption_provider_config_path}" echo "${ENCRYPTION_PROVIDER_CONFIG}" | base64 --decode > "${encryption_provider_config_path}"
params+=" --experimental-encryption-provider-config=${encryption_provider_config_path}" params+=" --experimental-encryption-provider-config=${encryption_provider_config_path}"
fi fi
......
cmd/kube-apiserver/app/server.go
View file @ 01f205ad
...@@ -265,13 +265,6 @@ func CreateKubeAPIServerConfig(s *options.ServerRunOptions, nodeTunneler tunnele ...@@ -265,13 +265,6 @@ func CreateKubeAPIServerConfig(s *options.ServerRunOptions, nodeTunneler tunnele
return nil, nil, nil, nil, nil, utilerrors.NewAggregate(errs) return nil, nil, nil, nil, nil, utilerrors.NewAggregate(errs)
} }
if s.CloudProvider != nil {
// Initialize the cloudprovider once, to give it a chance to register KMS plugins, if any.
_, err := cloudprovider.InitCloudProvider(s.CloudProvider.CloudProvider, s.CloudProvider.CloudConfigFile)
if err != nil {
return nil, nil, nil, nil, nil, err
}
}
genericConfig, sharedInformers, versionedInformers, insecureServingOptions, serviceResolver, err := BuildGenericConfig(s, proxyTransport) genericConfig, sharedInformers, versionedInformers, insecureServingOptions, serviceResolver, err := BuildGenericConfig(s, proxyTransport)
if err != nil { if err != nil {
return nil, nil, nil, nil, nil, err return nil, nil, nil, nil, nil, err
......
pkg/cloudprovider/providers/gce/BUILD
View file @ 01f205ad
...@@ -40,7 +40,6 @@ go_library( ...@@ -40,7 +40,6 @@ go_library(
"gce_urlmap.go", "gce_urlmap.go",
"gce_util.go", "gce_util.go",
"gce_zones.go", "gce_zones.go",
"kms.go",
"metrics.go", "metrics.go",
"token_source.go", "token_source.go",
], ],
...@@ -61,7 +60,6 @@ go_library( ...@@ -61,7 +60,6 @@ go_library(
"//vendor/github.com/prometheus/client_golang/prometheus:go_default_library", "//vendor/github.com/prometheus/client_golang/prometheus:go_default_library",
"//vendor/golang.org/x/oauth2:go_default_library", "//vendor/golang.org/x/oauth2:go_default_library",
"//vendor/golang.org/x/oauth2/google:go_default_library", "//vendor/golang.org/x/oauth2/google:go_default_library",
"//vendor/google.golang.org/api/cloudkms/v1:go_default_library",
"//vendor/google.golang.org/api/compute/v0.alpha:go_default_library", "//vendor/google.golang.org/api/compute/v0.alpha:go_default_library",
"//vendor/google.golang.org/api/compute/v0.beta:go_default_library", "//vendor/google.golang.org/api/compute/v0.beta:go_default_library",
"//vendor/google.golang.org/api/compute/v1:go_default_library", "//vendor/google.golang.org/api/compute/v1:go_default_library",
...@@ -77,8 +75,6 @@ go_library( ...@@ -77,8 +75,6 @@ go_library(
"//vendor/k8s.io/apimachinery/pkg/util/sets:go_default_library", "//vendor/k8s.io/apimachinery/pkg/util/sets:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library", "//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/watch:go_default_library", "//vendor/k8s.io/apimachinery/pkg/watch:go_default_library",
"//vendor/k8s.io/apiserver/pkg/server/options/encryptionconfig:go_default_library",
"//vendor/k8s.io/apiserver/pkg/storage/value/encrypt/envelope:go_default_library",
"//vendor/k8s.io/client-go/kubernetes:go_default_library", "//vendor/k8s.io/client-go/kubernetes:go_default_library",
"//vendor/k8s.io/client-go/kubernetes/scheme:go_default_library", "//vendor/k8s.io/client-go/kubernetes/scheme:go_default_library",
"//vendor/k8s.io/client-go/kubernetes/typed/core/v1:go_default_library", "//vendor/k8s.io/client-go/kubernetes/typed/core/v1:go_default_library",
......
pkg/cloudprovider/providers/gce/gce.go
View file @ 01f205ad
...@@ -34,8 +34,6 @@ import ( ...@@ -34,8 +34,6 @@ import (
"k8s.io/api/core/v1" "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/sets" "k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait" "k8s.io/apimachinery/pkg/util/wait"
"k8s.io/apiserver/pkg/server/options/encryptionconfig"
"k8s.io/apiserver/pkg/storage/value/encrypt/envelope"
clientset "k8s.io/client-go/kubernetes" clientset "k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/scheme" "k8s.io/client-go/kubernetes/scheme"
v1core "k8s.io/client-go/kubernetes/typed/core/v1" v1core "k8s.io/client-go/kubernetes/typed/core/v1"
...@@ -48,7 +46,6 @@ import ( ...@@ -48,7 +46,6 @@ import (
"github.com/golang/glog" "github.com/golang/glog"
"golang.org/x/oauth2" "golang.org/x/oauth2"
"golang.org/x/oauth2/google" "golang.org/x/oauth2/google"
cloudkms "google.golang.org/api/cloudkms/v1"
computealpha "google.golang.org/api/compute/v0.alpha" computealpha "google.golang.org/api/compute/v0.alpha"
computebeta "google.golang.org/api/compute/v0.beta" computebeta "google.golang.org/api/compute/v0.beta"
compute "google.golang.org/api/compute/v1" compute "google.golang.org/api/compute/v1"
...@@ -106,7 +103,6 @@ type GCECloud struct { ...@@ -106,7 +103,6 @@ type GCECloud struct {
serviceBeta *computebeta.Service serviceBeta *computebeta.Service
serviceAlpha *computealpha.Service serviceAlpha *computealpha.Service
containerService *container.Service containerService *container.Service
cloudkmsService *cloudkms.Service
client clientset.Interface client clientset.Interface
clientBuilder controller.ControllerClientBuilder clientBuilder controller.ControllerClientBuilder
eventBroadcaster record.EventBroadcaster eventBroadcaster record.EventBroadcaster
...@@ -195,10 +191,6 @@ type CloudConfig struct { ...@@ -195,10 +191,6 @@ type CloudConfig struct {
AlphaFeatureGate *AlphaFeatureGate AlphaFeatureGate *AlphaFeatureGate
} }
// kmsPluginRegisterOnce prevents the cloudprovider from registering its KMS plugin
// more than once in the KMS plugin registry.
var kmsPluginRegisterOnce sync.Once
func init() { func init() {
cloudprovider.RegisterCloudProvider( cloudprovider.RegisterCloudProvider(
ProviderName, ProviderName,
...@@ -212,11 +204,6 @@ func (g *GCECloud) GetComputeService() *compute.Service { ...@@ -212,11 +204,6 @@ func (g *GCECloud) GetComputeService() *compute.Service {
return g.service return g.service
} }
// Raw access to the cloudkmsService of GCE cloud. Required for encryption of etcd using Google KMS.
func (g *GCECloud) GetKMSService() *cloudkms.Service {
return g.cloudkmsService
}
// newGCECloud creates a new instance of GCECloud. // newGCECloud creates a new instance of GCECloud.
func newGCECloud(config io.Reader) (gceCloud *GCECloud, err error) { func newGCECloud(config io.Reader) (gceCloud *GCECloud, err error) {
var cloudConfig *CloudConfig var cloudConfig *CloudConfig
...@@ -404,12 +391,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) { ...@@ -404,12 +391,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) {
} }
containerService.UserAgent = userAgent containerService.UserAgent = userAgent
cloudkmsService, err := cloudkms.New(client)
if err != nil {
return nil, err
}
cloudkmsService.UserAgent = userAgent
// ProjectID and.NetworkProjectID may be project number or name. // ProjectID and.NetworkProjectID may be project number or name.
projID, netProjID := tryConvertToProjectNames(config.ProjectID, config.NetworkProjectID, service) projID, netProjID := tryConvertToProjectNames(config.ProjectID, config.NetworkProjectID, service)
onXPN := projID != netProjID onXPN := projID != netProjID
...@@ -474,7 +455,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) { ...@@ -474,7 +455,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) {
serviceAlpha: serviceAlpha, serviceAlpha: serviceAlpha,
serviceBeta: serviceBeta, serviceBeta: serviceBeta,
containerService: containerService, containerService: containerService,
cloudkmsService: cloudkmsService,
projectID: projID, projectID: projID,
networkProjectID: netProjID, networkProjectID: netProjID,
onXPN: onXPN, onXPN: onXPN,
...@@ -494,14 +474,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) { ...@@ -494,14 +474,6 @@ func CreateGCECloud(config *CloudConfig) (*GCECloud, error) {
gce.manager = &gceServiceManager{gce} gce.manager = &gceServiceManager{gce}
// Registering the KMS plugin only the first time.
kmsPluginRegisterOnce.Do(func() {
// Register the Google Cloud KMS based service in the KMS plugin registry.
encryptionconfig.KMSPluginRegistry.Register(KMSServiceName, func(config io.Reader) (envelope.Service, error) {
return gce.getGCPCloudKMSService(config)
})
})
return gce, nil return gce, nil
} }
......
pkg/cloudprovider/providers/gce/kms.go deleted 100644 → 0
View file @ 9459f475
/*
Copyright 2017 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package gce
import (
"encoding/base64"
"fmt"
"io"
"github.com/golang/glog"
cloudkms "google.golang.org/api/cloudkms/v1"
"google.golang.org/api/googleapi"
gcfg "gopkg.in/gcfg.v1"
"k8s.io/apiserver/pkg/storage/value/encrypt/envelope"
)
const (
// KMSServiceName is the name of the cloudkms provider registered by this cloud.
KMSServiceName = "gcp-cloudkms"
defaultGKMSKeyRing = "google-container-engine"
defaultGKMSKeyRingLocation = "global"
)
// gkmsConfig contains the GCE specific KMS configuration for setting up a KMS connection.
type gkmsConfig struct {
Global struct {
// location is the KMS location of the KeyRing to be used for encryption.
// It can be found by checking the available KeyRings in the IAM UI.
// This is not the same as the GCP location of the project.
// +optional
Location string `gcfg:"kms-location"`
// keyRing is the keyRing of the hosted key to be used. The default value is "google-kubernetes".
// +optional
KeyRing string `gcfg:"kms-keyring"`
// cryptoKey is the name of the key to be used for encryption of Data-Encryption-Keys.
CryptoKey string `gcfg:"kms-cryptokey"`
}
}
// readGCPCloudKMSConfig parses and returns the configuration parameters for Google Cloud KMS.
func readGCPCloudKMSConfig(reader io.Reader) (*gkmsConfig, error) {
cfg := &gkmsConfig{}
if err := gcfg.FatalOnly(gcfg.ReadInto(cfg, reader)); err != nil {
glog.Errorf("Couldn't read Google Cloud KMS config: %v", err)
return nil, err
}
return cfg, nil
}
// gkmsService provides Encrypt and Decrypt methods which allow cryptographic operations
// using Google Cloud KMS service.
type gkmsService struct {
parentName string
cloudkmsService *cloudkms.Service
}
// getGCPCloudKMSService provides a Google Cloud KMS based implementation of envelope.Service.
func (gce *GCECloud) getGCPCloudKMSService(config io.Reader) (envelope.Service, error) {
kmsConfig, err := readGCPCloudKMSConfig(config)
if err != nil {
return nil, err
}
// Hosting on GCE/GKE with Google KMS encryption provider
cloudkmsService := gce.GetKMSService()
// Set defaults for location and keyRing.
location := kmsConfig.Global.Location
if len(location) == 0 {
location = defaultGKMSKeyRingLocation
}
keyRing := kmsConfig.Global.KeyRing
if len(keyRing) == 0 {
keyRing = defaultGKMSKeyRing
}
cryptoKey := kmsConfig.Global.CryptoKey
if len(cryptoKey) == 0 {
return nil, fmt.Errorf("missing cryptoKey for cloudprovided KMS: " + KMSServiceName)
}
parentName := fmt.Sprintf("projects/%s/locations/%s", gce.projectID, location)
// Create the keyRing if it does not exist yet
_, err = cloudkmsService.Projects.Locations.KeyRings.Create(parentName,
&cloudkms.KeyRing{}).KeyRingId(keyRing).Do()
if err != nil && unrecoverableCreationError(err) {
return nil, err
}
parentName = parentName + "/keyRings/" + keyRing
// Create the cryptoKey if it does not exist yet
_, err = cloudkmsService.Projects.Locations.KeyRings.CryptoKeys.Create(parentName,
&cloudkms.CryptoKey{
Purpose: "ENCRYPT_DECRYPT",
}).CryptoKeyId(cryptoKey).Do()
if err != nil && unrecoverableCreationError(err) {
return nil, err
}
parentName = parentName + "/cryptoKeys/" + cryptoKey
service := &gkmsService{
parentName: parentName,
cloudkmsService: cloudkmsService,
}
// Sanity check before startup. For non-GCP clusters, the user's account may not have permissions to create
// the key. We need to verify the existence of the key before apiserver startup.
_, err = service.Encrypt([]byte("test"))
if err != nil {
return nil, fmt.Errorf("failed to encrypt data using Google cloudkms, using key %s. Ensure that the keyRing and cryptoKey exist. Got error: %v", parentName, err)
}
return service, nil
}
// Decrypt decrypts a base64 representation of encrypted bytes.
func (t *gkmsService) Decrypt(data string) ([]byte, error) {
resp, err := t.cloudkmsService.Projects.Locations.KeyRings.CryptoKeys.
Decrypt(t.parentName, &cloudkms.DecryptRequest{
Ciphertext: data,
}).Do()
if err != nil {
return nil, err
}
return base64.StdEncoding.DecodeString(resp.Plaintext)
}
// Encrypt encrypts bytes, and returns base64 representation of the ciphertext.
func (t *gkmsService) Encrypt(data []byte) (string, error) {
resp, err := t.cloudkmsService.Projects.Locations.KeyRings.CryptoKeys.
Encrypt(t.parentName, &cloudkms.EncryptRequest{
Plaintext: base64.StdEncoding.EncodeToString(data),
}).Do()
if err != nil {
return "", err
}
return resp.Ciphertext, nil
}
// unrecoverableCreationError decides if Kubernetes should ignore the encountered Google KMS
// error. Only to be used for errors seen while creating a KeyRing or CryptoKey.
func unrecoverableCreationError(err error) bool {
apiError, isAPIError := err.(*googleapi.Error)
// 409 means the object exists.
// 403 means we do not have permission to create the object, the user must do it.
// Else, it is an unrecoverable error.
if !isAPIError || (apiError.Code != 409 && apiError.Code != 403) {
return true
}
return false
}
vendor/BUILD
View file @ 01f205ad
...@@ -370,7 +370,6 @@ filegroup( ...@@ -370,7 +370,6 @@ filegroup(
"//vendor/golang.org/x/time/rate:all-srcs", "//vendor/golang.org/x/time/rate:all-srcs",
"//vendor/golang.org/x/tools/container/intsets:all-srcs", "//vendor/golang.org/x/tools/container/intsets:all-srcs",
"//vendor/golang.org/x/tools/go/vcs:all-srcs", "//vendor/golang.org/x/tools/go/vcs:all-srcs",
"//vendor/google.golang.org/api/cloudkms/v1:all-srcs",
"//vendor/google.golang.org/api/cloudmonitoring/v2beta2:all-srcs", "//vendor/google.golang.org/api/cloudmonitoring/v2beta2:all-srcs",
"//vendor/google.golang.org/api/compute/v0.alpha:all-srcs", "//vendor/google.golang.org/api/compute/v0.alpha:all-srcs",
"//vendor/google.golang.org/api/compute/v0.beta:all-srcs", "//vendor/google.golang.org/api/compute/v0.beta:all-srcs",
......
vendor/google.golang.org/api/cloudkms/v1/BUILD deleted 100644 → 0
View file @ 9459f475
load("@io_bazel_rules_go//go:def.bzl", "go_library")
go_library(
name = "go_default_library",
srcs = ["cloudkms-gen.go"],
importpath = "google.golang.org/api/cloudkms/v1",
visibility = ["//visibility:public"],
deps = [
"//vendor/golang.org/x/net/context:go_default_library",
"//vendor/golang.org/x/net/context/ctxhttp:go_default_library",
"//vendor/google.golang.org/api/gensupport:go_default_library",
"//vendor/google.golang.org/api/googleapi:go_default_library",
],
)
filegroup(
name = "package-srcs",
srcs = glob(["**"]),
tags = ["automanaged"],
visibility = ["//visibility:private"],
)
filegroup(
name = "all-srcs",
srcs = [":package-srcs"],
tags = ["automanaged"],
visibility = ["//visibility:public"],
)
vendor/google.golang.org/api/cloudkms/v1/cloudkms-api.json deleted 100644 → 0
View file @ 9459f475
{
"ownerDomain": "google.com",
"name": "cloudkms",
"batchPath": "batch",
"title": "Google Cloud Key Management Service (KMS) API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"get": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"id": "cloudkms.projects.locations.get",
"path": "v1/{+name}",
"description": "Get information about a location.",
"response": {
"$ref": "Location"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "Resource name for the location.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations",
"id": "cloudkms.projects.locations.list",
"path": "v1/{+name}/locations"
}
},
"resources": {
"keyRings": {
"methods": {
"list": {
"description": "Lists KeyRings.",
"response": {
"$ref": "ListKeyRingsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
"id": "cloudkms.projects.locations.keyRings.list",
"path": "v1/{+parent}/keyRings"
},
"setIamPolicy": {
"httpMethod": "POST",
"parameterOrder": [
"resource"
],
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
"id": "cloudkms.projects.locations.keyRings.setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"create": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
"path": "v1/{+parent}/keyRings",
"id": "cloudkms.projects.locations.keyRings.create",
"request": {
"$ref": "KeyRing"
},
"description": "Create a new KeyRing in a given Project and Location.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "KeyRing"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"keyRingId": {
"description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
"type": "string",
"location": "query"
},
"parent": {
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
}
},
"getIamPolicy": {
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
"id": "cloudkms.projects.locations.keyRings.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
},
"get": {
"description": "Returns metadata for a given KeyRing.",
"response": {
"$ref": "KeyRing"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the KeyRing to get.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
"id": "cloudkms.projects.locations.keyRings.get",
"path": "v1/{+name}"
},
"testIamPermissions": {
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
"id": "cloudkms.projects.locations.keyRings.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions"
}
},
"resources": {
"cryptoKeys": {
"methods": {
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
}
},
"decrypt": {
"response": {
"$ref": "DecryptResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
"path": "v1/{+name}:decrypt",
"request": {
"$ref": "DecryptRequest"
},
"description": "Decrypts data that was protected by Encrypt."
},
"list": {
"description": "Lists CryptoKeys.",
"response": {
"$ref": "ListCryptoKeysResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
"location": "path",
"description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
"path": "v1/{+parent}/cryptoKeys"
},
"encrypt": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
"path": "v1/{+name}:encrypt",
"request": {
"$ref": "EncryptRequest"
},
"description": "Encrypts data, so that it can only be recovered by a call to Decrypt.",
"response": {
"$ref": "EncryptResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
"location": "path",
"description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
"type": "string",
"required": true
}
}
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "CryptoKey"
},
"parameters": {
"parent": {
"location": "path",
"description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$"
},
"cryptoKeyId": {
"description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
"type": "string",
"location": "query"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
"path": "v1/{+parent}/cryptoKeys",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
"description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
"request": {
"$ref": "CryptoKey"
}
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy"
},
"updatePrimaryVersion": {
"description": "Update the version of a CryptoKey that will be used in Encrypt",
"request": {
"$ref": "UpdateCryptoKeyPrimaryVersionRequest"
},
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "The resource name of the CryptoKey to update.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
"path": "v1/{+name}:updatePrimaryVersion"
},
"getIamPolicy": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true
}
}
},
"get": {
"description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
"response": {
"$ref": "CryptoKey"
},
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "The name of the CryptoKey to get.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
"path": "v1/{+name}"
},
"patch": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
"path": "v1/{+name}",
"request": {
"$ref": "CryptoKey"
},
"description": "Update a CryptoKey.",
"response": {
"$ref": "CryptoKey"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string",
"location": "query"
},
"name": {
"description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
}
},
"resources": {
"cryptoKeyVersions": {
"methods": {
"list": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
"path": "v1/{+parent}/cryptoKeyVersions",
"description": "Lists CryptoKeyVersions.",
"response": {
"$ref": "ListCryptoKeyVersionsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
}
},
"destroy": {
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"description": "The resource name of the CryptoKeyVersion to destroy.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
"path": "v1/{+name}:destroy",
"description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
"request": {
"$ref": "DestroyCryptoKeyVersionRequest"
}
},
"create": {
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
"path": "v1/{+parent}/cryptoKeyVersions",
"description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
"request": {
"$ref": "CryptoKeyVersion"
},
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"location": "path",
"description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions"
},
"restore": {
"description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
"request": {
"$ref": "RestoreCryptoKeyVersionRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "CryptoKeyVersion"
},
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path",
"description": "The resource name of the CryptoKeyVersion to restore.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
"path": "v1/{+name}:restore",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore"
},
"patch": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"path": "v1/{+name}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
"description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.",
"request": {
"$ref": "CryptoKeyVersion"
},
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "CryptoKeyVersion"
},
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string",
"location": "query"
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"response": {
"$ref": "CryptoKeyVersion"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "The name of the CryptoKeyVersion to get.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
"path": "v1/{+name}",
"description": "Returns metadata for a given CryptoKeyVersion."
}
}
}
}
}
}
}
}
}
}
}
},
"parameters": {
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
}
},
"version": "v1",
"baseUrl": "https://cloudkms.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.",
"servicePath": "",
"basePath": "",
"revision": "20170904",
"documentationLink": "https://cloud.google.com/kms/",
"id": "cloudkms:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"CryptoKeyVersion": {
"description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.",
"type": "object",
"properties": {
"state": {
"description": "The current state of the CryptoKeyVersion.",
"type": "string",
"enumDescriptions": [
"Not specified.",
"This version may be used in Encrypt and\nDecrypt requests.",
"This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
"This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
"This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
],
"enum": [
"CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
"ENABLED",
"DISABLED",
"DESTROYED",
"DESTROY_SCHEDULED"
]
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
"type": "string"
},
"destroyEventTime": {
"format": "google-datetime",
"description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
"type": "string"
},
"destroyTime": {
"format": "google-datetime",
"description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
"type": "string"
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this CryptoKeyVersion was created.",
"type": "string"
}
},
"id": "CryptoKeyVersion"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"updateMask": {
"format": "google-fieldmask",
"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"id": "SetIamPolicyRequest"
},
"DecryptRequest": {
"description": "Request message for KeyManagementService.Decrypt.",
"type": "object",
"properties": {
"additionalAuthenticatedData": {
"format": "byte",
"description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
"type": "string"
},
"ciphertext": {
"format": "byte",
"description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
"type": "string"
}
},
"id": "DecryptRequest"
},
"Binding": {
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
},
"id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"type": "object",
"properties": {
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
},
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
}
},
"id": "Expr"
},
"EncryptRequest": {
"description": "Request message for KeyManagementService.Encrypt.",
"type": "object",
"properties": {
"plaintext": {
"format": "byte",
"description": "Required. The data to encrypt. Must be no larger than 64KiB.",
"type": "string"
},
"additionalAuthenticatedData": {
"format": "byte",
"description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
"type": "string"
}
},
"id": "EncryptRequest"
},
"ListCryptoKeyVersionsResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
"type": "object",
"properties": {
"cryptoKeyVersions": {
"description": "The list of CryptoKeyVersions.",
"items": {
"$ref": "CryptoKeyVersion"
},
"type": "array"
},
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
"type": "string"
},
"totalSize": {
"format": "int32",
"description": "The total number of CryptoKeyVersions that matched the\nquery.",
"type": "integer"
}
},
"id": "ListCryptoKeyVersionsResponse"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"id": "Location"
},
"ListCryptoKeysResponse": {
"description": "Response message for KeyManagementService.ListCryptoKeys.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.",
"type": "string"
},
"totalSize": {
"format": "int32",
"description": "The total number of CryptoKeys that matched the query.",
"type": "integer"
},
"cryptoKeys": {
"description": "The list of CryptoKeys.",
"items": {
"$ref": "CryptoKey"
},
"type": "array"
}
},
"id": "ListCryptoKeysResponse"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsResponse"
},
"DestroyCryptoKeyVersionRequest": {
"description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
"type": "object",
"properties": {},
"id": "DestroyCryptoKeyVersionRequest"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"description": "The log type that this config enables.",
"type": "string"
}
},
"id": "AuditLogConfig"
},
"CryptoKey": {
"description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
"type": "object",
"properties": {
"purpose": {
"enumDescriptions": [
"Not specified.",
"CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
],
"enum": [
"CRYPTO_KEY_PURPOSE_UNSPECIFIED",
"ENCRYPT_DECRYPT"
],
"description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
"type": "string"
},
"nextRotationTime": {
"format": "google-datetime",
"description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels with user defined metadata.",
"type": "object"
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this CryptoKey was created.",
"type": "string"
},
"rotationPeriod": {
"format": "google-duration",
"description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
"type": "string"
},
"primary": {
"description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
"$ref": "CryptoKeyVersion"
},
"name": {
"description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
"type": "string"
}
},
"id": "CryptoKey"
},
"DecryptResponse": {
"description": "Response message for KeyManagementService.Decrypt.",
"type": "object",
"properties": {
"plaintext": {
"format": "byte",
"description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
"type": "string"
}
},
"id": "DecryptResponse"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsRequest"
},
"EncryptResponse": {
"description": "Response message for KeyManagementService.Encrypt.",
"type": "object",
"properties": {
"name": {
"description": "The resource name of the CryptoKeyVersion used in encryption.",
"type": "string"
},
"ciphertext": {
"format": "byte",
"description": "The encrypted data.",
"type": "string"
}
},
"id": "EncryptResponse"
},
"KeyRing": {
"description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
"type": "object",
"properties": {
"createTime": {
"format": "google-datetime",
"description": "Output only. The time at which this KeyRing was created.",
"type": "string"
},
"name": {
"description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
"type": "string"
}
},
"id": "KeyRing"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
}
},
"id": "ListLocationsResponse"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"iamOwned": {
"type": "boolean"
},
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"type": "string"
},
"version": {
"format": "int32",
"description": "Version of the `Policy`. The default version is 0.",
"type": "integer"
}
},
"id": "Policy"
},
"UpdateCryptoKeyPrimaryVersionRequest": {
"properties": {
"cryptoKeyVersionId": {
"description": "The id of the child CryptoKeyVersion to use as primary.",
"type": "string"
}
},
"id": "UpdateCryptoKeyPrimaryVersionRequest",
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object"
},
"RestoreCryptoKeyVersionRequest": {
"description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
"type": "object",
"properties": {},
"id": "RestoreCryptoKeyVersionRequest"
},
"ListKeyRingsResponse": {
"description": "Response message for KeyManagementService.ListKeyRings.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.",
"type": "string"
},
"totalSize": {
"format": "int32",
"description": "The total number of KeyRings that matched the query.",
"type": "integer"
},
"keyRings": {
"description": "The list of KeyRings.",
"items": {
"$ref": "KeyRing"
},
"type": "array"
}
},
"id": "ListKeyRingsResponse"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
"type": "object",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.\nNext ID: 4",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"exemptedMembers": {
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
},
"id": "AuditConfig"
}
},
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"canonicalName": "Cloud KMS",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"rootUrl": "https://cloudkms.googleapis.com/"
}
vendor/google.golang.org/api/cloudkms/v1/cloudkms-gen.go deleted 100644 → 0
View file @ 9459f475
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment