feat: support more claims in password grant

go.mod

@@ -33,7 +33,7 @@ require (
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826
 	github.com/oleiade/reflections v1.0.1
 	github.com/ory/analytics-go/v5 v5.0.1
-	github.com/ory/fosite v0.47.0
+	github.com/ory/fosite v0.47.1-0.20241028135452-199f8ab66014
 	github.com/ory/go-acc v0.2.9-0.20230103102148-6b1c9a70dbbe
 	github.com/ory/graceful v0.1.3
 	github.com/ory/herodot v0.10.3-0.20230626083119-d7e5192f0d88
@@ -69,8 +69,6 @@ require (
 	golang.org/x/tools v0.23.0
 )
 
-require github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-
 require (
 	code.dny.dev/ssrf v0.2.0 // indirect
 	dario.cat/mergo v1.0.0 // indirect
@@ -147,6 +145,7 @@ require (
 	github.com/gorilla/websocket v1.5.0 // indirect
 	github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0 // indirect
+	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/huandu/xstrings v1.4.0 // indirect
 	github.com/imdario/mergo v0.3.16 // indirect

go.sum

@@ -387,8 +387,10 @@ github.com/ory/analytics-go/v5 v5.0.1 h1:LX8T5B9FN8KZXOtxgN+R3I4THRRVB6+28IKgKBp
 github.com/ory/analytics-go/v5 v5.0.1/go.mod h1:lWCiCjAaJkKfgR/BN5DCLMol8BjKS1x+4jxBxff/FF0=
 github.com/ory/dockertest/v3 v3.10.1-0.20240704115616-d229e74b748d h1:By96ZSVuH5LyjXLVVMfvJoLVGHaT96LdOnwgFSLVf0E=
 github.com/ory/dockertest/v3 v3.10.1-0.20240704115616-d229e74b748d/go.mod h1:F2FIjwwAk6CsNAs//B8+aPFQF0t84pbM8oliyNXwQrk=
-github.com/ory/fosite v0.47.0 h1:Iqu5uhx54JqZQPn2hRhqjESrmRRyQb00uJjfEi1a1QI=
-github.com/ory/fosite v0.47.0/go.mod h1:5U6c9nOLxyTdD/qrFv7N88TSxkdk5Wq8NzvB7UViDP0=
+github.com/ory/fosite v0.47.1-0.20241028132122-b35b62fed16e h1:aRhPoQt0QFrjQVrNDGiGQcT9cY/o8iqqBkMdoiyznjI=
+github.com/ory/fosite v0.47.1-0.20241028132122-b35b62fed16e/go.mod h1:5U6c9nOLxyTdD/qrFv7N88TSxkdk5Wq8NzvB7UViDP0=
+github.com/ory/fosite v0.47.1-0.20241028135452-199f8ab66014 h1:vtcEvjeArxH3CayG8Gn5y3mCzo1gibu74rZhvvveANE=
+github.com/ory/fosite v0.47.1-0.20241028135452-199f8ab66014/go.mod h1:5U6c9nOLxyTdD/qrFv7N88TSxkdk5Wq8NzvB7UViDP0=
 github.com/ory/go-acc v0.2.9-0.20230103102148-6b1c9a70dbbe h1:rvu4obdvqR0fkSIJ8IfgzKOWwZ5kOT2UNfLq81Qk7rc=
 github.com/ory/go-acc v0.2.9-0.20230103102148-6b1c9a70dbbe/go.mod h1:z4n3u6as84LbV4YmgjHhnwtccQqzf4cZlSk9f1FhygI=
 github.com/ory/go-convenience v0.1.0 h1:zouLKfF2GoSGnJwGq+PE/nJAE6dj2Zj5QlTgmMTsTS8=

internal/kratos/fake_kratos.go

@@ -7,6 +7,7 @@ import (
 	"context"
 
 	"github.com/ory/fosite"
+	client "github.com/ory/kratos-client-go"
 )
 
 type (
@@ -17,9 +18,10 @@ type (
 )
 
 const (
-	FakeSessionID = "fake-kratos-session-id"
-	FakeUsername  = "fake-kratos-username"
-	FakePassword  = "fake-kratos-password" // nolint: gosec
+	FakeSessionID  = "fake-kratos-session-id"
+	FakeUsername   = "fake-kratos-username"
+	FakePassword   = "fake-kratos-password" // nolint: gosec
+	FakeIdentityID = "fake-kratos-identity-id"
 )
 
 var _ Client = new(FakeKratos)
@@ -35,11 +37,11 @@ func (f *FakeKratos) DisableSession(_ context.Context, identityProviderSessionID
 	return nil
 }
 
-func (f *FakeKratos) Authenticate(_ context.Context, username, password string) error {
+func (f *FakeKratos) Authenticate(_ context.Context, username, password string) (*client.Session, error) {
 	if username == FakeUsername && password == FakePassword {
-		return nil
+		return &client.Session{Identity: &client.Identity{Id: FakeIdentityID}}, nil
 	}
-	return fosite.ErrNotFound
+	return nil, fosite.ErrNotFound
 }
 
 func (f *FakeKratos) Reset() {

internal/kratos/kratos.go

@@ -31,7 +31,7 @@ type (
 	}
 	Client interface {
 		DisableSession(ctx context.Context, identityProviderSessionID string) error
-		Authenticate(ctx context.Context, name, secret string) error
+		Authenticate(ctx context.Context, name, secret string) (*client.Session, error)
 	}
 	Default struct {
 		dependencies
@@ -42,7 +42,7 @@ func New(d dependencies) Client {
 	return &Default{dependencies: d}
 }
 
-func (k *Default) Authenticate(ctx context.Context, name, secret string) (err error) {
+func (k *Default) Authenticate(ctx context.Context, name, secret string) (session *client.Session, err error) {
 	ctx, span := k.Tracer(ctx).Tracer().Start(ctx, "kratos.Authenticate")
 	otelx.End(span, &err)
 
@@ -52,28 +52,28 @@ func (k *Default) Authenticate(ctx context.Context, name, secret string) (err er
 		span.SetAttributes(attribute.Bool("skipped", true))
 		span.SetAttributes(attribute.String("reason", "kratos public url not set"))
 
-		return errors.New("kratos public url not set")
+		return nil, errors.New("kratos public url not set")
 	}
 
 	kratos := k.newKratosClient(ctx, publicURL)
 
 	flow, _, err := kratos.FrontendAPI.CreateNativeLoginFlow(ctx).Execute()
 	if err != nil {
-		return err
+		return nil, err
 	}
 
-	_, _, err = kratos.FrontendAPI.UpdateLoginFlow(ctx).Flow(flow.Id).UpdateLoginFlowBody(client.UpdateLoginFlowBody{
+	res, _, err := kratos.FrontendAPI.UpdateLoginFlow(ctx).Flow(flow.Id).UpdateLoginFlowBody(client.UpdateLoginFlowBody{
 		UpdateLoginFlowWithPasswordMethod: &client.UpdateLoginFlowWithPasswordMethod{
 			Method:     "password",
 			Identifier: name,
 			Password:   secret,
 		},
 	}).Execute()
 	if err != nil {
-		return fosite.ErrNotFound.WithWrap(err)
+		return nil, fosite.ErrNotFound.WithWrap(err)
 	}
 
-	return nil
+	return &res.Session, nil
 }
 
 func (k *Default) DisableSession(ctx context.Context, identityProviderSessionID string) (err error) {

oauth2/.snapshots/TestHandlerWellKnown-hsm_enabled=false.json

@@ -63,7 +63,8 @@
   "require_request_uri_registration": true,
   "response_modes_supported": [
     "query",
-    "fragment"
+    "fragment",
+    "form_post"
   ],
   "response_types_supported": [
     "code",

oauth2/.snapshots/TestHandlerWellKnown-hsm_enabled=true.json

@@ -63,7 +63,8 @@
   "require_request_uri_registration": true,
   "response_modes_supported": [
     "query",
-    "fragment"
+    "fragment",
+    "form_post"
   ],
   "response_types_supported": [
     "code",

oauth2/handler.go

@@ -962,7 +962,8 @@ func (h *Handler) oauth2TokenExchange(w http.ResponseWriter, r *http.Request) {
 	}
 
 	if accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypeClientCredentials)) ||
-		accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypeJWTBearer)) {
+		accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypeJWTBearer)) ||
+		accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypePassword)) {
 		var accessTokenKeyID string
 		if h.c.AccessTokenStrategy(ctx, client.AccessTokenStrategySource(accessRequest.GetClient())) == "jwt" {
 			accessTokenKeyID, err = h.r.AccessTokenJWTStrategy().GetPublicKeyID(ctx)
@@ -975,9 +976,23 @@ func (h *Handler) oauth2TokenExchange(w http.ResponseWriter, r *http.Request) {
 		}
 
 		// only for client_credentials, otherwise Authentication is included in session
-		if accessRequest.GetGrantTypes().ExactOne("client_credentials") {
+		if accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypeClientCredentials)) {
 			session.Subject = accessRequest.GetClient().GetID()
 		}
+		// only for password grant, otherwise Authentication is included in session
+		if accessRequest.GetGrantTypes().ExactOne(string(fosite.GrantTypePassword)) {
+			if sess, ok := accessRequest.GetSession().(fosite.ExtraClaimsSession); ok {
+				sess.GetExtraClaims()["username"] = accessRequest.GetRequestForm().Get("username")
+				session.Subject = sess.GetExtraClaims()["identity_id"].(string)
+				delete(sess.GetExtraClaims(), "identity_id")
+				session.DefaultSession.Username = accessRequest.GetRequestForm().Get("username")
+			}
+
+			// Also add audience claims
+			for _, aud := range accessRequest.GetClient().GetAudience() {
+				accessRequest.GrantAudience(aud)
+			}
+		}
 		session.ClientID = accessRequest.GetClient().GetID()
 		session.KID = accessTokenKeyID
 		session.DefaultSession.Claims.Issuer = h.c.IssuerURL(ctx).String()

oauth2/oauth2_rop_test.go

@@ -5,20 +5,30 @@ package oauth2_test
 
 import (
 	"context"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
 	"testing"
+	"time"
 
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/oauth2"
 
 	"github.com/ory/fosite/compose"
+	"github.com/ory/fosite/token/jwt"
 	hydra "github.com/ory/hydra/v2/client"
+	"github.com/ory/hydra/v2/driver/config"
+	"github.com/ory/hydra/v2/flow"
 	"github.com/ory/hydra/v2/fositex"
 	"github.com/ory/hydra/v2/internal"
 	"github.com/ory/hydra/v2/internal/kratos"
 	"github.com/ory/hydra/v2/internal/testhelpers"
+	hydraoauth2 "github.com/ory/hydra/v2/oauth2"
+	"github.com/ory/hydra/v2/x"
 	"github.com/ory/x/contextx"
+	"github.com/ory/x/sqlxx"
 )
 
 func TestResourceOwnerPasswordGrant(t *testing.T) {
@@ -27,12 +37,19 @@ func TestResourceOwnerPasswordGrant(t *testing.T) {
 	reg := internal.NewMockedRegistry(t, &contextx.Default{})
 	reg.WithKratos(fakeKratos)
 	reg.WithExtraFositeFactories([]fositex.Factory{compose.OAuth2ResourceOwnerPasswordCredentialsFactory})
-	_, adminTS := testhelpers.NewOAuth2Server(ctx, t, reg)
+	publicTS, adminTS := testhelpers.NewOAuth2Server(ctx, t, reg)
 
 	secret := uuid.New().String()
+	audience := sqlxx.StringSliceJSONFormat{"https://aud.example.com"}
 	client := &hydra.Client{
 		Secret:     secret,
-		GrantTypes: []string{"password"},
+		GrantTypes: []string{"password", "refresh_token"},
+		Scope:      "offline",
+		Audience:   audience,
+		Lifespans: hydra.Lifespans{
+			PasswordGrantAccessTokenLifespan:  x.NullDuration{Duration: 1 * time.Hour, Valid: true},
+			PasswordGrantRefreshTokenLifespan: x.NullDuration{Duration: 1 * time.Hour, Valid: true},
+		},
 	}
 	require.NoError(t, reg.ClientManager().CreateClient(ctx, client))
 
@@ -44,15 +61,94 @@ func TestResourceOwnerPasswordGrant(t *testing.T) {
 			TokenURL:  reg.Config().OAuth2TokenURL(ctx).String(),
 			AuthStyle: oauth2.AuthStyleInHeader,
 		},
+		Scopes: []string{"offline"},
 	}
 
+	hs := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, r.Header.Get("Content-Type"), "application/json; charset=UTF-8")
+		assert.Equal(t, r.Header.Get("Authorization"), "Bearer secret value")
+
+		var hookReq hydraoauth2.TokenHookRequest
+		require.NoError(t, json.NewDecoder(r.Body).Decode(&hookReq))
+		assert.NotEmpty(t, hookReq.Session)
+		assert.NotEmpty(t, hookReq.Request)
+
+		claims := hookReq.Session.Extra
+		claims["hooked"] = true
+		if hookReq.Request.GrantTypes[0] == "refresh_token" {
+			claims["refreshed"] = true
+		}
+
+		hookResp := hydraoauth2.TokenHookResponse{
+			Session: flow.AcceptOAuth2ConsentRequestSession{
+				AccessToken: claims,
+				IDToken:     claims,
+			},
+		}
+
+		w.WriteHeader(http.StatusOK)
+		require.NoError(t, json.NewEncoder(w).Encode(&hookResp))
+	}))
+	defer hs.Close()
+
+	reg.Config().MustSet(ctx, config.KeyTokenHook, &config.HookConfig{
+		URL: hs.URL,
+		Auth: &config.Auth{
+			Type: "api_key",
+			Config: config.AuthConfig{
+				In:    "header",
+				Name:  "Authorization",
+				Value: "Bearer secret value",
+			},
+		},
+	})
+	reg.Config().MustSet(ctx, config.KeyAccessTokenStrategy, "jwt")
+
 	t.Run("case=get ROP grant token with valid username and password", func(t *testing.T) {
 		token, err := oauth2Config.PasswordCredentialsToken(ctx, kratos.FakeUsername, kratos.FakePassword)
 		require.NoError(t, err)
 		require.NotEmpty(t, token.AccessToken)
-		i := testhelpers.IntrospectToken(t, oauth2Config, token.AccessToken, adminTS)
-		assert.True(t, i.Get("active").Bool(), "%s", i)
-		assert.EqualValues(t, oauth2Config.ClientID, i.Get("client_id").String(), "%s", i)
+
+		// Access token should have hook and identity_id claims
+		jwtAT, err := jwt.Parse(token.AccessToken, func(token *jwt.Token) (interface{}, error) {
+			return reg.AccessTokenJWTStrategy().GetPublicKey(ctx)
+		})
+		require.NoError(t, err)
+		assert.Equal(t, kratos.FakeUsername, jwtAT.Claims["ext"].(map[string]any)["username"])
+		assert.Equal(t, kratos.FakeIdentityID, jwtAT.Claims["sub"])
+		assert.Equal(t, publicTS.URL, jwtAT.Claims["iss"])
+		assert.True(t, jwtAT.Claims["ext"].(map[string]any)["hooked"].(bool))
+		assert.ElementsMatch(t, audience, jwtAT.Claims["aud"])
+
+		t.Run("case=introspect token", func(t *testing.T) {
+			// Introspected token should have hook and identity_id claims
+			i := testhelpers.IntrospectToken(t, oauth2Config, token.AccessToken, adminTS)
+			assert.True(t, i.Get("active").Bool(), "%s", i)
+			assert.Equal(t, kratos.FakeUsername, i.Get("ext.username").String(), "%s", i)
+			assert.Equal(t, kratos.FakeIdentityID, i.Get("sub").String(), "%s", i)
+			assert.True(t, i.Get("ext.hooked").Bool(), "%s", i)
+			assert.EqualValues(t, oauth2Config.ClientID, i.Get("client_id").String(), "%s", i)
+		})
+
+		t.Run("case=refresh token", func(t *testing.T) {
+			// Refreshed access token should have hook and identity_id claims
+			require.NotEmpty(t, token.RefreshToken)
+			token.Expiry = token.Expiry.Add(-time.Hour * 24)
+			refreshedToken, err := oauth2Config.TokenSource(context.Background(), token).Token()
+			require.NoError(t, err)
+
+			require.NotEqual(t, token.AccessToken, refreshedToken.AccessToken)
+			require.NotEqual(t, token.RefreshToken, refreshedToken.RefreshToken)
+
+			jwtAT, err := jwt.Parse(refreshedToken.AccessToken, func(token *jwt.Token) (interface{}, error) {
+				return reg.AccessTokenJWTStrategy().GetPublicKey(ctx)
+			})
+			require.NoError(t, err)
+			assert.Equal(t, kratos.FakeIdentityID, jwtAT.Claims["sub"])
+			assert.Equal(t, kratos.FakeUsername, jwtAT.Claims["ext"].(map[string]any)["username"])
+			assert.True(t, jwtAT.Claims["ext"].(map[string]any)["hooked"].(bool))
+			assert.True(t, jwtAT.Claims["ext"].(map[string]any)["refreshed"].(bool))
+		})
 	})
 
 	t.Run("case=access denied for invalid password", func(t *testing.T) {

oauth2/session.go

@@ -194,3 +194,17 @@ func (s *Session) UnmarshalJSON(original []byte) (err error) {
 
 	return nil
 }
+
+// GetExtraClaims implements ExtraClaimsSession for Session.
+// The returned value can be modified in-place.
+func (s *Session) GetExtraClaims() map[string]interface{} {
+	if s == nil {
+		return nil
+	}
+
+	if s.Extra == nil {
+		s.Extra = make(map[string]interface{})
+	}
+
+	return s.Extra
+}

persistence/sql/persister_authenticate.go

@@ -3,8 +3,14 @@
 
 package sql
 
-import "context"
+import (
+	"context"
+)
 
-func (p *Persister) Authenticate(ctx context.Context, name, secret string) error {
-	return p.r.Kratos().Authenticate(ctx, name, secret)
+func (p *Persister) Authenticate(ctx context.Context, name, secret string) (string, error) {
+	session, err := p.r.Kratos().Authenticate(ctx, name, secret)
+	if err != nil {
+		return "", err
+	}
+	return session.Identity.Id, nil
 }