gapic-common 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4338a183319704aa9fb613e73d34b4092a94ad56f3136c2d4a0490a3218770f
-  data.tar.gz: 3a0d1456f8c2bc573245e5c46afae6b2c83be393085bf6bebc5b28c06368d3f7
+  metadata.gz: 11f04f82fc6e98e5ca24d814d6162d68681999b6a7f2305cc32c77c597db2a88
+  data.tar.gz: a36c758ffd65878ac9809c0ecfc515e2c6e0e817f5ad679e8574e5dbeb8a03f6
 SHA512:
-  metadata.gz: 696026e2b9ca26c060c2b65a336f790ec193938a7740d8bdce3008c6bfae40cd80290077b717174554d7e6a1530e470f2523a5859b210c2bf9bd583e7dd72041
-  data.tar.gz: 42979948486f1e55f990bdbcc0ee2a697ffbf3c450b4013a7ae293e0960291533bfc4356fcfb8cfdeca5eae94d97a7ff522e2b5667cd1e9611de93cf39af560e
+  metadata.gz: 8fb7d4c578dc4b44383ac18e33159fd824465e63df13b10ed2d2fe142c4a9743876d7a3a41cd00680dc3e44cab88f6d3d6185198a8b74a85ace1ff30ee6d9e4e
+  data.tar.gz: 3d508937a578e43a1fe8022557d08a7c01be477b9141a1d055c0d6a1df8e739eca0a9e2f14d178aa90c4b121d44dd12e437d73242250009916645948238af388

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release History
 
+### 1.4.1 (2026-09-28)
+
+#### Bug Fixes
+
+* validate path parameters and prevent traversal/injection in REST transcoder ([#67](https://github.com/googleapis/ruby-core-libraries/issues/67)) 
+
+### 1.4.0 (2026-09-23)
+
+#### Features
+
+* add custom predicate matching to RetryPolicy ([#59](https://github.com/googleapis/ruby-core-libraries/issues/59)) 
+#### Bug Fixes
+
+* require grpc >= 1.83 for post-quantum key exchange ([#73](https://github.com/googleapis/ruby-core-libraries/issues/73)) 
+* only use emit_default for proto messages ([#75](https://github.com/googleapis/ruby-core-libraries/issues/75)) 
+
 ### 1.3.0 (2026-03-05)
 
 #### Features

data/README.md

@@ -15,7 +15,7 @@ convenient and idiomatic API surface to callers.
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 3.0+.
+This library is supported on Ruby 3.2+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
@@ -24,6 +24,35 @@ work, but are unsupported and not recommended. See
 https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
 support schedule.
 
+## Post-Quantum Key Exchange
+
+Clients built on this library negotiate the hybrid post-quantum key exchange
+group `X25519MLKEM768` — classical X25519 paired with ML-KEM-768 ([NIST FIPS
+203][]) — over TLS 1.3. No application code changes are required, because the
+handshake belongs to the transport layer. The two transports source that
+support differently:
+
+| Transport | Cryptographic provider | Requirement | Enforced by this gem? |
+| --- | --- | --- | --- |
+| gRPC | BoringSSL, vendored inside the `grpc` gem | `grpc >= 1.83` | Yes |
+| REST | Host system OpenSSL, via `Net::HTTP` and Faraday | OpenSSL `>= 3.5` | No |
+
+gRPC clients get post-quantum key exchange automatically: `gapic-common`
+depends on `grpc >= 1.83`, the first release to offer `X25519MLKEM768` in the
+TLS ClientHello by default.
+
+The REST requirement cannot be expressed as a gem dependency. Ruby's `openssl`
+is a default gem bound to whatever `libssl` the host provides, and ML-KEM first
+ships in OpenSSL 3.5. On an older host, REST connections negotiate classical
+X25519 instead — a safe fallback rather than an error, but not post-quantum. To
+check the OpenSSL your Ruby is linked against:
+
+```sh
+ruby -ropenssl -e 'puts OpenSSL::OPENSSL_LIBRARY_VERSION'
+```
+
+[NIST FIPS 203]: https://csrc.nist.gov/pubs/fips/203/final
+
 ## Contributing
 
 Contributions to this library are always welcome and highly encouraged.

data/lib/gapic/common/retry_policy.rb

@@ -45,9 +45,17 @@ module Gapic
       # @param retry_codes [Array<String|Integer>] List of retry codes.
       # @param timeout [Numeric] Timeout threshold value in seconds.
       # @param jitter [Numeric] Random jitter added to the delay in seconds.
+      # @param retry_predicate [Proc, nil] The predicate to evaluate whether to retry on a given error. Optional.
+      #   If the predicate is specified, it is run first. If it returns nil, the decision on
+      #   whether to retry is made on the basis of retry_codes. Otherwise, the truthiness of
+      #   the return value determines whether to retry.
       #
-      def initialize initial_delay: nil, max_delay: nil, multiplier: nil, retry_codes: nil, timeout: nil, jitter: nil
+      def initialize initial_delay: nil, max_delay: nil, multiplier: nil, retry_codes: nil, timeout: nil,
+                     jitter: nil, retry_predicate: nil
         raise ArgumentError, "jitter cannot be negative" if jitter&.negative?
+        if retry_predicate && !retry_predicate.respond_to?(:call)
+          raise ArgumentError, "retry_predicate must respond to :call"
+        end
 
         # Instance values are set as `nil` to determine whether values are overriden from default.
         @initial_delay = initial_delay
@@ -56,6 +64,7 @@ module Gapic
         @retry_codes = convert_codes retry_codes
         @timeout = timeout
         @jitter = jitter
+        @retry_predicate = retry_predicate
         start!
       end
 
@@ -89,6 +98,19 @@ module Gapic
         @jitter || DEFAULT_JITTER
       end
 
+      ##
+      # The predicate to evaluate whether to retry on a given error. Optional.
+      #
+      # When a predicate is specified:
+      # 1. The predicate is executed first on the error.
+      # 2. If it returns nil, the decision on whether to retry is made on the basis of retry_codes.
+      # 3. Otherwise, the truthiness of the return value determines whether to retry.
+      #
+      # @return [Proc, nil]
+      def retry_predicate
+        @retry_predicate
+      end
+
       ##
       # Returns a duplicate in a non-executing state, i.e. with the deadline
       # and current delay reset.
@@ -101,7 +123,8 @@ module Gapic
                         multiplier: @multiplier,
                         retry_codes: @retry_codes,
                         timeout: @timeout,
-                        jitter: @jitter
+                        jitter: @jitter,
+                        retry_predicate: @retry_predicate
       end
 
       ##
@@ -176,6 +199,13 @@ module Gapic
       # @return [Boolean] Whether this error should be retried.
       #
       def retry_error? error
+        # Run predicate first. If it returns nil, decision is made on the basis of retry_codes.
+        # Otherwise return truthiness.
+        if @retry_predicate.respond_to? :call
+          result = @retry_predicate.call error
+          return !!result unless result.nil?
+        end
+
         (defined?(::GRPC) && error.is_a?(::GRPC::BadStatus) && retry_codes.include?(error.code)) ||
           (error.respond_to?(:response_status) &&
             retry_codes.include?(ErrorCodes.grpc_error_for(error.response_status)))
@@ -197,11 +227,12 @@ module Gapic
       #
       def apply_defaults retry_policy
         return unless retry_policy.is_a? Hash
-        @retry_codes   ||= convert_codes retry_policy[:retry_codes]
-        @initial_delay ||= retry_policy[:initial_delay]
-        @multiplier    ||= retry_policy[:multiplier]
-        @max_delay     ||= retry_policy[:max_delay]
-        @jitter        ||= retry_policy[:jitter]
+        @retry_codes     ||= convert_codes retry_policy[:retry_codes]
+        @initial_delay   ||= retry_policy[:initial_delay]
+        @multiplier      ||= retry_policy[:multiplier]
+        @max_delay       ||= retry_policy[:max_delay]
+        @jitter          ||= retry_policy[:jitter]
+        @retry_predicate ||= retry_policy[:retry_predicate]
 
         self
       end
@@ -214,13 +245,14 @@ module Gapic
           other.multiplier == multiplier &&
           other.retry_codes == retry_codes &&
           other.timeout == timeout &&
-          other.jitter == jitter
+          other.jitter == jitter &&
+          other.retry_predicate == retry_predicate
       end
       alias == eql?
 
       # @private Hash code
       def hash
-        [initial_delay, max_delay, multiplier, retry_codes, timeout, jitter].hash
+        [initial_delay, max_delay, multiplier, retry_codes, timeout, jitter, retry_predicate].hash
       end
 
       private

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "1.3.0".freeze
+    VERSION = "1.4.1".freeze
   end
 end

data/lib/gapic/rest/grpc_transcoder.rb

@@ -111,12 +111,14 @@ module Gapic
       # @return [Hash{String, String}]
       #   Name to value hash of the variables for the uri template expansion.
       #   The values are percent-escaped with slashes potentially preserved.
+      # @raise [Gapic::Common::Error] If any parameter value fails path traversal or injection validation.
       def bind_uri_values! http_binding, request_hash
         http_binding.field_bindings.to_h do |field_binding|
           field_path_camel = field_binding.field_path.split(".").map { |part| camel_name_for part }.join(".")
           field_value = extract_scalar_value! request_hash, field_path_camel, field_binding.regex
 
           if field_value
+            validate_field_binding! field_binding, field_value
             field_value = field_value.split("/").map { |segment| percent_escape segment }.join("/")
           end
 
@@ -124,6 +126,43 @@ module Gapic
         end
       end
 
+      # Validates a user-supplied parameter value bound to a standard (*) or path (**) URI template variable
+      # to prevent directory traversal exploits.
+      #
+      # @param field_binding [HttpBinding::FieldBinding] The field binding template metadata.
+      # @param field_value [String] The parameter value to validate.
+      # @raise [Gapic::Common::Error] If validation fails.
+      def validate_field_binding! field_binding, field_value
+        validate_path_binding! field_binding, field_value
+      end
+
+      # Validates standard (*) and path (**) parameters by ensuring that no segment in the parameter
+      # value is a directory traversal segment (. or ..).
+      #
+      # Validation Mechanism:
+      # 1. Splits the parameter value by slash (`/`) using `-1` limit to preserve all segments.
+      # 2. Checks each segment. If any segment matches `.` or `..`, it immediately raises
+      #    a `Gapic::Common::Error`, aborting the request.
+      # 3. Empty segments (e.g. duplicate slashes `//` or trailing slashes `/`) are allowed
+      #    by this validator and passed to the server, which handles normalization or returns 400.
+      #
+      # @param field_binding [HttpBinding::FieldBinding] The field binding template metadata.
+      # @param field_value [String] The parameter value to validate.
+      # @raise [Gapic::Common::Error] If validation fails.
+      def validate_path_binding! field_binding, field_value
+        segments = field_value.split("/", -1)
+        segments.each do |segment|
+          next unless [".", ".."].include? segment
+          if field_binding.preserve_slashes
+            raise ::Gapic::Common::Error,
+                  "Value for #{field_binding.field_path} must not contain segments that are exactly '#{segment}'."
+          else
+            raise ::Gapic::Common::Error,
+                  "Invalid value for #{field_binding.field_path} '#{segment}'."
+          end
+        end
+      end
+
       # Percent-escapes a string.
       # @param str [String] String to escape.
       # @return [String] Escaped string.
@@ -160,7 +199,16 @@ module Gapic
           request_body_field = request.send body_template.to_sym if request.respond_to? body_template.to_sym
           if request_body_field
             request_hash_without_uri.delete camel_name_for body_template
-            body = request_body_field.to_json emit_defaults: true
+            # `emit_defaults` is only meaningful for, and only accepted by,
+            # `Google::Protobuf::MessageExts#to_json`. When the body template points at a
+            # scalar, enum or repeated field, `to_json` resolves to the json gem's
+            # `Object#to_json`, which has never accepted the keyword: json 2.x silently
+            # discarded unknown keywords, json 3.x raises ArgumentError.
+            body = if request_body_field.is_a? ::Google::Protobuf::MessageExts
+                     request_body_field.to_json emit_defaults: true
+                   else
+                     request_body_field.to_json
+                   end
           end
 
           query_params = build_query_params request_hash_without_uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Google API Authors
@@ -137,16 +137,22 @@ dependencies:
   name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.83'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.66'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.83'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.66'
+        version: 2.a
 email:
 - googleapis-packages@google.com
 executables: []
@@ -213,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="