AuthN: Use sync hook to fetch service account (#84078)

* Use sync hook to fetch service account
This commit is contained in:
Karl Persson
2024-03-11 15:56:53 +01:00
committed by GitHub
parent d8b8a2c2b0
commit 9c292d2c3f
4 changed files with 14 additions and 45 deletions

View File

@@ -90,7 +90,7 @@ func ProvideService(
usageStats.RegisterMetricsFunc(s.getUsageStats) usageStats.RegisterMetricsFunc(s.getUsageStats)
s.RegisterClient(clients.ProvideRender(userService, renderService)) s.RegisterClient(clients.ProvideRender(userService, renderService))
s.RegisterClient(clients.ProvideAPIKey(apikeyService, userService)) s.RegisterClient(clients.ProvideAPIKey(apikeyService))
if cfg.LoginCookieName != "" { if cfg.LoginCookieName != "" {
s.RegisterClient(clients.ProvideSession(cfg, sessionService)) s.RegisterClient(clients.ProvideSession(cfg, sessionService))

View File

@@ -111,7 +111,7 @@ func (s *UserSync) FetchSyncedUserHook(ctx context.Context, identity *authn.Iden
return nil return nil
} }
namespace, id := identity.GetNamespacedID() namespace, id := identity.GetNamespacedID()
if namespace != authn.NamespaceUser { if namespace != authn.NamespaceUser && namespace != authn.NamespaceServiceAccount {
return nil return nil
} }

View File

@@ -14,7 +14,6 @@ import (
"github.com/grafana/grafana/pkg/services/authn" "github.com/grafana/grafana/pkg/services/authn"
"github.com/grafana/grafana/pkg/services/login" "github.com/grafana/grafana/pkg/services/login"
"github.com/grafana/grafana/pkg/services/org" "github.com/grafana/grafana/pkg/services/org"
"github.com/grafana/grafana/pkg/services/user"
"github.com/grafana/grafana/pkg/util" "github.com/grafana/grafana/pkg/util"
"github.com/grafana/grafana/pkg/util/errutil" "github.com/grafana/grafana/pkg/util/errutil"
) )
@@ -29,17 +28,15 @@ var (
var _ authn.HookClient = new(APIKey) var _ authn.HookClient = new(APIKey)
var _ authn.ContextAwareClient = new(APIKey) var _ authn.ContextAwareClient = new(APIKey)
func ProvideAPIKey(apiKeyService apikey.Service, userService user.Service) *APIKey { func ProvideAPIKey(apiKeyService apikey.Service) *APIKey {
return &APIKey{ return &APIKey{
log: log.New(authn.ClientAPIKey), log: log.New(authn.ClientAPIKey),
userService: userService,
apiKeyService: apiKeyService, apiKeyService: apiKeyService,
} }
} }
type APIKey struct { type APIKey struct {
log log.Logger log log.Logger
userService user.Service
apiKeyService apikey.Service apiKeyService apikey.Service
} }
@@ -81,16 +78,12 @@ func (s *APIKey) Authenticate(ctx context.Context, r *authn.Request) (*authn.Ide
}, nil }, nil
} }
usr, err := s.userService.GetSignedInUserWithCacheCtx(ctx, &user.GetSignedInUserQuery{ return &authn.Identity{
UserID: *apiKey.ServiceAccountId, ID: authn.NamespacedID(authn.NamespaceServiceAccount, *apiKey.ServiceAccountId),
OrgID: apiKey.OrgID, OrgID: apiKey.OrgID,
}) AuthenticatedBy: login.APIKeyAuthModule,
ClientParams: authn.ClientParams{FetchSyncedUser: true, SyncPermissions: true},
if err != nil { }, nil
return nil, err
}
return authn.IdentityFromSignedInUser(authn.NamespacedID(authn.NamespaceServiceAccount, usr.UserID), usr, authn.ClientParams{SyncPermissions: true}, login.APIKeyAuthModule), nil
} }
func (s *APIKey) getAPIKey(ctx context.Context, token string) (*apikey.APIKey, error) { func (s *APIKey) getAPIKey(ctx context.Context, token string) (*apikey.APIKey, error) {

View File

@@ -16,8 +16,6 @@ import (
"github.com/grafana/grafana/pkg/services/authn" "github.com/grafana/grafana/pkg/services/authn"
"github.com/grafana/grafana/pkg/services/login" "github.com/grafana/grafana/pkg/services/login"
"github.com/grafana/grafana/pkg/services/org" "github.com/grafana/grafana/pkg/services/org"
"github.com/grafana/grafana/pkg/services/user"
"github.com/grafana/grafana/pkg/services/user/usertest"
) )
var ( var (
@@ -30,7 +28,6 @@ func TestAPIKey_Authenticate(t *testing.T) {
desc string desc string
req *authn.Request req *authn.Request
expectedKey *apikey.APIKey expectedKey *apikey.APIKey
expectedUser *user.SignedInUser
expectedErr error expectedErr error
expectedIdentity *authn.Identity expectedIdentity *authn.Identity
} }
@@ -72,20 +69,11 @@ func TestAPIKey_Authenticate(t *testing.T) {
Key: hash, Key: hash,
ServiceAccountId: intPtr(1), ServiceAccountId: intPtr(1),
}, },
expectedUser: &user.SignedInUser{
UserID: 1,
OrgID: 1,
IsServiceAccount: true,
OrgRole: org.RoleViewer,
Name: "test",
},
expectedIdentity: &authn.Identity{ expectedIdentity: &authn.Identity{
ID: "service-account:1", ID: "service-account:1",
OrgID: 1, OrgID: 1,
Name: "test",
OrgRoles: map[int64]org.RoleType{1: org.RoleViewer},
IsGrafanaAdmin: boolPtr(false),
ClientParams: authn.ClientParams{ ClientParams: authn.ClientParams{
FetchSyncedUser: true,
SyncPermissions: true, SyncPermissions: true,
}, },
AuthenticatedBy: login.APIKeyAuthModule, AuthenticatedBy: login.APIKeyAuthModule,
@@ -124,11 +112,7 @@ func TestAPIKey_Authenticate(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) { t.Run(tt.desc, func(t *testing.T) {
c := ProvideAPIKey(&apikeytest.Service{ c := ProvideAPIKey(&apikeytest.Service{ExpectedAPIKey: tt.expectedKey})
ExpectedAPIKey: tt.expectedKey,
}, &usertest.FakeUserService{
ExpectedSignedInUser: tt.expectedUser,
})
identity, err := c.Authenticate(context.Background(), tt.req) identity, err := c.Authenticate(context.Background(), tt.req)
if tt.expectedErr != nil { if tt.expectedErr != nil {
@@ -195,7 +179,7 @@ func TestAPIKey_Test(t *testing.T) {
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) { t.Run(tt.desc, func(t *testing.T) {
c := ProvideAPIKey(&apikeytest.Service{}, usertest.NewUserServiceFake()) c := ProvideAPIKey(&apikeytest.Service{})
assert.Equal(t, tt.expected, c.Test(context.Background(), tt.req)) assert.Equal(t, tt.expected, c.Test(context.Background(), tt.req))
}) })
} }
@@ -286,19 +270,11 @@ func TestAPIKey_GetAPIKeyIDFromIdentity(t *testing.T) {
}, },
}} }}
signedInUser := &user.SignedInUser{
UserID: 1,
OrgID: 1,
Name: "test",
}
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) { t.Run(tt.desc, func(t *testing.T) {
c := ProvideAPIKey(&apikeytest.Service{ c := ProvideAPIKey(&apikeytest.Service{
ExpectedError: tt.expectedError, ExpectedError: tt.expectedError,
ExpectedAPIKey: tt.expectedKey, ExpectedAPIKey: tt.expectedKey,
}, &usertest.FakeUserService{
ExpectedSignedInUser: signedInUser,
}) })
id, exists := c.getAPIKeyID(context.Background(), tt.expectedIdentity, req) id, exists := c.getAPIKeyID(context.Background(), tt.expectedIdentity, req)
assert.Equal(t, tt.expectedExists, exists) assert.Equal(t, tt.expectedExists, exists)