Skip to content

Modern Docker Management, Designed for Everyone

fix: enforce admin requirements for environment tokens (#3881)

Kyle Mendell4fe4c7ed9483
diff --git a/backend/internal/auth/middleware.go b/backend/internal/auth/middleware.go
index c54bf74f3..9fb4f7d23 100644
--- a/backend/internal/auth/middleware.go
+++ b/backend/internal/auth/middleware.go
@@ -152,8 +152,8 @@ func (m *AuthMiddleware) managerAuth(ctx context.Context, c *echo.Context, next
req := c.Request()
if agentToken := req.Header.Get(utils.HeaderAgentToken); agentToken != "" {
if env, ok := m.resolveEnvironmentAccessToken(ctx, agentToken).Get(); ok {
- environmentScopedInternal(c, env)
- return next(c)
+ ps := environmentScopedInternal(c, env)
+ return m.authorizeAndContinueInternal(c, next, ps)
}
}
@@ -210,18 +210,11 @@ func (m *AuthMiddleware) managerAuth(ctx context.Context, c *echo.Context, next
}
ps := m.resolvePermissionsOrDeny(ctx, user)
- if m.options.AdminRequired && !ps.IsGlobalAdmin() {
- return c.JSON(http.StatusForbidden, common.APIError{
- Code: "FORBIDDEN",
- Message: "You don't have permission to access this resource",
- })
- }
-
c.Set(string(middleware.ContextKeyUserID), user.ID)
c.Set(string(middleware.ContextKeyCurrentUser), user)
c.Set(string(middleware.ContextKeyCurrentSessionID), sessionID)
c.Set(string(middleware.ContextKeyUserPermissions), ps)
- return next(c)
+ return m.authorizeAndContinueInternal(c, next, ps)
}
// apiKeyHeaderAuth authenticates an X-API-Key credential: a user-owned API key
@@ -238,22 +231,16 @@ func (m *AuthMiddleware) apiKeyHeaderAuth(ctx context.Context, c *echo.Context,
} else {
ps = m.resolveApiKeyPermissionsOrDeny(ctx, key.ID)
}
- if m.options.AdminRequired && !ps.IsGlobalAdmin() {
- return c.JSON(http.StatusForbidden, common.APIError{
- Code: "FORBIDDEN",
- Message: "You don't have permission to access this resource",
- })
- }
c.Set(string(middleware.ContextKeyUserID), user.ID)
c.Set(string(middleware.ContextKeyCurrentUser), user)
c.Set(string(middleware.ContextKeyUserPermissions), ps)
c.Set(string(middleware.ContextKeyAuthMethod), "api_key")
- return next(c)
+ return m.authorizeAndContinueInternal(c, next, ps)
}
}
if env, ok := m.resolveEnvironmentAccessToken(ctx, apiKey).Get(); ok {
- environmentScopedInternal(c, env)
- return next(c)
+ ps := environmentScopedInternal(c, env)
+ return m.authorizeAndContinueInternal(c, next, ps)
}
return c.JSON(http.StatusUnauthorized, common.APIError{
Code: common.APIErrorCodeUnauthorized,
@@ -261,6 +248,16 @@ func (m *AuthMiddleware) apiKeyHeaderAuth(ctx context.Context, c *echo.Context,
})
}
+func (m *AuthMiddleware) authorizeAndContinueInternal(c *echo.Context, next echo.HandlerFunc, ps *authz.PermissionSet) error {
+ if m.options.AdminRequired && !ps.IsGlobalAdmin() {
+ return c.JSON(http.StatusForbidden, common.APIError{
+ Code: "FORBIDDEN",
+ Message: "You don't have permission to access this resource",
+ })
+ }
+ return next(c)
+}
+
// resolvePermissionsOrDeny returns the user's permission set, or an empty
// (deny-all) set if the resolver is unavailable or fails. Resolver failures
// are logged.
@@ -320,15 +317,17 @@ func agentSudoInternal(c *echo.Context) {
c.Set(string(middleware.ContextKeyAuthMethod), "agent_token")
}
-func environmentScopedInternal(c *echo.Context, env *environment.Environment) {
+func environmentScopedInternal(c *echo.Context, env *environment.Environment) *authz.PermissionSet {
envUser := &common.User{
ID: "environment:" + env.ID,
Username: env.Name,
}
c.Set(string(middleware.ContextKeyUserID), envUser.ID)
c.Set(string(middleware.ContextKeyCurrentUser), envUser)
- c.Set(string(middleware.ContextKeyUserPermissions), authz.EnvironmentPermissionSet(env.ID))
+ ps := authz.EnvironmentPermissionSet(env.ID)
+ c.Set(string(middleware.ContextKeyUserPermissions), ps)
c.Set(string(middleware.ContextKeyAuthMethod), "environment_access_token")
+ return ps
}
func extractBearerOrCookieTokenInternal(c *echo.Context) (string, bool) {
diff --git a/backend/internal/auth/middleware_test.go b/backend/internal/auth/middleware_test.go
index f0d9db893..2196e2dcc 100644
--- a/backend/internal/auth/middleware_test.go
+++ b/backend/internal/auth/middleware_test.go
@@ -155,46 +155,68 @@ func TestAuthMiddleware_ManagerAuthResolvesPermissionsByKeyKind(t *testing.T) {
})
}
-func TestAuthMiddleware_ManagerAuthAcceptsEnvironmentAccessTokenViaAPIKey(t *testing.T) {
+func TestAuthMiddleware_ManagerAuthEnvironmentAccessToken(t *testing.T) {
token := "env-access-token"
- router := echo.New()
- router.Use(
- NewAuthMiddleware(nil, &config.Config{}).
- WithEnvironmentAccessTokenResolver(testEnvironmentTokenResolver{
- env: &environment.Environment{
- ID: "env-self",
- Name: "Self Target",
- AccessToken: &token,
- },
- }).
- Add(),
- )
- router.GET("/secure", func(c *echo.Context) error {
- currentUser := c.Get("currentUser")
- require.NotNil(t, currentUser)
-
- user, ok := currentUser.(*common.User)
- require.True(t, ok)
- require.Equal(t, "environment:env-self", user.ID)
- require.Equal(t, "Self Target", user.Username)
- require.Equal(t, "environment_access_token", c.Get("authMethod"))
-
- ps, ok := c.Get("userPermissions").(*authz.PermissionSet)
- require.True(t, ok)
- require.True(t, ps.Allows(authz.PermContainersStart, "env-self"))
- require.False(t, ps.Allows(authz.PermContainersStart, "env-other"))
- require.False(t, ps.Allows(authz.PermUsersList, ""))
- require.False(t, ps.IsGlobalAdmin())
-
- return c.JSON(http.StatusOK, map[string]any{"userId": user.ID})
- })
+ cases := []struct {
+ name string
+ header string
+ adminRequired bool
+ wantStatus int
+ }{
+ {name: "agent token ordinary route", header: "X-Arcane-Agent-Token", wantStatus: http.StatusOK},
+ {name: "API key ordinary route", header: "X-API-Key", wantStatus: http.StatusOK},
+ {name: "agent token admin route", header: "X-Arcane-Agent-Token", adminRequired: true, wantStatus: http.StatusForbidden},
+ {name: "API key admin route", header: "X-API-Key", adminRequired: true, wantStatus: http.StatusForbidden},
+ }
+ for _, tc := range cases {
+ t.Run(tc.name, func(t *testing.T) {
+ router := echo.New()
+ authMiddleware := NewAuthMiddleware(nil, &config.Config{}).
+ WithEnvironmentAccessTokenResolver(testEnvironmentTokenResolver{
+ env: &environment.Environment{
+ ID: "env-self",
+ Name: "Self Target",
+ AccessToken: &token,
+ },
+ })
+ if tc.adminRequired {
+ authMiddleware = authMiddleware.WithAdminRequired()
+ }
+ router.Use(authMiddleware.Add())
+ called := false
+ router.GET("/secure", func(c *echo.Context) error {
+ called = true
+ currentUser := c.Get("currentUser")
+ require.NotNil(t, currentUser)
- req := httptest.NewRequest(http.MethodGet, "/secure", nil)
- req.Header.Set("X-API-Key", token)
- rec := httptest.NewRecorder()
+ user, ok := currentUser.(*common.User)
+ require.True(t, ok)
+ require.Equal(t, "environment:env-self", user.ID)
+ require.Equal(t, "Self Target", user.Username)
+ require.Equal(t, "environment_access_token", c.Get("authMethod"))
- router.ServeHTTP(rec, req)
+ ps, ok := c.Get("userPermissions").(*authz.PermissionSet)
+ require.True(t, ok)
+ require.True(t, ps.Allows(authz.PermContainersStart, "env-self"))
+ require.False(t, ps.Allows(authz.PermContainersStart, "env-other"))
+ require.False(t, ps.Allows(authz.PermUsersList, ""))
+ require.False(t, ps.IsGlobalAdmin())
+
+ return c.JSON(http.StatusOK, map[string]any{"userId": user.ID})
+ })
- require.Equal(t, http.StatusOK, rec.Code)
- require.Contains(t, rec.Body.String(), "environment:env-self")
+ req := httptest.NewRequest(http.MethodGet, "/secure", nil)
+ req.Header.Set(tc.header, token)
+ rec := httptest.NewRecorder()
+ router.ServeHTTP(rec, req)
+
+ require.Equal(t, tc.wantStatus, rec.Code)
+ require.Equal(t, !tc.adminRequired, called)
+ if tc.adminRequired {
+ require.JSONEq(t, `{"statusCode":0,"code":"FORBIDDEN","message":"You don't have permission to access this resource"}`, rec.Body.String())
+ } else {
+ require.Contains(t, rec.Body.String(), "environment:env-self")
+ }
+ })
+ }
}