simple_oauth 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88c89c6dff93b31b6279da0d85c0b719cc94bac966356ae1783702ed3cbfe8e5
-  data.tar.gz: 1febe046539f65e64a5b3d6b787282e5ce91178bf1617f97ce6a08a5a159318e
+  metadata.gz: 8245692f23124570c69c39922493673741d0b63805aa68bad6bc36a10dfc873d
+  data.tar.gz: 371f536fbc9ce63a659b359887800b44aca7736f91720a3a17d1688c4afd9132
 SHA512:
-  metadata.gz: 1f2b608cbf969b4983f29c746a5e892b0d5b1d321a6e044b8c01f645be8733aade948f5410a0654a6ece51778050cdb5a846e7ca02d70c1bd53cdf4d943aab8d
-  data.tar.gz: 5c76e78b8b537367e00833e063f9a23bacd5e8ea00563e5e41536e0ee223f4c257032001411059380a6f3b39ab883e5253304a12e59eba2da4d88d6ebe130af7
+  metadata.gz: 73639dcce60dff2674874af945f5c8f710475b6a18c5842fb14dd4ac0eb180659e885a8e4e2f3c7593b4de0d6aa7c46ce951f22f2af8ca23358e4580f2150383
+  data.tar.gz: 4dacc0d32fa47802f531c1f2b25ab6ec4d669ce1d6e3f31973194f05e8f1ea45982a380b52ae78e0d8cd6c523df94ad855aef781d08529728a332ae6c4876cdd

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.5.4] - 2026-11-14
+
+### Changed
+
+* Look up a signature method by the name it was registered under without allocating, so signing a request allocates at least 4 fewer objects and verifying one at least 6 fewer. Verifying without a `signature_method` now allocates fewer objects than in 0.5.1
+
+## [0.5.3] - 2026-11-14
+
+### Fixed
+
+* Verify as fast as 0.5.1 when `Header#valid?` is not given a `signature_method`. 0.5.2 parsed the `consumer_secret` as an RSA key on every verification, which takes far longer to fail for a shared secret than verifying does, and parsed an RSA key twice. That made such a verification about 60 to 70 percent slower. Only a secret in PEM, or one that could be in DER, is now parsed, and an RSA key only once
+
 ## [0.5.2] - 2026-11-14
 
 ### Security

data/lib/simple_oauth/header/verification.rb

@@ -0,0 +1,82 @@
+require "openssl"
+
+module SimpleOAuth
+  class Header
+    # Checks of the signature method a received header claims, before it is verified with it
+    #
+    # @api private
+    module Verification
+      # The first byte of a key in DER, which encodes every key as an ASN.1 SEQUENCE
+      ASN1_SEQUENCE = 0x30
+
+      # The start of the line that opens every key in PEM
+      PEM_BOUNDARY = "-----BEGIN".freeze
+
+      private
+
+      # Checks that the header claims a signature method the verifier accepts
+      #
+      # @api private
+      # @param verifying [Hash] the header's options merged with the verifier's secrets
+      # @param expected [String, nil] the signature method the verifier expects, if it names one
+      # @return [Boolean] true if the claimed method is the expected one, or fits the key
+      # @raise [ArgumentError] if the expected signature method is not registered
+      def signature_method_acceptable?(verifying, expected)
+        claimed = options[:signature_method].to_s
+        return expected_signature_method?(claimed, expected) if expected
+
+        warn("SimpleOAuth::Header#valid? without a signature_method is deprecated. " \
+             "Name the method to verify with, such as signature_method: \"HMAC-SHA1\"", category: :deprecated)
+        key = verifying[:consumer_secret].to_s
+        Signature.registered?(claimed) && !PLAINTEXT_SIGNATURE_METHOD.casecmp(claimed).eql?(0) &&
+          (Signature.rsa?(claimed) ? key_encoded?(key) : !rsa_key?(key))
+      end
+
+      # Checks that the header claims the signature method the verifier names
+      #
+      # Signature method names are compared without regard to ASCII case, as the registry looks
+      # them up, and without allocating. A header that claims the expected method needs no other
+      # check here, since Signature.verify raises for a method that is not registered.
+      #
+      # @api private
+      # @param claimed [String] the signature method the header claims
+      # @param expected [String] the signature method the verifier expects
+      # @return [Boolean] true if the header claims the expected method
+      # @raise [ArgumentError] if the expected signature method is not registered
+      def expected_signature_method?(claimed, expected)
+        return true if claimed.casecmp(expected).eql?(0)
+        raise ArgumentError, "Unknown signature method: #{expected}" unless Signature.registered?(expected)
+
+        false
+      end
+
+      # Checks whether a verifying key is encoded as a key could be
+      #
+      # Only a key in PEM, which always holds a "-----BEGIN" line, or in DER, which always starts with
+      # the byte of an ASN.1 SEQUENCE, can be an RSA key, as those are the encodings OpenSSL decodes.
+      # Any other secret need not be parsed, which matters since a parse that fails is far slower
+      # than verifying a signature.
+      #
+      # @api private
+      # @param key [String] the consumer_secret the verifier gave
+      # @return [Boolean] true if the key is in PEM or could be in DER
+      def key_encoded?(key)
+        key.getbyte(0).eql?(ASN1_SEQUENCE) || key.include?(PEM_BOUNDARY)
+      end
+
+      # Checks whether a verifying key is an RSA key
+      #
+      # @api private
+      # @param key [String] the consumer_secret the verifier gave
+      # @return [Boolean] true if the key parses as an RSA key
+      def rsa_key?(key)
+        return false unless key_encoded?(key)
+
+        OpenSSL::PKey::RSA.new(key)
+        true
+      rescue OpenSSL::PKey::PKeyError
+        false
+      end
+    end
+  end
+end

data/lib/simple_oauth/header.rb

@@ -6,6 +6,7 @@ require_relative "parser"
 require_relative "signature"
 require_relative "header/class_methods"
 require_relative "header/params"
+require_relative "header/verification"
 
 module SimpleOAuth
   # Generates OAuth 1.0 Authorization headers for HTTP requests
@@ -67,6 +68,7 @@ module SimpleOAuth
     attr_reader :options
 
     include Params
+    include Verification
 
     extend ClassMethods
     extend Encoding
@@ -146,9 +148,8 @@ module SimpleOAuth
     #   # => true
     def valid?(secrets = {})
       verifying = options.merge(secrets)
-      signature_method_acceptable?(verifying, secrets[:signature_method]) && body_hash_valid? &&
-        Signature.verify(options.fetch(:signature_method), signing_key(verifying), signature_base,
-          options.fetch(:signature))
+      expected = secrets[:signature_method]
+      signature_method_acceptable?(verifying, expected) && body_hash_valid? && signature_valid?(verifying, expected)
     end
 
     # Returns the OAuth attributes including the signature
@@ -230,47 +231,25 @@ module SimpleOAuth
       Signature.rsa?(options.fetch(:signature_method)) ? options[:consumer_secret] : secret(options)
     end
 
-    # Checks that the header claims a signature method the verifier accepts
+    # Verifies the signature with the method the header claims
+    #
+    # A header that claims an RSA method, with no signature_method named, is verified without first
+    # parsing the key to check that it is an RSA key, so the key is parsed once rather than twice. The verifier
+    # raises PKeyError only for a key that is not an RSA key, which makes the header not valid, as
+    # the key does not fit the method. A verifier that names a method keeps the error, since naming
+    # an RSA method with another key is a mistake to report.
     #
     # @api private
     # @param verifying [Hash] the header's options merged with the verifier's secrets
     # @param expected [String, nil] the signature method the verifier expects, if it names one
-    # @return [Boolean] true if the claimed method is the expected one, or fits the key
-    # @raise [ArgumentError] if the expected signature method is not registered
-    def signature_method_acceptable?(verifying, expected)
-      claimed = options[:signature_method].to_s
-      return expected_signature_method?(claimed, expected) if expected
-
-      warn("SimpleOAuth::Header#valid? without a signature_method is deprecated. " \
-           "Name the method to verify with, such as signature_method: \"HMAC-SHA1\"", category: :deprecated)
-      Signature.registered?(claimed) && !PLAINTEXT_SIGNATURE_METHOD.casecmp?(claimed) &&
-        Signature.rsa?(claimed).eql?(rsa_key?(verifying[:consumer_secret]))
-    end
-
-    # Checks that the header claims the signature method the verifier names
-    #
-    # Signature method names are compared without regard to case, as the registry looks them up.
-    #
-    # @api private
-    # @param claimed [String] the signature method the header claims
-    # @param expected [String] the signature method the verifier expects
-    # @return [Boolean] true if the header claims the expected method
-    # @raise [ArgumentError] if the expected signature method is not registered
-    def expected_signature_method?(claimed, expected)
-      raise ArgumentError, "Unknown signature method: #{expected}" unless Signature.registered?(expected)
-
-      claimed.casecmp?(expected)
-    end
-
-    # Checks whether a verifying key is an RSA key
-    #
-    # @api private
-    # @param key [String, nil] the consumer_secret the verifier gave
-    # @return [Boolean] true if the key parses as an RSA key
-    def rsa_key?(key)
-      OpenSSL::PKey::RSA.new(key.to_s)
-      true
+    # @return [Boolean] true if the signature is valid
+    # @raise [OpenSSL::PKey::PKeyError] if the verifier names an RSA method with a key that is not an RSA key
+    def signature_valid?(verifying, expected)
+      Signature.verify(options.fetch(:signature_method), signing_key(verifying), signature_base,
+        options.fetch(:signature))
     rescue OpenSSL::PKey::PKeyError
+      raise if expected
+
       false
     end
 

data/lib/simple_oauth/signature.rb

@@ -26,6 +26,10 @@ module SimpleOAuth
     # Registry of signature method implementations
     @registry = {}
 
+    # The registry key of each name a signature method was registered under, so a lookup by that
+    # name, as nearly every lookup is, needs no normalizing and allocates nothing
+    @names = {}
+
     class << self
       # Registers a custom signature method
       #
@@ -47,7 +51,9 @@ module SimpleOAuth
       #     )
       #   end
       def register(name, rsa: false, verify: nil, digest: DEFAULT_DIGEST, &block)
-        @registry[normalize_name(name)] = {implementation: block, rsa: rsa, verifier: verify, digest: digest}
+        key = normalize_name(name)
+        @names[name] = key
+        @registry[key] = {implementation: block, rsa: rsa, verifier: verify, digest: digest}
       end
 
       # Checks if a signature method is registered
@@ -58,7 +64,7 @@ module SimpleOAuth
       # @example
       #   SimpleOAuth::Signature.registered?("HMAC-SHA1") # => true
       def registered?(name)
-        @registry.key?(normalize_name(name))
+        @registry.key?(registry_key(name))
       end
 
       # Returns list of registered signature method names
@@ -80,7 +86,7 @@ module SimpleOAuth
       #   SimpleOAuth::Signature.rsa?("RSA-SHA1")  # => true
       #   SimpleOAuth::Signature.rsa?("HMAC-SHA1") # => false
       def rsa?(name)
-        @registry.dig(normalize_name(name), :rsa) || false
+        @registry.dig(registry_key(name), :rsa) || false
       end
 
       # Returns the hash algorithm a signature method signs with
@@ -136,7 +142,9 @@ module SimpleOAuth
       # @example
       #   SimpleOAuth::Signature.unregister("HMAC-SHA512")
       def unregister(name)
-        @registry.delete(normalize_name(name))
+        key = registry_key(name)
+        @names.delete_if { |_, registered| registered.eql?(key) }
+        @registry.delete(key)
       end
 
       # Resets the registry to only built-in methods (useful for testing)
@@ -147,6 +155,7 @@ module SimpleOAuth
       #   SimpleOAuth::Signature.reset!
       def reset!
         @registry.clear
+        @names.clear
         register_builtin_methods
       end
 
@@ -183,12 +192,25 @@ module SimpleOAuth
       # @return [Hash] the registry entry
       # @raise [ArgumentError] if the signature method is not registered
       def fetch(name)
-        @registry.fetch(normalize_name(name)) do
+        @registry.fetch(registry_key(name)) do
           raise ArgumentError, "Unknown signature method: #{name}. " \
                                "Registered methods: #{@registry.keys.join(", ")}"
         end
       end
 
+      # Finds the registry key for a signature method name
+      #
+      # A name a method was registered under is found in the index of those names. Any other
+      # spelling is normalized, without being added to the index, so names from received headers
+      # cannot grow it.
+      #
+      # @api private
+      # @param name [String] the signature method name
+      # @return [String] the registry key (lowercase, dashes to underscores)
+      def registry_key(name)
+        @names[name] || normalize_name(name)
+      end
+
       # Normalizes signature method name for registry lookup
       #
       # @api private

data/lib/simple_oauth/version.rb

@@ -1,5 +1,5 @@
 # OAuth 1.0 header generation library
 module SimpleOauth
   # The current version of the SimpleOAuth gem
-  VERSION = "0.5.2".freeze
+  VERSION = "0.5.4".freeze
 end

data/sig/simple_oauth/header/verification.rbs

@@ -0,0 +1,28 @@
+module SimpleOAuth
+  class Header
+    # What the Verification module needs from the header that includes it
+    interface _Verifiable
+      def options: () -> Header::oauth_options
+    end
+
+    # Checks of the signature method a received header claims, before it is verified with it
+    module Verification : _Verifiable
+      # The first byte of a key in DER, which encodes every key as an ASN.1 SEQUENCE
+      ASN1_SEQUENCE: Integer
+
+      # The start of the line that opens every key in PEM
+      PEM_BOUNDARY: String
+
+      private
+
+      # Checks that the header claims a signature method the verifier accepts
+      def signature_method_acceptable?: (Header::oauth_options verifying, String? expected) -> bool
+      # Checks that the header claims the signature method the verifier names
+      def expected_signature_method?: (String claimed, String expected) -> bool
+      # Checks whether a verifying key is encoded as a key could be
+      def key_encoded?: (String key) -> bool
+      # Checks whether a verifying key is an RSA key
+      def rsa_key?: (String key) -> bool
+    end
+  end
+end

data/sig/simple_oauth/signature.rbs

@@ -19,6 +19,9 @@ module SimpleOAuth
     # Registry of signature method implementations (class-level instance variable)
     self.@registry: Hash[String, registry_entry]
 
+    # The registry key of each name a signature method was registered under
+    self.@names: Hash[String | Symbol, String]
+
     # Registers a custom signature method
     def self.register: (String | Symbol name, ?rsa: bool, ?verify: verifier_block?, ?digest: String) { (untyped, String) -> String } -> void
 
@@ -57,6 +60,9 @@ module SimpleOAuth
     # Looks up a registered signature method
     def self.fetch: (String | Symbol name) -> registry_entry
 
+    # Finds the registry key for a signature method name
+    def self.registry_key: (String | Symbol name) -> String
+
     # Normalizes signature method name for registry lookup
     def self.normalize_name: (String | Symbol name) -> String
 

data/sig/simple_oauth.rbs

@@ -61,6 +61,8 @@ module SimpleOAuth
     # The signature method that sends the secrets themselves, which verifying accepts only when named
     PLAINTEXT_SIGNATURE_METHOD: String
 
+
+
     # What from_request needs from a request object, such as a Net::HTTPRequest
     interface _Request
       def method: () -> String
@@ -94,6 +96,9 @@ module SimpleOAuth
     # Parameter and attribute normalization from the Params module
     include Params
 
+    # Checks of the signature method a received header claims
+    include Verification
+
     # Class methods from ClassMethods module
     extend ClassMethods
 
@@ -147,14 +152,8 @@ module SimpleOAuth
     # The key for signing and verifying
     def signing_key: (oauth_options options) -> String?
 
-    # Checks that the header claims a signature method the verifier accepts
-    def signature_method_acceptable?: (oauth_options verifying, String? expected) -> bool
-
-    # Checks that the header claims the signature method the verifier names
-    def expected_signature_method?: (String claimed, String expected) -> bool
-
-    # Checks whether a verifying key is an RSA key
-    def rsa_key?: (String? key) -> bool
+    # Verifies the signature with the method the header claims
+    def signature_valid?: (oauth_options verifying, String? expected) -> bool
 
     # Checks the body against the oauth_body_hash the header carries
     def body_hash_valid?: () -> bool

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_oauth
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Steve Richert
@@ -60,6 +60,7 @@ files:
 - lib/simple_oauth/header.rb
 - lib/simple_oauth/header/class_methods.rb
 - lib/simple_oauth/header/params.rb
+- lib/simple_oauth/header/verification.rb
 - lib/simple_oauth/parser.rb
 - lib/simple_oauth/signature.rb
 - lib/simple_oauth/version.rb
@@ -69,6 +70,7 @@ files:
 - sig/simple_oauth.rbs
 - sig/simple_oauth/header/class_methods.rbs
 - sig/simple_oauth/header/params.rbs
+- sig/simple_oauth/header/verification.rbs
 - sig/simple_oauth/parser.rbs
 - sig/simple_oauth/signature.rbs
 - sig/strscan.rbs