google-cloud-kms-v1 0.15.0 → 0.17.0

data/lib/google/cloud/kms/v1/ekm_service/rest/service_stub.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "google/cloud/kms/v1/ekm_service_pb"
+
+module Google
+  module Cloud
+    module Kms
+      module V1
+        module EkmService
+          module Rest
+            ##
+            # REST service stub for the EkmService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the list_ekm_connections REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::ListEkmConnectionsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::ListEkmConnectionsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::ListEkmConnectionsResponse]
+              #   A result object deserialized from the server's reply
+              def list_ekm_connections request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_ekm_connections_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Kms::V1::ListEkmConnectionsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the get_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::GetEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::EkmConnection]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::EkmConnection]
+              #   A result object deserialized from the server's reply
+              def get_ekm_connection request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_get_ekm_connection_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Kms::V1::EkmConnection.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the create_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::CreateEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::EkmConnection]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::EkmConnection]
+              #   A result object deserialized from the server's reply
+              def create_ekm_connection request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_create_ekm_connection_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Kms::V1::EkmConnection.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the update_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::UpdateEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Kms::V1::EkmConnection]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Kms::V1::EkmConnection]
+              #   A result object deserialized from the server's reply
+              def update_ekm_connection request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_update_ekm_connection_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split("=", 2) }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Kms::V1::EkmConnection.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_ekm_connections REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::ListEkmConnectionsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_ekm_connections_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{parent}/ekmConnections",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the get_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::GetEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_get_ekm_connection_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the create_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::CreateEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_create_ekm_connection_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/ekmConnections",
+                                                          body: "ekm_connection",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the update_ekm_connection REST call
+              #
+              # @param request_pb [::Google::Cloud::Kms::V1::UpdateEkmConnectionRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_update_ekm_connection_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v1/{ekm_connection.name}",
+                                                          body: "ekm_connection",
+                                                          matches: [
+                                                            ["ekm_connection.name", %r{^projects/[^/]+/locations/[^/]+/ekmConnections/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/kms/v1/ekm_service/rest.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/kms/v1/version"
+require "google/cloud/kms/v1/bindings_override"
+
+require "google/cloud/kms/v1/ekm_service/credentials"
+require "google/cloud/kms/v1/ekm_service/paths"
+require "google/cloud/kms/v1/ekm_service/rest/client"
+
+module Google
+  module Cloud
+    module Kms
+      module V1
+        ##
+        # Google Cloud Key Management EKM Service
+        #
+        # Manages external cryptographic keys and operations using those keys.
+        # Implements a REST model with the following objects:
+        # * {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/kms/v1/ekm_service/rest"
+        #     client = ::Google::Cloud::Kms::V1::EkmService::Rest::Client.new
+        #
+        module EkmService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/kms/v1/ekm_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/kms/v1/ekm_service.rb

@@ -25,6 +25,7 @@ require "google/cloud/kms/v1/version"
 require "google/cloud/kms/v1/ekm_service/credentials"
 require "google/cloud/kms/v1/ekm_service/paths"
 require "google/cloud/kms/v1/ekm_service/client"
+require "google/cloud/kms/v1/ekm_service/rest"
 
 module Google
   module Cloud
@@ -37,11 +38,16 @@ module Google
         # Implements a REST model with the following objects:
         # * {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/kms/v1/ekm_service"
         #     client = ::Google::Cloud::Kms::V1::EkmService::Client.new
         #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/kms/v1/ekm_service/rest"
+        #     client = ::Google::Cloud::Kms::V1::EkmService::Rest::Client.new
+        #
         module EkmService
         end
       end

data/lib/google/cloud/kms/v1/key_management_service/client.rb

@@ -371,13 +371,11 @@ module Google
             #   # Call the list_key_rings method.
             #   result = client.list_key_rings request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Kms::V1::KeyRing.
-            #     p response
+            #     p item
             #   end
             #
             def list_key_rings request, options = nil
@@ -487,13 +485,11 @@ module Google
             #   # Call the list_crypto_keys method.
             #   result = client.list_crypto_keys request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Kms::V1::CryptoKey.
-            #     p response
+            #     p item
             #   end
             #
             def list_crypto_keys request, options = nil
@@ -604,13 +600,11 @@ module Google
             #   # Call the list_crypto_key_versions method.
             #   result = client.list_crypto_key_versions request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Kms::V1::CryptoKeyVersion.
-            #     p response
+            #     p item
             #   end
             #
             def list_crypto_key_versions request, options = nil
@@ -718,13 +712,11 @@ module Google
             #   # Call the list_import_jobs method.
             #   result = client.list_import_jobs request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Kms::V1::ImportJob.
-            #     p response
+            #     p item
             #   end
             #
             def list_import_jobs request, options = nil
@@ -1522,7 +1514,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload import_crypto_key_version(parent: nil, crypto_key_version: nil, algorithm: nil, import_job: nil, rsa_aes_wrapped_key: nil)
+            # @overload import_crypto_key_version(parent: nil, crypto_key_version: nil, algorithm: nil, import_job: nil, wrapped_key: nil, rsa_aes_wrapped_key: nil)
             #   Pass arguments to `import_crypto_key_version` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1564,32 +1556,52 @@ module Google
             #     Required. The {::Google::Cloud::Kms::V1::ImportJob#name name} of the
             #     {::Google::Cloud::Kms::V1::ImportJob ImportJob} that was used to wrap this key
             #     material.
-            #   @param rsa_aes_wrapped_key [::String]
-            #     Wrapped key material produced with
-            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA1_AES_256 RSA_OAEP_3072_SHA1_AES_256}
+            #   @param wrapped_key [::String]
+            #     Optional. The wrapped key material to import.
+            #
+            #     Before wrapping, key material must be formatted. If importing symmetric key
+            #     material, the expected key material format is plain bytes. If importing
+            #     asymmetric key material, the expected key material format is PKCS#8-encoded
+            #     DER (the PrivateKeyInfo structure from RFC 5208).
+            #
+            #     When wrapping with import methods
+            #     ({::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA1_AES_256 RSA_OAEP_3072_SHA1_AES_256}
+            #     or
+            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA1_AES_256 RSA_OAEP_4096_SHA1_AES_256}
+            #     or
+            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA256_AES_256 RSA_OAEP_3072_SHA256_AES_256}
             #     or
-            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA1_AES_256 RSA_OAEP_4096_SHA1_AES_256}.
+            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA256_AES_256 RSA_OAEP_4096_SHA256_AES_256}),
             #
-            #     This field contains the concatenation of two wrapped keys:
+            #     this field must contain the concatenation of:
             #     <ol>
             #       <li>An ephemeral AES-256 wrapping key wrapped with the
             #           {::Google::Cloud::Kms::V1::ImportJob#public_key public_key} using
-            #           RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an
-            #           empty label.
+            #           RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty
+            #           label.
             #       </li>
-            #       <li>The key to be imported, wrapped with the ephemeral AES-256 key
-            #           using AES-KWP (RFC 5649).
+            #       <li>The formatted key to be imported, wrapped with the ephemeral AES-256
+            #           key using AES-KWP (RFC 5649).
             #       </li>
             #     </ol>
             #
-            #     If importing symmetric key material, it is expected that the unwrapped
-            #     key contains plain bytes. If importing asymmetric key material, it is
-            #     expected that the unwrapped key is in PKCS#8-encoded DER format (the
-            #     PrivateKeyInfo structure from RFC 5208).
-            #
             #     This format is the same as the format produced by PKCS#11 mechanism
             #     CKM_RSA_AES_KEY_WRAP.
             #
+            #     When wrapping with import methods
+            #     ({::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_3072_SHA256 RSA_OAEP_3072_SHA256}
+            #     or
+            #     {::Google::Cloud::Kms::V1::ImportJob::ImportMethod::RSA_OAEP_4096_SHA256 RSA_OAEP_4096_SHA256}),
+            #
+            #     this field must contain the formatted key to be imported, wrapped with the
+            #     {::Google::Cloud::Kms::V1::ImportJob#public_key public_key} using RSAES-OAEP
+            #     with SHA-256, MGF1 with SHA-256, and an empty label.
+            #   @param rsa_aes_wrapped_key [::String]
+            #     Optional. This field has the same meaning as
+            #     {::Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest#wrapped_key wrapped_key}.
+            #     Prefer to use that field in new work. Either that field or this field
+            #     (but not both) must be specified.
+            #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Kms::V1::CryptoKeyVersion]
             # @yieldparam operation [::GRPC::ActiveCall::Operation]
@@ -2265,7 +2277,9 @@ module Google
             #
             #     The maximum size depends on the key version's
             #     {::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
-            #     For {::Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the
+            #     For {::Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE},
+            #     {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL}, and
+            #     {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC EXTERNAL_VPC} keys, the
             #     plaintext must be no larger than 64KiB. For
             #     {::Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of
             #     the plaintext and additional_authenticated_data fields must be no larger
@@ -2277,8 +2291,10 @@ module Google
             #
             #     The maximum size depends on the key version's
             #     {::Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}.
-            #     For {::Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD
-            #     must be no larger than 64KiB. For
+            #     For {::Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE},
+            #     {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL EXTERNAL}, and
+            #     {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC EXTERNAL_VPC} keys the
+            #     AAD must be no larger than 64KiB. For
             #     {::Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of
             #     the plaintext and additional_authenticated_data fields must be no larger
             #     than 8KiB.