rodauth-oauth 0.10.4 → 1.0.0.pre.beta1

data/lib/rodauth/features/oauth_jwt_base.rb

@@ -0,0 +1,435 @@
+# frozen_string_literal: true
+
+require "rodauth/oauth"
+require "rodauth/oauth/http_extensions"
+
+module Rodauth
+  Feature.define(:oauth_jwt_base, :OauthJwtBase) do
+    depends :oauth_base
+
+    auth_value_method :oauth_application_jwt_public_key_param, "jwt_public_key"
+    auth_value_method :oauth_application_jwks_param, "jwks"
+
+    auth_value_method :oauth_jwt_keys, {}
+    auth_value_method :oauth_jwt_public_keys, {}
+
+    auth_value_method :oauth_jwt_jwe_keys, {}
+    auth_value_method :oauth_jwt_jwe_public_keys, {}
+
+    auth_value_method :oauth_jwt_jwe_copyright, nil
+
+    auth_value_methods(
+      :jwt_encode,
+      :jwt_decode,
+      :jwt_decode_no_key,
+      :generate_jti,
+      :oauth_jwt_issuer,
+      :oauth_jwt_audience
+    )
+
+    private
+
+    def oauth_jwt_issuer
+      # The JWT MUST contain an "iss" (issuer) claim that contains a
+      # unique identifier for the entity that issued the JWT.
+      @oauth_jwt_issuer ||= authorization_server_url
+    end
+
+    def oauth_jwt_audience
+      # The JWT MUST contain an "aud" (audience) claim containing a
+      # value that identifies the authorization server as an intended
+      # audience.  The token endpoint URL of the authorization server
+      # MAY be used as a value for an "aud" element to identify the
+      # authorization server as an intended audience of the JWT.
+      @oauth_jwt_audience ||= if is_authorization_server?
+                                oauth_application[oauth_applications_client_id_column]
+                              else
+                                metadata = authorization_server_metadata
+
+                                return unless metadata
+
+                                metadata[:token_endpoint]
+                              end
+    end
+
+    def grant_from_application?(grant_or_claims, oauth_application)
+      return super if grant_or_claims[oauth_grants_id_column]
+
+      if grant_or_claims["client_id"]
+        grant_or_claims["client_id"] == oauth_application[oauth_applications_client_id_column]
+      else
+        Array(grant_or_claims["aud"]).include?(oauth_application[oauth_applications_client_id_column])
+      end
+    end
+
+    def jwt_subject(oauth_grant, client_application = oauth_application)
+      oauth_grant[oauth_grants_account_id_column] || client_application[oauth_applications_client_id_column]
+    end
+
+    def oauth_server_metadata_body(path = nil)
+      metadata = super
+      metadata.merge! \
+        token_endpoint_auth_signing_alg_values_supported: oauth_jwt_keys.keys.uniq
+      metadata
+    end
+
+    def _jwt_key
+      @_jwt_key ||= (oauth_application_jwks(oauth_application) if oauth_application)
+    end
+
+    def _jwt_public_key
+      @_jwt_public_key ||= if oauth_application
+                             oauth_application_jwks(oauth_application)
+                           else
+                             _jwt_key
+                           end
+    end
+
+    # Resource Server only!
+    #
+    # returns the jwks set from the authorization server.
+    def auth_server_jwks_set
+      metadata = authorization_server_metadata
+
+      return unless metadata && (jwks_uri = metadata[:jwks_uri])
+
+      jwks_uri = URI(jwks_uri)
+
+      http_request_with_cache(jwks_uri)
+    end
+
+    def generate_jti(payload)
+      # Use the key and iat to create a unique key per request to prevent replay attacks
+      jti_raw = [
+        payload[:aud] || payload["aud"],
+        payload[:iat] || payload["iat"]
+      ].join(":").to_s
+      Digest::SHA256.hexdigest(jti_raw)
+    end
+
+    def verify_jti(jti, claims)
+      generate_jti(claims) == jti
+    end
+
+    def verify_aud(expected_aud, aud)
+      expected_aud == aud
+    end
+
+    def oauth_application_jwks(oauth_application)
+      jwks = oauth_application[oauth_applications_jwks_column]
+
+      if jwks
+        jwks = JSON.parse(jwks, symbolize_names: true) if jwks.is_a?(String)
+        return jwks
+      end
+
+      jwks_uri = oauth_application[oauth_applications_jwks_uri_column]
+
+      return unless jwks_uri
+
+      jwks_uri = URI(jwks_uri)
+
+      http_request_with_cache(jwks_uri)
+    end
+
+    if defined?(JSON::JWT)
+      # json-jwt
+
+      auth_value_method :oauth_jwt_jws_algorithms_supported, %w[
+        HS256 HS384 HS512
+        RS256 RS384 RS512
+        PS256 PS384 PS512
+        ES256 ES384 ES512 ES256K
+      ]
+      auth_value_method :oauth_jwt_jwe_algorithms_supported, %w[
+        RSA1_5 RSA-OAEP dir A128KW A256KW
+      ]
+      auth_value_method :oauth_jwt_jwe_encryption_methods_supported, %w[
+        A128GCM A256GCM A128CBC-HS256 A256CBC-HS512
+      ]
+
+      def jwk_export(key)
+        JSON::JWK.new(key)
+      end
+
+      def jwt_encode(payload,
+                     jwks: nil,
+                     encryption_algorithm: oauth_jwt_jwe_keys.keys.dig(0, 0),
+                     encryption_method: oauth_jwt_jwe_keys.keys.dig(0, 1),
+                     jwe_key: oauth_jwt_jwe_keys[[encryption_algorithm,
+                                                  encryption_method]],
+                     signing_algorithm: oauth_jwt_keys.keys.first)
+        payload[:jti] = generate_jti(payload)
+        jwt = JSON::JWT.new(payload)
+
+        key = oauth_jwt_keys[signing_algorithm] || _jwt_key
+        key = key.first if key.is_a?(Array)
+
+        jwk = JSON::JWK.new(key || "")
+
+        jwt = jwt.sign(jwk, signing_algorithm)
+        jwt.kid = jwk.thumbprint
+
+        if jwks && (jwk = jwks.find { |k| k[:use] == "enc" && k[:alg] == encryption_algorithm && k[:enc] == encryption_method })
+          jwk = JSON::JWK.new(jwk)
+          jwe = jwt.encrypt(jwk, encryption_algorithm.to_sym, encryption_method.to_sym)
+          jwe.to_s
+        elsif jwe_key
+          jwe_key = jwe_key.first if jwe_key.is_a?(Array)
+          algorithm = encryption_algorithm.to_sym if encryption_algorithm
+          meth = encryption_method.to_sym if encryption_method
+          jwt.encrypt(jwe_key, algorithm, meth)
+        else
+          jwt.to_s
+        end
+      end
+
+      def jwt_decode(
+        token,
+        jwks: nil,
+        jws_algorithm: oauth_jwt_public_keys.keys.first || oauth_jwt_keys.keys.first,
+        jws_key: oauth_jwt_keys[jws_algorithm] || _jwt_key,
+        jws_encryption_algorithm: oauth_jwt_jwe_keys.keys.dig(0, 0),
+        jws_encryption_method: oauth_jwt_jwe_keys.keys.dig(0, 1),
+        jwe_key: oauth_jwt_jwe_keys[[jws_encryption_algorithm, jws_encryption_method]] || oauth_jwt_jwe_keys.values.first,
+        verify_claims: true,
+        verify_jti: true,
+        verify_iss: true,
+        verify_aud: true,
+        **
+      )
+        jws_key = jws_key.first if jws_key.is_a?(Array)
+
+        if jwe_key
+          jwe_key = jwe_key.first if jwe_key.is_a?(Array)
+          token = JSON::JWT.decode(token, jwe_key).plain_text
+        end
+
+        claims = if is_authorization_server?
+                   if jwks
+                     enc_algs = [jws_encryption_algorithm].compact
+                     enc_meths = [jws_encryption_method].compact
+
+                     sig_algs = jws_algorithm ? [jws_algorithm] : jwks.select { |k| k[:use] == "sig" }.map { |k| k[:alg] }
+                     sig_algs = sig_algs.compact.map(&:to_sym)
+
+                     jws = JSON::JWT.decode(token, JSON::JWK::Set.new({ keys: jwks }), enc_algs + sig_algs, enc_meths)
+                     jws = JSON::JWT.decode(jws.plain_text, JSON::JWK::Set.new({ keys: jwks }), sig_algs) if jws.is_a?(JSON::JWE)
+                     jws
+                   elsif jws_key
+                     JSON::JWT.decode(token, jws_key)
+                   end
+                 elsif (jwks = auth_server_jwks_set)
+                   JSON::JWT.decode(token, JSON::JWK::Set.new(jwks))
+                 end
+
+        now = Time.now
+        if verify_claims && (
+            (!claims[:exp] || Time.at(claims[:exp]) < now) &&
+            (claims[:nbf] && Time.at(claims[:nbf]) < now) &&
+            (claims[:iat] && Time.at(claims[:iat]) < now) &&
+            (verify_iss && claims[:iss] != oauth_jwt_issuer) &&
+            (verify_aud && !verify_aud(claims[:aud], claims[:client_id])) &&
+            (verify_jti && !verify_jti(claims[:jti], claims))
+          )
+          return
+        end
+
+        claims
+      rescue JSON::JWT::Exception
+        nil
+      end
+
+      def jwt_decode_no_key(token)
+        jws = JSON::JWT.decode(token, :skip_verification)
+        [jws.to_h, jws.header]
+      end
+    elsif defined?(JWT)
+      # ruby-jwt
+      require "rodauth/oauth/jwe_extensions" if defined?(JWE)
+
+      auth_value_method :oauth_jwt_jws_algorithms_supported, %w[
+        HS256 HS384 HS512 HS512256
+        RS256 RS384 RS512
+        ED25519
+        ES256 ES384 ES512
+        PS256 PS384 PS512
+      ]
+
+      if defined?(JWE)
+        auth_value_methods(
+          :oauth_jwt_jwe_algorithms_supported,
+          :oauth_jwt_jwe_encryption_methods_supported
+        )
+
+        def oauth_jwt_jwe_algorithms_supported
+          JWE::VALID_ALG
+        end
+
+        def oauth_jwt_jwe_encryption_methods_supported
+          JWE::VALID_ENC
+        end
+      else
+        auth_value_method :oauth_jwt_jwe_algorithms_supported, []
+        auth_value_method :oauth_jwt_jwe_encryption_methods_supported, []
+      end
+
+      def jwk_export(key)
+        JWT::JWK.new(key).export
+      end
+
+      def jwt_encode(payload,
+                     signing_algorithm: oauth_jwt_keys.keys.first)
+        headers = {}
+
+        key = oauth_jwt_keys[signing_algorithm] || _jwt_key
+        key = key.first if key.is_a?(Array)
+
+        case key
+        when OpenSSL::PKey::PKey
+          jwk = JWT::JWK.new(key)
+          headers[:kid] = jwk.kid
+
+          key = jwk.keypair
+        end
+
+        # @see JWT reserved claims - https://tools.ietf.org/html/draft-jones-json-web-token-07#page-7
+        payload[:jti] = generate_jti(payload)
+        JWT.encode(payload, key, signing_algorithm, headers)
+      end
+
+      if defined?(JWE)
+        def jwt_encode_with_jwe(
+          payload,
+          jwks: nil,
+          encryption_algorithm: oauth_jwt_jwe_keys.keys.dig(0, 0),
+          encryption_method: oauth_jwt_jwe_keys.keys.dig(0, 1),
+          jwe_key: oauth_jwt_jwe_keys[[encryption_algorithm, encryption_method]],
+          **args
+        )
+          token = jwt_encode_without_jwe(payload, **args)
+
+          return token unless encryption_algorithm && encryption_method
+
+          if jwks && jwks.any? { |k| k[:use] == "enc" }
+            JWE.__rodauth_oauth_encrypt_from_jwks(token, jwks, alg: encryption_algorithm, enc: encryption_method)
+          elsif jwe_key
+            jwe_key = jwe_key.first if jwe_key.is_a?(Array)
+            params = {
+              zip: "DEF",
+              copyright: oauth_jwt_jwe_copyright
+            }
+            params[:enc] = encryption_method if encryption_method
+            params[:alg] = encryption_algorithm if encryption_algorithm
+            JWE.encrypt(token, jwe_key, **params)
+          else
+            token
+          end
+        end
+
+        alias_method :jwt_encode_without_jwe, :jwt_encode
+        alias_method :jwt_encode, :jwt_encode_with_jwe
+      end
+
+      def jwt_decode(
+        token,
+        jwks: nil,
+        jws_algorithm: oauth_jwt_public_keys.keys.first || oauth_jwt_keys.keys.first,
+        jws_key: oauth_jwt_keys[jws_algorithm] || _jwt_key,
+        verify_claims: true,
+        verify_jti: true,
+        verify_iss: true,
+        verify_aud: true
+      )
+        jws_key = jws_key.first if jws_key.is_a?(Array)
+
+        # verifying the JWT implies verifying:
+        #
+        # issuer: check that server generated the token
+        # aud: check the audience field (client is who he says he is)
+        # iat: check that the token didn't expire
+        #
+        # subject can't be verified automatically without having access to the account id,
+        # which we don't because that's the whole point.
+        #
+        verify_claims_params = if verify_claims
+                                 {
+                                   verify_iss: verify_iss,
+                                   iss: oauth_jwt_issuer,
+                                   # can't use stock aud verification, as it's dependent on the client application id
+                                   verify_aud: false,
+                                   verify_jti: (verify_jti ? method(:verify_jti) : false),
+                                   verify_iat: true
+                                 }
+                               else
+                                 {}
+                               end
+
+        # decode jwt
+        claims = if is_authorization_server?
+                   if jwks
+                     algorithms = jws_algorithm ? [jws_algorithm] : jwks.select { |k| k[:use] == "sig" }.map { |k| k[:alg] }
+                     JWT.decode(token, nil, true, algorithms: algorithms, jwks: { keys: jwks }, **verify_claims_params).first
+                   elsif jws_key
+                     JWT.decode(token, jws_key, true, algorithms: [jws_algorithm], **verify_claims_params).first
+                   end
+                 elsif (jwks = auth_server_jwks_set)
+                   algorithms = jwks[:keys].select { |k| k[:use] == "sig" }.map { |k| k[:alg] }
+                   JWT.decode(token, nil, true, jwks: jwks, algorithms: algorithms, **verify_claims_params).first
+                 end
+
+        return if verify_claims && verify_aud && !verify_aud(claims["aud"], claims["client_id"])
+
+        claims
+      rescue JWT::DecodeError, JWT::JWKError
+        nil
+      end
+
+      if defined?(JWE)
+        def jwt_decode_with_jwe(
+          token,
+          jwks: nil,
+          jws_encryption_algorithm: oauth_jwt_jwe_keys.keys.dig(0, 0),
+          jws_encryption_method: oauth_jwt_jwe_keys.keys.dig(0, 1),
+          jwe_key: oauth_jwt_jwe_keys[[jws_encryption_algorithm, jws_encryption_method]] || oauth_jwt_jwe_keys.values.first,
+          **args
+        )
+
+          token = if jwks && jwks.any? { |k| k[:use] == "enc" }
+                    JWE.__rodauth_oauth_decrypt_from_jwks(token, jwks, alg: jws_encryption_algorithm, enc: jws_encryption_method)
+                  elsif jwe_key
+                    jwe_key = jwe_key.first if jwe_key.is_a?(Array)
+                    JWE.decrypt(token, jwe_key)
+                  else
+                    token
+                  end
+
+          jwt_decode_without_jwe(token, jwks: jwks, **args)
+        rescue JWE::DecodeError => e
+          jwt_decode_without_jwe(token, jwks: jwks, **args) if e.message.include?("Not enough or too many segments")
+        end
+
+        alias_method :jwt_decode_without_jwe, :jwt_decode
+        alias_method :jwt_decode, :jwt_decode_with_jwe
+      end
+
+      def jwt_decode_no_key(token)
+        JWT.decode(token, nil, false)
+      end
+    else
+      # :nocov:
+      def jwk_export(_key)
+        raise "#{__method__} is undefined, redefine it or require either \"jwt\" or \"json-jwt\""
+      end
+
+      def jwt_encode(_token)
+        raise "#{__method__} is undefined, redefine it or require either \"jwt\" or \"json-jwt\""
+      end
+
+      def jwt_decode(_token, **)
+        raise "#{__method__} is undefined, redefine it or require either \"jwt\" or \"json-jwt\""
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/rodauth/features/oauth_jwt_bearer_grant.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "rodauth/oauth/version"
-require "rodauth/oauth/ttl_store"
+require "rodauth/oauth"
 
 module Rodauth
   Feature.define(:oauth_jwt_bearer_grant, :OauthJwtBearerGrant) do
@@ -13,6 +12,18 @@ module Rodauth
       :account_from_jwt_bearer_assertion
     )
 
+    def oauth_token_endpoint_auth_methods_supported
+      if oauth_applications_client_secret_hash_column.nil?
+        super | %w[client_secret_jwt private_key_jwt urn:ietf:params:oauth:client-assertion-type:jwt-bearer]
+      else
+        super | %w[private_key_jwt]
+      end
+    end
+
+    def oauth_grant_types_supported
+      super | %w[urn:ietf:params:oauth:grant-type:jwt-bearer]
+    end
+
     private
 
     def require_oauth_application_from_jwt_bearer_assertion_issuer(assertion)
@@ -26,13 +37,37 @@ module Rodauth
     end
 
     def require_oauth_application_from_jwt_bearer_assertion_subject(assertion)
-      claims = jwt_assertion(assertion)
+      claims, header = jwt_decode_no_key(assertion)
+
+      client_id = claims["sub"]
+
+      case header["alg"]
+      when "none"
+        # do not accept jwts with no alg set
+        authorization_required
+      when /\AHS/
+        require_oauth_application_from_client_secret_jwt(client_id, assertion, header["alg"])
+      else
+        require_oauth_application_from_private_key_jwt(client_id, assertion)
+      end
+    end
 
-      return unless claims
+    def require_oauth_application_from_client_secret_jwt(client_id, assertion, alg)
+      oauth_application = db[oauth_applications_table].where(oauth_applications_client_id_column => client_id).first
+      authorization_required unless supports_auth_method?(oauth_application, "client_secret_jwt")
+      client_secret = oauth_application[oauth_applications_client_secret_column]
+      claims = jwt_assertion(assertion, jws_key: client_secret, jws_algorithm: alg)
+      authorization_required unless claims && claims["iss"] == client_id
+      oauth_application
+    end
 
-      db[oauth_applications_table].where(
-        oauth_applications_client_id_column => claims["sub"]
-      ).first
+    def require_oauth_application_from_private_key_jwt(client_id, assertion)
+      oauth_application = db[oauth_applications_table].where(oauth_applications_client_id_column => client_id).first
+      authorization_required unless supports_auth_method?(oauth_application, "private_key_jwt")
+      jwks = oauth_application_jwks(oauth_application)
+      claims = jwt_assertion(assertion, jwks: jwks)
+      authorization_required unless claims
+      oauth_application
     end
 
     def account_from_jwt_bearer_assertion(assertion)
@@ -43,18 +78,11 @@ module Rodauth
       account_from_bearer_assertion_subject(claims["sub"])
     end
 
-    def jwt_assertion(assertion)
-      claims = jwt_decode(assertion, verify_iss: false, verify_aud: false)
-      return unless verify_aud(token_url, claims["aud"])
+    def jwt_assertion(assertion, **kwargs)
+      claims = jwt_decode(assertion, verify_iss: false, verify_aud: false, **kwargs)
+      return unless verify_aud(request.url, claims["aud"])
 
       claims
     end
-
-    def oauth_server_metadata_body(*)
-      super.tap do |data|
-        data[:grant_types_supported] << "urn:ietf:params:oauth:grant-type:jwt-bearer"
-        data[:token_endpoint_auth_methods_supported] << "urn:ietf:params:oauth:client-assertion-type:jwt-bearer"
-      end
-    end
   end
 end

data/lib/rodauth/features/oauth_jwt_jwks.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rodauth/oauth"
+require "rodauth/oauth/http_extensions"
+
+module Rodauth
+  Feature.define(:oauth_jwt_jwks, :OauthJwtJwks) do
+    depends :oauth_jwt_base
+
+    auth_value_methods(:jwks_set)
+
+    auth_server_route(:jwks) do |r|
+      before_jwks_route
+
+      r.get do
+        json_response_success({ keys: jwks_set }, true)
+      end
+    end
+
+    private
+
+    def oauth_server_metadata_body(path = nil)
+      metadata = super
+      metadata.merge!(jwks_uri: jwks_url)
+      metadata
+    end
+
+    def jwks_set
+      @jwks_set ||= [
+        *(
+          unless oauth_jwt_public_keys.empty?
+            oauth_jwt_public_keys.flat_map { |algo, pkeys| Array(pkeys).map { |pkey| jwk_export(pkey).merge(use: "sig", alg: algo) } }
+          end
+        ),
+        *(
+          unless oauth_jwt_jwe_public_keys.empty?
+            oauth_jwt_jwe_public_keys.flat_map do |(algo, _enc), pkeys|
+              Array(pkeys).map do |pkey|
+                jwk_export(pkey).merge(use: "enc", alg: algo)
+              end
+            end
+          end
+        )
+      ].compact
+    end
+  end
+end

data/lib/rodauth/features/oauth_jwt_secured_authorization_request.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rodauth/oauth"
+
+module Rodauth
+  Feature.define(:oauth_jwt_secured_authorization_request, :OauthJwtSecuredAuthorizationRequest) do
+    depends :oauth_authorize_base, :oauth_jwt_base
+
+    auth_value_method :oauth_applications_request_object_signing_alg_column, :request_object_signing_alg
+    auth_value_method :oauth_applications_request_object_encryption_alg_column, :request_object_encryption_alg
+    auth_value_method :oauth_applications_request_object_encryption_enc_column, :request_object_encryption_enc
+
+    translatable_method :oauth_request_uri_not_supported_message, "request uri is unsupported"
+    translatable_method :oauth_invalid_request_object_message, "request object is invalid"
+
+    private
+
+    # /authorize
+
+    def validate_authorize_params
+      # TODO: add support for requst_uri
+      redirect_response_error("request_uri_not_supported") if param_or_nil("request_uri")
+
+      request_object = param_or_nil("request")
+
+      return super unless request_object && oauth_application
+
+      if (jwks = oauth_application_jwks(oauth_application))
+        jwks = JSON.parse(jwks, symbolize_names: true) if jwks.is_a?(String)
+      else
+        redirect_response_error("invalid_request_object")
+      end
+
+      request_sig_enc_opts = {
+        jws_algorithm: oauth_application[oauth_applications_request_object_signing_alg_column],
+        jws_encryption_algorithm: oauth_application[oauth_applications_request_object_encryption_alg_column],
+        jws_encryption_method: oauth_application[oauth_applications_request_object_encryption_enc_column]
+      }.compact
+
+      claims = jwt_decode(request_object, jwks: jwks, verify_jti: false, verify_aud: false, **request_sig_enc_opts)
+
+      redirect_response_error("invalid_request_object") unless claims
+
+      # If signed, the Authorization Request
+      # Object SHOULD contain the Claims "iss" (issuer) and "aud" (audience)
+      # as members, with their semantics being the same as defined in the JWT
+      # [RFC7519] specification.  The value of "aud" should be the value of
+      # the Authorization Server (AS) "issuer" as defined in RFC8414
+      # [RFC8414].
+      claims.delete("iss")
+      audience = claims.delete("aud")
+
+      redirect_response_error("invalid_request_object") if audience && audience != oauth_jwt_issuer
+
+      claims.each do |k, v|
+        request.params[k.to_s] = v
+      end
+
+      super
+    end
+  end
+end

data/lib/rodauth/features/oauth_management_base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rodauth/oauth"
+
 module Rodauth
   Feature.define(:oauth_management_base, :OauthManagementBase) do
     depends :oauth_authorize_base