mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
ApiKeyGenPrefix: rename package (#65623)
* Rename package to satokengen to make it clearer that it is for service account tokens
This commit is contained in:
parent
3cd3bb00ec
commit
e4d998dc1a
2
.github/CODEOWNERS
vendored
2
.github/CODEOWNERS
vendored
@ -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
|
||||
|
@ -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
|
@ -1,4 +1,4 @@
|
||||
package apikeygenprefix
|
||||
package satokengen
|
||||
|
||||
import "github.com/grafana/grafana/pkg/components/apikeygen"
|
||||
|
@ -1,4 +1,4 @@
|
||||
package apikeygenprefix
|
||||
package satokengen
|
||||
|
||||
import (
|
||||
"encoding/hex"
|
@ -1,4 +1,4 @@
|
||||
package apikeygenprefix
|
||||
package satokengen
|
||||
|
||||
import (
|
||||
"testing"
|
@ -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
|
||||
}
|
||||
|
@ -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
|
||||
}
|
||||
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
}
|
||||
|
@ -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
|
||||
}
|
||||
|
@ -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)
|
||||
}
|
||||
|
@ -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{
|
||||
|
@ -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{
|
||||
|
Loading…
Reference in New Issue
Block a user