From e4d998dc1a8632526f7f982c43e56dfc24ee17b2 Mon Sep 17 00:00:00 2001 From: Karl Persson Date: Thu, 30 Mar 2023 17:04:10 +0200 Subject: [PATCH] ApiKeyGenPrefix: rename package (#65623) * Rename package to satokengen to make it clearer that it is for service account tokens --- .github/CODEOWNERS | 2 +- .../{apikeygenprefixed => satokengen}/cmd/main.go | 4 ++-- pkg/components/{apikeygenprefixed => satokengen}/errors.go | 2 +- .../apikeygen.go => satokengen/tokengen.go} | 2 +- .../apikeygen_test.go => satokengen/tokengen_test.go} | 2 +- pkg/services/authn/clients/api_key.go | 6 +++--- pkg/services/authn/clients/api_key_test.go | 4 ++-- pkg/services/contexthandler/contexthandler.go | 6 +++--- pkg/services/grpcserver/interceptors/auth.go | 4 ++-- pkg/services/grpcserver/interceptors/auth_test.go | 4 ++-- pkg/services/serviceaccounts/api/token.go | 4 ++-- pkg/services/serviceaccounts/database/stats_test.go | 4 ++-- pkg/services/store/entity/tests/common.go | 4 ++-- 13 files changed, 24 insertions(+), 24 deletions(-) rename pkg/components/{apikeygenprefixed => satokengen}/cmd/main.go (83%) rename pkg/components/{apikeygenprefixed => satokengen}/errors.go (91%) rename pkg/components/{apikeygenprefixed/apikeygen.go => satokengen/tokengen.go} (98%) rename pkg/components/{apikeygenprefixed/apikeygen_test.go => satokengen/tokengen_test.go} (97%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7b9d48e7b70..5612a41cd9e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -66,7 +66,7 @@ /pkg/bus/ @grafana/backend-platform /pkg/cmd/ @grafana/backend-platform /pkg/components/apikeygen/ @grafana/grafana-authnz-team -/pkg/components/apikeygenprefixed/ @grafana/grafana-authnz-team +/pkg/components/satokengen/ @grafana/grafana-authnz-team /pkg/components/dashdiffs/ @grafana/backend-platform /pkg/components/imguploader/ @grafana/backend-platform /pkg/components/loki/ @grafana/backend-platform diff --git a/pkg/components/apikeygenprefixed/cmd/main.go b/pkg/components/satokengen/cmd/main.go similarity index 83% rename from pkg/components/apikeygenprefixed/cmd/main.go rename to pkg/components/satokengen/cmd/main.go index 750783ef910..72730d9d96a 100644 --- a/pkg/components/apikeygenprefixed/cmd/main.go +++ b/pkg/components/satokengen/cmd/main.go @@ -5,7 +5,7 @@ import ( "os" "strconv" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" ) // placeholder key generator @@ -22,7 +22,7 @@ func main() { } for i := 0; i < numKeys; i++ { - key, err := apikeygenprefix.New("pl") + key, err := satokengen.New("pl") if err != nil { fmt.Println("ERROR: generating key failed:", err) return diff --git a/pkg/components/apikeygenprefixed/errors.go b/pkg/components/satokengen/errors.go similarity index 91% rename from pkg/components/apikeygenprefixed/errors.go rename to pkg/components/satokengen/errors.go index 7d8212ce7ea..bd6eef8e411 100644 --- a/pkg/components/apikeygenprefixed/errors.go +++ b/pkg/components/satokengen/errors.go @@ -1,4 +1,4 @@ -package apikeygenprefix +package satokengen import "github.com/grafana/grafana/pkg/components/apikeygen" diff --git a/pkg/components/apikeygenprefixed/apikeygen.go b/pkg/components/satokengen/tokengen.go similarity index 98% rename from pkg/components/apikeygenprefixed/apikeygen.go rename to pkg/components/satokengen/tokengen.go index 3d504200b82..3e96e9f080e 100644 --- a/pkg/components/apikeygenprefixed/apikeygen.go +++ b/pkg/components/satokengen/tokengen.go @@ -1,4 +1,4 @@ -package apikeygenprefix +package satokengen import ( "encoding/hex" diff --git a/pkg/components/apikeygenprefixed/apikeygen_test.go b/pkg/components/satokengen/tokengen_test.go similarity index 97% rename from pkg/components/apikeygenprefixed/apikeygen_test.go rename to pkg/components/satokengen/tokengen_test.go index c1669010d92..1b75fdc5b5f 100644 --- a/pkg/components/apikeygenprefixed/apikeygen_test.go +++ b/pkg/components/satokengen/tokengen_test.go @@ -1,4 +1,4 @@ -package apikeygenprefix +package satokengen import ( "testing" diff --git a/pkg/services/authn/clients/api_key.go b/pkg/services/authn/clients/api_key.go index cc0b86fb5a3..813e902b8bc 100644 --- a/pkg/services/authn/clients/api_key.go +++ b/pkg/services/authn/clients/api_key.go @@ -7,7 +7,7 @@ import ( "time" "github.com/grafana/grafana/pkg/components/apikeygen" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/infra/log" "github.com/grafana/grafana/pkg/services/apikey" "github.com/grafana/grafana/pkg/services/authn" @@ -85,7 +85,7 @@ func (s *APIKey) Authenticate(ctx context.Context, r *authn.Request) (*authn.Ide func (s *APIKey) getAPIKey(ctx context.Context, token string) (*apikey.APIKey, error) { fn := s.getFromToken - if !strings.HasPrefix(token, apikeygenprefix.GrafanaPrefix) { + if !strings.HasPrefix(token, satokengen.GrafanaPrefix) { fn = s.getFromTokenLegacy } @@ -98,7 +98,7 @@ func (s *APIKey) getAPIKey(ctx context.Context, token string) (*apikey.APIKey, e } func (s *APIKey) getFromToken(ctx context.Context, token string) (*apikey.APIKey, error) { - decoded, err := apikeygenprefix.Decode(token) + decoded, err := satokengen.Decode(token) if err != nil { return nil, err } diff --git a/pkg/services/authn/clients/api_key_test.go b/pkg/services/authn/clients/api_key_test.go index 2ce35f1eab9..cdfa76c9afb 100644 --- a/pkg/services/authn/clients/api_key_test.go +++ b/pkg/services/authn/clients/api_key_test.go @@ -10,7 +10,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/grafana/grafana/pkg/components/apikeygen" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/services/apikey" "github.com/grafana/grafana/pkg/services/apikey/apikeytest" "github.com/grafana/grafana/pkg/services/authn" @@ -200,7 +200,7 @@ func genApiKey(legacy bool) (string, string) { res, _ := apikeygen.New(1, "test") return res.ClientSecret, res.HashedKey } - res, _ := apikeygenprefix.New("test") + res, _ := satokengen.New("test") return res.ClientSecret, res.HashedKey } diff --git a/pkg/services/contexthandler/contexthandler.go b/pkg/services/contexthandler/contexthandler.go index 029bd4bb015..d0ed3036dd6 100644 --- a/pkg/services/contexthandler/contexthandler.go +++ b/pkg/services/contexthandler/contexthandler.go @@ -14,7 +14,7 @@ import ( "golang.org/x/sync/singleflight" "github.com/grafana/grafana/pkg/components/apikeygen" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/infra/db" "github.com/grafana/grafana/pkg/infra/log" "github.com/grafana/grafana/pkg/infra/network" @@ -261,7 +261,7 @@ func (h *ContextHandler) initContextWithAnonymousUser(reqContext *contextmodel.R func (h *ContextHandler) getPrefixedAPIKey(ctx context.Context, keyString string) (*apikey.APIKey, error) { // prefixed decode key - decoded, err := apikeygenprefix.Decode(keyString) + decoded, err := satokengen.Decode(keyString) if err != nil { return nil, err } @@ -323,7 +323,7 @@ func (h *ContextHandler) initContextWithAPIKey(reqContext *contextmodel.ReqConte apiKey *apikey.APIKey errKey error ) - if strings.HasPrefix(keyString, apikeygenprefix.GrafanaPrefix) { + if strings.HasPrefix(keyString, satokengen.GrafanaPrefix) { apiKey, errKey = h.getPrefixedAPIKey(reqContext.Req.Context(), keyString) // decode prefixed key } else { apiKey, errKey = h.getAPIKey(reqContext.Req.Context(), keyString) // decode legacy api key diff --git a/pkg/services/grpcserver/interceptors/auth.go b/pkg/services/grpcserver/interceptors/auth.go index 90c3644ba55..f5bf4fc3d30 100644 --- a/pkg/services/grpcserver/interceptors/auth.go +++ b/pkg/services/grpcserver/interceptors/auth.go @@ -8,7 +8,7 @@ import ( "google.golang.org/grpc/metadata" "google.golang.org/grpc/status" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/infra/log" "github.com/grafana/grafana/pkg/services/accesscontrol" "github.com/grafana/grafana/pkg/services/apikey" @@ -79,7 +79,7 @@ func (a *authenticator) tokenAuth(ctx context.Context) (context.Context, error) } func (a *authenticator) getSignedInUser(ctx context.Context, token string) (*user.SignedInUser, error) { - decoded, err := apikeygenprefix.Decode(token) + decoded, err := satokengen.Decode(token) if err != nil { return nil, err } diff --git a/pkg/services/grpcserver/interceptors/auth_test.go b/pkg/services/grpcserver/interceptors/auth_test.go index ae22c131a56..2e5723656a4 100644 --- a/pkg/services/grpcserver/interceptors/auth_test.go +++ b/pkg/services/grpcserver/interceptors/auth_test.go @@ -7,7 +7,7 @@ import ( "github.com/stretchr/testify/require" "google.golang.org/grpc/metadata" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/infra/tracing" "github.com/grafana/grafana/pkg/services/accesscontrol" accesscontrolmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock" @@ -151,7 +151,7 @@ func (f *fakeUserService) GetSignedInUserWithCacheCtx(ctx context.Context, query func setupContext() (context.Context, error) { ctx := context.Background() - key, err := apikeygenprefix.New("sa") + key, err := satokengen.New("sa") if err != nil { return ctx, err } diff --git a/pkg/services/serviceaccounts/api/token.go b/pkg/services/serviceaccounts/api/token.go index ef2158b4f80..58900bc9646 100644 --- a/pkg/services/serviceaccounts/api/token.go +++ b/pkg/services/serviceaccounts/api/token.go @@ -7,7 +7,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/api/response" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" contextmodel "github.com/grafana/grafana/pkg/services/contexthandler/model" "github.com/grafana/grafana/pkg/services/serviceaccounts" "github.com/grafana/grafana/pkg/web" @@ -160,7 +160,7 @@ func (api *ServiceAccountsAPI) CreateToken(c *contextmodel.ReqContext) response. } } - newKeyInfo, err := apikeygenprefix.New(ServiceID) + newKeyInfo, err := satokengen.New(ServiceID) if err != nil { return response.Error(http.StatusInternalServerError, "Generating service account token failed", err) } diff --git a/pkg/services/serviceaccounts/database/stats_test.go b/pkg/services/serviceaccounts/database/stats_test.go index 584b7edfca3..eb45febc609 100644 --- a/pkg/services/serviceaccounts/database/stats_test.go +++ b/pkg/services/serviceaccounts/database/stats_test.go @@ -7,7 +7,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/services/serviceaccounts" "github.com/grafana/grafana/pkg/services/serviceaccounts/tests" ) @@ -20,7 +20,7 @@ func TestIntegrationStore_UsageStats(t *testing.T) { db.Cfg.SATokenExpirationDayLimit = 4 keyName := t.Name() - key, err := apikeygenprefix.New(keyName) + key, err := satokengen.New(keyName) require.NoError(t, err) cmd := serviceaccounts.AddServiceAccountTokenCommand{ diff --git a/pkg/services/store/entity/tests/common.go b/pkg/services/store/entity/tests/common.go index c45da12d6ce..a5f213a6002 100644 --- a/pkg/services/store/entity/tests/common.go +++ b/pkg/services/store/entity/tests/common.go @@ -8,7 +8,7 @@ import ( "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" - apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed" + "github.com/grafana/grafana/pkg/components/satokengen" "github.com/grafana/grafana/pkg/infra/appcontext" "github.com/grafana/grafana/pkg/server" "github.com/grafana/grafana/pkg/services/featuremgmt" @@ -30,7 +30,7 @@ func createServiceAccountAdminToken(t *testing.T, env *server.TestEnv) (string, IsServiceAccount: true, }) - keyGen, err := apikeygenprefix.New(saAPI.ServiceID) + keyGen, err := satokengen.New(saAPI.ServiceID) require.NoError(t, err) _ = saTests.SetupApiKey(t, env.SQLStore, saTests.TestApiKey{