standard_singpass 0.3.1 → 0.4.0

data/lib/standard_singpass/myinfo.rb

@@ -9,6 +9,7 @@ require "digest"
 require "securerandom"
 require "aes_key_wrap"
 
+require "standard_singpass/error"
 require "standard_singpass/myinfo/error"
 require "standard_singpass/myinfo/failure_classifier"
 require "standard_singpass/myinfo/configuration"
@@ -32,6 +33,7 @@ module StandardSingpass
       def configuration
         @configuration ||= Configuration.new
       end
+      alias_method :config, :configuration
 
       def reset_configuration!
         @configuration = Configuration.new
@@ -57,8 +59,7 @@ module StandardSingpass
             exported[:alg] = "ES256"
             keys << exported
           rescue OpenSSL::PKey::PKeyError => e
-            Rails.logger.error("StandardSingpass::Myinfo: failed to load signing key: #{e.message}")
-            Rails.error.report(e, handled: true, context: { component: "StandardSingpass::Myinfo", reason: "build_public_jwks_signing", kid: c.signing_kid })
+            log_and_report(e, "failed to load signing key: #{e.message}", reason: "build_public_jwks_signing", kid: c.signing_kid)
           end
         end
 
@@ -70,12 +71,17 @@ module StandardSingpass
           exported[:alg] = "ECDH-ES+A256KW"
           keys << exported
         rescue OpenSSL::PKey::PKeyError => e
-          Rails.logger.error("StandardSingpass::Myinfo: failed to load encryption key #{enc_key_config[:kid]}: #{e.message}")
-          Rails.error.report(e, handled: true, context: { component: "StandardSingpass::Myinfo", reason: "build_public_jwks_encryption", kid: enc_key_config[:kid] })
+          log_and_report(e, "failed to load encryption key #{enc_key_config[:kid]}: #{e.message}", reason: "build_public_jwks_encryption", kid: enc_key_config[:kid])
         end
 
         { keys: }
       end
+
+      def log_and_report(error, message, reason:, kid:)
+        return unless defined?(::Rails)
+        ::Rails.logger&.error("StandardSingpass::Myinfo: #{message}") if ::Rails.respond_to?(:logger)
+        ::Rails.error.report(error, handled: true, context: { component: "StandardSingpass::Myinfo", reason:, kid: }) if ::Rails.respond_to?(:error)
+      end
     end
   end
 end

data/lib/standard_singpass/testing.rb

@@ -0,0 +1,174 @@
+# typed: strict
+
+require "standard_singpass"
+
+module StandardSingpass
+  # Test-only helpers. Not loaded by `require "standard_singpass"`; require
+  # this file from a spec helper:
+  #
+  #   require "standard_singpass/testing"
+  #
+  # Nothing here is needed at runtime — Singpass encrypts, the gem decrypts.
+  module Testing
+    # ECDH-ES JWE *encryption*, the mirror of
+    # `StandardSingpass::Myinfo::EcdhJwe.decrypt`. Use it to build the
+    # encrypted id_token / userinfo payloads Singpass would return, so specs
+    # can exercise the real decrypt + verify path end to end.
+    #
+    # Accepts exactly the algorithms the decryptor does
+    # (`Myinfo::EcdhJwe::SUPPORTED_ALGS` / `SUPPORTED_ENCS`), and shares its
+    # key-agreement and KDF code, so a fixture that encrypts here decrypts
+    # there by construction.
+    class EcdhJwe
+      extend T::Sig
+
+      Impl = StandardSingpass::Myinfo::EcdhJwe
+      InvalidAlgorithm = StandardSingpass::Myinfo::EcdhJwe::InvalidAlgorithm
+
+      # Encrypts a payload and returns a compact-serialized JWE string.
+      sig do
+        params(
+          payload: String,
+          public_key: OpenSSL::PKey::EC,
+          alg: String,
+          enc: String,
+          kid: T.nilable(String),
+          apu: T.nilable(String),
+          apv: T.nilable(String)
+        ).returns(String)
+      end
+      def self.encrypt(payload, public_key:, alg:, enc:, kid: nil, apu: nil, apv: nil)
+        shared(:validate_algorithms!, alg, enc)
+
+        # Generate ephemeral key pair on same curve
+        group = public_key.group
+        ephemeral_key = OpenSSL::PKey::EC.generate(group.curve_name)
+
+        # ECDH key agreement
+        shared_secret = shared(:derive_shared_secret, ephemeral_key, public_key)
+
+        # Derive KEK via Concat KDF
+        kek_size = Impl::KEK_SIZES.fetch(alg)
+        kek = shared(:concat_kdf, shared_secret, alg, kek_size, apu:, apv:)
+
+        # Generate random CEK
+        cek_size = Impl::CEK_SIZES.fetch(enc)
+        cek = SecureRandom.random_bytes(cek_size)
+
+        # Wrap CEK with KEK
+        encrypted_key = AESKeyWrap.wrap(cek, kek)
+
+        # Build header
+        epk_jwk = ec_public_key_to_jwk(ephemeral_key)
+        header = { "alg" => alg, "enc" => enc, "epk" => epk_jwk }
+        header["kid"] = kid if kid
+        header["apu"] = Base64.urlsafe_encode64(apu, padding: false) if apu
+        header["apv"] = Base64.urlsafe_encode64(apv, padding: false) if apv
+
+        # Encrypt content
+        header_b64 = Base64.urlsafe_encode64(header.to_json, padding: false)
+        iv, ciphertext, auth_tag = encrypt_content(cek, enc, payload, header_b64)
+
+        # Assemble compact serialization
+        [
+          header_b64,
+          Base64.urlsafe_encode64(encrypted_key, padding: false),
+          Base64.urlsafe_encode64(T.must(iv), padding: false),
+          Base64.urlsafe_encode64(T.must(ciphertext), padding: false),
+          Base64.urlsafe_encode64(T.must(auth_tag), padding: false)
+        ].join(".")
+      end
+
+      class << self
+        extend T::Sig
+
+        private
+
+        # The decryptor's key-agreement / KDF / validation helpers are private
+        # class methods; reuse them rather than keeping a second copy.
+        sig { params(name: Symbol, args: T.untyped, kwargs: T.untyped).returns(T.untyped) }
+        def shared(name, *args, **kwargs)
+          T.unsafe(Impl).send(name, *args, **kwargs)
+        end
+
+        # Converts an OpenSSL EC key to a JWK hash (public components only).
+        sig { params(ec_key: OpenSSL::PKey::EC).returns(T::Hash[String, String]) }
+        def ec_public_key_to_jwk(ec_key)
+          # Get the public key point
+          point = ec_key.public_key
+          group = ec_key.group
+
+          # Determine curve name for JWK
+          crv = case group.curve_name
+          when "prime256v1" then "P-256"
+          when "secp384r1" then "P-384"
+          when "secp521r1" then "P-521"
+          else raise InvalidAlgorithm, "Unsupported curve: #{group.curve_name}"
+          end
+
+          # Get uncompressed point bytes (0x04 || x || y)
+          bn = point.to_bn(:uncompressed)
+          uncompressed = bn.to_s(2)
+
+          # Skip the 0x04 prefix byte
+          coord_length = (uncompressed.bytesize - 1) / 2
+          x = uncompressed[1, coord_length]
+          y = uncompressed[1 + coord_length, coord_length]
+
+          {
+            "kty" => "EC",
+            "crv" => crv,
+            "x" => Base64.urlsafe_encode64(x, padding: false),
+            "y" => Base64.urlsafe_encode64(y, padding: false)
+          }
+        end
+
+        sig { params(cek: String, enc: String, plaintext: String, aad: String).returns(T::Array[String]) }
+        def encrypt_content(cek, enc, plaintext, aad)
+          case enc
+          when "A128GCM", "A256GCM"
+            encrypt_gcm(cek, plaintext, aad, enc)
+          when "A128CBC-HS256", "A256CBC-HS512"
+            encrypt_cbc(cek, plaintext, aad, enc)
+          else
+            raise InvalidAlgorithm, "Unsupported enc: #{enc}"
+          end
+        end
+
+        sig { params(cek: String, plaintext: String, aad: String, enc: String).returns(T::Array[String]) }
+        def encrypt_gcm(cek, plaintext, aad, enc)
+          cipher = OpenSSL::Cipher.new(shared(:gcm_cipher_name, enc))
+          cipher.encrypt
+          cipher.key = cek
+          iv = cipher.random_iv
+          cipher.auth_data = aad
+          ciphertext = cipher.update(plaintext) + cipher.final
+          auth_tag = cipher.auth_tag
+          [iv, ciphertext, auth_tag]
+        end
+
+        sig { params(cek: String, plaintext: String, aad: String, enc: String).returns(T::Array[String]) }
+        def encrypt_cbc(cek, plaintext, aad, enc)
+          mac_key_len = cek.bytesize / 2
+          mac_key = cek[0, mac_key_len]
+          enc_key = cek[mac_key_len, mac_key_len]
+
+          cipher = OpenSSL::Cipher.new(shared(:cbc_cipher_name, enc))
+          cipher.encrypt
+          cipher.key = T.must(enc_key)
+          iv = cipher.random_iv
+          ciphertext = cipher.update(plaintext) + cipher.final
+
+          # Compute authentication tag (HMAC over AAD || IV || ciphertext || AL)
+          al = [aad.bytesize * 8].pack("Q>")
+          hmac_input = aad + iv + ciphertext + al
+          hmac = OpenSSL::HMAC.digest(shared(:cbc_hmac_digest, enc), T.must(mac_key), hmac_input)
+          tag_len = mac_key_len  # half of HMAC output
+          auth_tag = hmac[0, tag_len]
+
+          [iv, ciphertext, auth_tag]
+        end
+      end
+    end
+  end
+end

data/lib/standard_singpass/version.rb

@@ -1,3 +1,3 @@
 module StandardSingpass
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/standard_singpass.rb

@@ -3,4 +3,29 @@ require "standard_singpass/engine"
 require "standard_singpass/myinfo"
 
 module StandardSingpass
+  class << self
+    # Top-level entry points matching the sibling `standard_*` gems'
+    # `Gem.configure` / `Gem.config` convention. Singpass MyInfo is the only
+    # product the gem integrates today, so both delegate to
+    # `StandardSingpass::Myinfo` — `configure` goes through
+    # `Myinfo.configure` so the derived public-JWKS cache is still reset.
+    #
+    #   StandardSingpass.configure { |c| c.client_id = "..." }
+    #   StandardSingpass.config.client_id
+    def configure(&block)
+      Myinfo.configure(&block)
+      config
+    end
+
+    def config
+      Myinfo.configuration
+    end
+
+    # Deprecation warnings for the gem's own deprecated APIs. Registered
+    # with the host's `Rails.application.deprecators` by the engine, so the
+    # host's deprecation behaviour (log / raise / silence) applies.
+    def deprecator
+      @deprecator ||= ActiveSupport::Deprecation.new("0.5", "StandardSingpass")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: standard_singpass
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jaryl Sim
@@ -16,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -23,6 +26,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '8.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -30,6 +36,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -37,6 +46,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +56,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,6 +66,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: aes_key_wrap
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +158,7 @@ files:
 - lib/generators/standard_singpass/install/templates/initializer.rb.erb
 - lib/standard_singpass.rb
 - lib/standard_singpass/engine.rb
+- lib/standard_singpass/error.rb
 - lib/standard_singpass/myinfo.rb
 - lib/standard_singpass/myinfo/client.rb
 - lib/standard_singpass/myinfo/configuration.rb
@@ -152,6 +171,7 @@ files:
 - lib/standard_singpass/myinfo/person_data_parser.rb
 - lib/standard_singpass/myinfo/security.rb
 - lib/standard_singpass/myinfo/test_personas.rb
+- lib/standard_singpass/testing.rb
 - lib/standard_singpass/version.rb
 - lib/tasks/standard_singpass.rake
 homepage: https://github.com/rarebit-one/standard_singpass