mirror of https://github.com/go-gitea/gitea
allow synchronizing user status from OAuth2 login providers (#31572)
This leverages the existing `sync_external_users` cron job to synchronize the `IsActive` flag on users who use an OAuth2 provider set to synchronize. This synchronization is done by checking for expired access tokens, and using the stored refresh token to request a new access token. If the response back from the OAuth2 provider is the `invalid_grant` error code, the user is marked as inactive. However, the user is able to reactivate their account by logging in the web browser through their OAuth2 flow. Also changed to support this is that a linked `ExternalLoginUser` is always created upon a login or signup via OAuth2. ### Notes on updating permissions Ideally, we would also refresh permissions from the configured OAuth provider (e.g., admin, restricted and group mappings) to match the implementation of LDAP. However, the OAuth library used for this `goth`, doesn't seem to support issuing a session via refresh tokens. The interface provides a [`RefreshToken` method](https://github.com/markbates/goth/blob/master/provider.go#L20), but the returned `oauth.Token` doesn't implement the `goth.Session` we would need to call `FetchUser`. Due to specific implementations, we would need to build a compatibility function for every provider, since they cast to concrete types (e.g. [Azure](https://github.com/markbates/goth/blob/master/providers/azureadv2/azureadv2.go#L132)) --------- Co-authored-by: Kyle D <kdumontnu@gmail.com>pull/31637/head^2
Rowan Bohde
4 months ago
committed by
GitHub
parent
3a7454df7a
commit
416c36f303
@ -0,0 +1,14 @@ |
||||
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package oauth2 |
||||
|
||||
import ( |
||||
"testing" |
||||
|
||||
"code.gitea.io/gitea/models/unittest" |
||||
) |
||||
|
||||
func TestMain(m *testing.M) { |
||||
unittest.MainTest(m, &unittest.TestOptions{}) |
||||
} |
||||
@ -0,0 +1,62 @@ |
||||
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package oauth2 |
||||
|
||||
import ( |
||||
"time" |
||||
|
||||
"github.com/markbates/goth" |
||||
"golang.org/x/oauth2" |
||||
) |
||||
|
||||
type fakeProvider struct{} |
||||
|
||||
func (p *fakeProvider) Name() string { |
||||
return "fake" |
||||
} |
||||
|
||||
func (p *fakeProvider) SetName(name string) {} |
||||
|
||||
func (p *fakeProvider) BeginAuth(state string) (goth.Session, error) { |
||||
return nil, nil |
||||
} |
||||
|
||||
func (p *fakeProvider) UnmarshalSession(string) (goth.Session, error) { |
||||
return nil, nil |
||||
} |
||||
|
||||
func (p *fakeProvider) FetchUser(goth.Session) (goth.User, error) { |
||||
return goth.User{}, nil |
||||
} |
||||
|
||||
func (p *fakeProvider) Debug(bool) { |
||||
} |
||||
|
||||
func (p *fakeProvider) RefreshToken(refreshToken string) (*oauth2.Token, error) { |
||||
switch refreshToken { |
||||
case "expired": |
||||
return nil, &oauth2.RetrieveError{ |
||||
ErrorCode: "invalid_grant", |
||||
} |
||||
default: |
||||
return &oauth2.Token{ |
||||
AccessToken: "token", |
||||
TokenType: "Bearer", |
||||
RefreshToken: "refresh", |
||||
Expiry: time.Now().Add(time.Hour), |
||||
}, nil |
||||
} |
||||
} |
||||
|
||||
func (p *fakeProvider) RefreshTokenAvailable() bool { |
||||
return true |
||||
} |
||||
|
||||
func init() { |
||||
RegisterGothProvider( |
||||
NewSimpleProvider("fake", "Fake", []string{"account"}, |
||||
func(clientKey, secret, callbackURL string, scopes ...string) goth.Provider { |
||||
return &fakeProvider{} |
||||
})) |
||||
} |
||||
@ -0,0 +1,114 @@ |
||||
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package oauth2 |
||||
|
||||
import ( |
||||
"context" |
||||
"time" |
||||
|
||||
"code.gitea.io/gitea/models/auth" |
||||
"code.gitea.io/gitea/models/db" |
||||
user_model "code.gitea.io/gitea/models/user" |
||||
"code.gitea.io/gitea/modules/log" |
||||
|
||||
"github.com/markbates/goth" |
||||
"golang.org/x/oauth2" |
||||
) |
||||
|
||||
// Sync causes this OAuth2 source to synchronize its users with the db.
|
||||
func (source *Source) Sync(ctx context.Context, updateExisting bool) error { |
||||
log.Trace("Doing: SyncExternalUsers[%s] %d", source.authSource.Name, source.authSource.ID) |
||||
|
||||
if !updateExisting { |
||||
log.Info("SyncExternalUsers[%s] not running since updateExisting is false", source.authSource.Name) |
||||
return nil |
||||
} |
||||
|
||||
provider, err := createProvider(source.authSource.Name, source) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
if !provider.RefreshTokenAvailable() { |
||||
log.Trace("SyncExternalUsers[%s] provider doesn't support refresh tokens, can't synchronize", source.authSource.Name) |
||||
return nil |
||||
} |
||||
|
||||
opts := user_model.FindExternalUserOptions{ |
||||
HasRefreshToken: true, |
||||
Expired: true, |
||||
LoginSourceID: source.authSource.ID, |
||||
} |
||||
|
||||
return user_model.IterateExternalLogin(ctx, opts, func(ctx context.Context, u *user_model.ExternalLoginUser) error { |
||||
return source.refresh(ctx, provider, u) |
||||
}) |
||||
} |
||||
|
||||
func (source *Source) refresh(ctx context.Context, provider goth.Provider, u *user_model.ExternalLoginUser) error { |
||||
log.Trace("Syncing login_source_id=%d external_id=%s expiration=%s", u.LoginSourceID, u.ExternalID, u.ExpiresAt) |
||||
|
||||
shouldDisable := false |
||||
|
||||
token, err := provider.RefreshToken(u.RefreshToken) |
||||
if err != nil { |
||||
if err, ok := err.(*oauth2.RetrieveError); ok && err.ErrorCode == "invalid_grant" { |
||||
// this signals that the token is not valid and the user should be disabled
|
||||
shouldDisable = true |
||||
} else { |
||||
return err |
||||
} |
||||
} |
||||
|
||||
user := &user_model.User{ |
||||
LoginName: u.ExternalID, |
||||
LoginType: auth.OAuth2, |
||||
LoginSource: u.LoginSourceID, |
||||
} |
||||
|
||||
hasUser, err := user_model.GetUser(ctx, user) |
||||
if err != nil { |
||||
return err |
||||
} |
||||
|
||||
// If the grant is no longer valid, disable the user and
|
||||
// delete local tokens. If the OAuth2 provider still
|
||||
// recognizes them as a valid user, they will be able to login
|
||||
// via their provider and reactivate their account.
|
||||
if shouldDisable { |
||||
log.Info("SyncExternalUsers[%s] disabling user %d", source.authSource.Name, user.ID) |
||||
|
||||
return db.WithTx(ctx, func(ctx context.Context) error { |
||||
if hasUser { |
||||
user.IsActive = false |
||||
err := user_model.UpdateUserCols(ctx, user, "is_active") |
||||
if err != nil { |
||||
return err |
||||
} |
||||
} |
||||
|
||||
// Delete stored tokens, since they are invalid. This
|
||||
// also provents us from checking this in subsequent runs.
|
||||
u.AccessToken = "" |
||||
u.RefreshToken = "" |
||||
u.ExpiresAt = time.Time{} |
||||
|
||||
return user_model.UpdateExternalUserByExternalID(ctx, u) |
||||
}) |
||||
} |
||||
|
||||
// Otherwise, update the tokens
|
||||
u.AccessToken = token.AccessToken |
||||
u.ExpiresAt = token.Expiry |
||||
|
||||
// Some providers only update access tokens provide a new
|
||||
// refresh token, so avoid updating it if it's empty
|
||||
if token.RefreshToken != "" { |
||||
u.RefreshToken = token.RefreshToken |
||||
} |
||||
|
||||
err = user_model.UpdateExternalUserByExternalID(ctx, u) |
||||
|
||||
return err |
||||
} |
||||
@ -0,0 +1,100 @@ |
||||
// Copyright 2024 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package oauth2 |
||||
|
||||
import ( |
||||
"context" |
||||
"testing" |
||||
|
||||
"code.gitea.io/gitea/models/auth" |
||||
"code.gitea.io/gitea/models/unittest" |
||||
user_model "code.gitea.io/gitea/models/user" |
||||
|
||||
"github.com/stretchr/testify/assert" |
||||
) |
||||
|
||||
func TestSource(t *testing.T) { |
||||
assert.NoError(t, unittest.PrepareTestDatabase()) |
||||
|
||||
source := &Source{ |
||||
Provider: "fake", |
||||
authSource: &auth.Source{ |
||||
ID: 12, |
||||
Type: auth.OAuth2, |
||||
Name: "fake", |
||||
IsActive: true, |
||||
IsSyncEnabled: true, |
||||
}, |
||||
} |
||||
|
||||
user := &user_model.User{ |
||||
LoginName: "external", |
||||
LoginType: auth.OAuth2, |
||||
LoginSource: source.authSource.ID, |
||||
Name: "test", |
||||
Email: "external@example.com", |
||||
} |
||||
|
||||
err := user_model.CreateUser(context.Background(), user, &user_model.CreateUserOverwriteOptions{}) |
||||
assert.NoError(t, err) |
||||
|
||||
e := &user_model.ExternalLoginUser{ |
||||
ExternalID: "external", |
||||
UserID: user.ID, |
||||
LoginSourceID: user.LoginSource, |
||||
RefreshToken: "valid", |
||||
} |
||||
err = user_model.LinkExternalToUser(context.Background(), user, e) |
||||
assert.NoError(t, err) |
||||
|
||||
provider, err := createProvider(source.authSource.Name, source) |
||||
assert.NoError(t, err) |
||||
|
||||
t.Run("refresh", func(t *testing.T) { |
||||
t.Run("valid", func(t *testing.T) { |
||||
err := source.refresh(context.Background(), provider, e) |
||||
assert.NoError(t, err) |
||||
|
||||
e := &user_model.ExternalLoginUser{ |
||||
ExternalID: e.ExternalID, |
||||
LoginSourceID: e.LoginSourceID, |
||||
} |
||||
|
||||
ok, err := user_model.GetExternalLogin(context.Background(), e) |
||||
assert.NoError(t, err) |
||||
assert.True(t, ok) |
||||
assert.Equal(t, e.RefreshToken, "refresh") |
||||
assert.Equal(t, e.AccessToken, "token") |
||||
|
||||
u, err := user_model.GetUserByID(context.Background(), user.ID) |
||||
assert.NoError(t, err) |
||||
assert.True(t, u.IsActive) |
||||
}) |
||||
|
||||
t.Run("expired", func(t *testing.T) { |
||||
err := source.refresh(context.Background(), provider, &user_model.ExternalLoginUser{ |
||||
ExternalID: "external", |
||||
UserID: user.ID, |
||||
LoginSourceID: user.LoginSource, |
||||
RefreshToken: "expired", |
||||
}) |
||||
assert.NoError(t, err) |
||||
|
||||
e := &user_model.ExternalLoginUser{ |
||||
ExternalID: e.ExternalID, |
||||
LoginSourceID: e.LoginSourceID, |
||||
} |
||||
|
||||
ok, err := user_model.GetExternalLogin(context.Background(), e) |
||||
assert.NoError(t, err) |
||||
assert.True(t, ok) |
||||
assert.Equal(t, e.RefreshToken, "") |
||||
assert.Equal(t, e.AccessToken, "") |
||||
|
||||
u, err := user_model.GetUserByID(context.Background(), user.ID) |
||||
assert.NoError(t, err) |
||||
assert.False(t, u.IsActive) |
||||
}) |
||||
}) |
||||
} |
||||
Loading…
Reference in new issue