Skip to content

Modern Docker Management, Designed for Everyone

fix: use both legacy and new api key headers for agent authentication (#1271)

Kyle Mendell4eae6911e16e
diff --git a/backend/internal/huma/middleware/auth.go b/backend/internal/huma/middleware/auth.go
index 9cf5e9a87..fe7dde6bf 100644
--- a/backend/internal/huma/middleware/auth.go
+++ b/backend/internal/huma/middleware/auth.go
@@ -127,6 +127,11 @@ func tryAgentAuth(ctx huma.Context, cfg *config.Config) (*models.User, bool) {
return createAgentSudoUser(), true
}
+ // Check for API key as agent token
+ if tok := ctx.Header(headerApiKey); tok != "" && cfg.AgentToken != "" && tok == cfg.AgentToken {
+ return createAgentSudoUser(), true
+ }
+
return nil, false
}
diff --git a/backend/internal/middleware/auth_middleware.go b/backend/internal/middleware/auth_middleware.go
index 018f06e0c..ee09de733 100644
--- a/backend/internal/middleware/auth_middleware.go
+++ b/backend/internal/middleware/auth_middleware.go
@@ -17,7 +17,7 @@ import (
const (
headerAgentBootstrap = "X-Arcane-Agent-Bootstrap"
headerAgentToken = "X-Arcane-Agent-Token" // #nosec G101: header name, not a credential
- headerApiKey = "X-API-KEY" // #nosec G101: header name, not a credential
+ headerApiKey = "X-API-Key" // #nosec G101: header name, not a credential
agentPairingPrefix = "/api/environments/0/agent/pair"
)
@@ -86,6 +86,12 @@ func (m *AuthMiddleware) agentAuth(c *gin.Context) {
return
}
+ // Check for API key as agent token
+ if tok := c.GetHeader(headerApiKey); tok != "" && m.cfg.AgentToken != "" && tok == m.cfg.AgentToken {
+ agentSudo(c)
+ return
+ }
+
slog.Warn("Agent auth forbidden",
"path", c.Request.URL.Path,
"method", c.Request.Method,
@@ -100,7 +106,7 @@ func (m *AuthMiddleware) agentAuth(c *gin.Context) {
}
func (m *AuthMiddleware) managerAuth(c *gin.Context) {
- // First, check for API key in X-API-KEY header
+ // First, check for API key in X-API-Key header
if apiKey := c.GetHeader(headerApiKey); apiKey != "" && m.apiKeyValidator != nil {
user, err := m.apiKeyValidator.ValidateApiKey(c.Request.Context(), apiKey)
if err == nil && user != nil {
diff --git a/backend/internal/services/environment_service.go b/backend/internal/services/environment_service.go
index a55827d14..50725d507 100644
--- a/backend/internal/services/environment_service.go
+++ b/backend/internal/services/environment_service.go
@@ -536,15 +536,9 @@ func (s *EnvironmentService) SyncRegistriesToEnvironment(ctx context.Context, en
// Use appropriate auth header based on environment type
if environment.AccessToken != nil && *environment.AccessToken != "" {
- // For API key-based environments, AccessToken contains the API key
- if environment.ApiKeyID != nil && *environment.ApiKeyID != "" {
- req.Header.Set("X-API-KEY", *environment.AccessToken)
- slog.DebugContext(ctx, "Set API key header for sync request")
- } else {
- // Legacy bootstrap token-based environments
- req.Header.Set("X-Arcane-Agent-Token", *environment.AccessToken)
- slog.DebugContext(ctx, "Set agent token header for sync request")
- }
+ req.Header.Set("X-Arcane-Agent-Token", *environment.AccessToken)
+ req.Header.Set("X-API-Key", *environment.AccessToken)
+ slog.DebugContext(ctx, "Set auth headers for sync request")
} else {
slog.WarnContext(ctx, "No access token available for environment sync", "environmentID", environmentID)
}
@@ -609,11 +603,8 @@ func (s *EnvironmentService) ProxyRequest(ctx context.Context, envID string, met
// Use appropriate auth header
if environment.AccessToken != nil && *environment.AccessToken != "" {
- if environment.ApiKeyID != nil && *environment.ApiKeyID != "" {
- req.Header.Set("X-API-KEY", *environment.AccessToken)
- } else {
- req.Header.Set("X-Arcane-Agent-Token", *environment.AccessToken)
- }
+ req.Header.Set("X-Arcane-Agent-Token", *environment.AccessToken)
+ req.Header.Set("X-API-Key", *environment.AccessToken)
}
resp, err := s.httpClient.Do(req)
diff --git a/backend/internal/utils/remenv/remenv.go b/backend/internal/utils/remenv/remenv.go
index 8da5ac838..6a8da5cbb 100644
--- a/backend/internal/utils/remenv/remenv.go
+++ b/backend/internal/utils/remenv/remenv.go
@@ -9,8 +9,7 @@ import (
)
const (
- HeaderAPIKey = "X-Api-Key" // #nosec G101: header name, not a credential
- HeaderAPIToken = "X-Api-Token" // #nosec G101: header name, not a credential
+ HeaderAPIKey = "X-API-Key" // #nosec G101: header name, not a credential
HeaderAuthorization = "Authorization"
HeaderCookie = "Cookie"
HeaderAgentToken = "X-Arcane-Agent-Token" // #nosec G101: header name, not a credential
@@ -23,7 +22,7 @@ const (
func CopyRequestHeaders(from http.Header, to http.Header, skip map[string]struct{}) {
for k, vs := range from {
ck := http.CanonicalHeaderKey(k)
- if _, ok := skip[ck]; ok || ck == http.CanonicalHeaderKey(HeaderAuthorization) || ck == http.CanonicalHeaderKey(HeaderAPIToken) {
+ if _, ok := skip[ck]; ok || ck == http.CanonicalHeaderKey(HeaderAuthorization) || ck == http.CanonicalHeaderKey(HeaderAPIKey) {
continue
}
for _, v := range vs {
@@ -34,8 +33,8 @@ func CopyRequestHeaders(from http.Header, to http.Header, skip map[string]struct
func SetAuthHeader(req *http.Request, c *gin.Context) {
// Forward API key header if present
- if apiKey := c.GetHeader(HeaderAPIToken); apiKey != "" {
- req.Header.Set(HeaderAPIToken, apiKey)
+ if apiKey := c.GetHeader(HeaderAPIKey); apiKey != "" {
+ req.Header.Set(HeaderAPIKey, apiKey)
}
// Forward Authorization header or cookie token
@@ -49,6 +48,7 @@ func SetAuthHeader(req *http.Request, c *gin.Context) {
func SetAgentToken(req *http.Request, accessToken *string) {
if accessToken != nil && *accessToken != "" {
req.Header.Set(HeaderAgentToken, *accessToken)
+ req.Header.Set(HeaderAPIKey, *accessToken)
}
}
@@ -70,7 +70,7 @@ func BuildWebSocketHeaders(c *gin.Context, accessToken *string) http.Header {
}
// Forward cookies if no other auth is present
- if headers.Get(HeaderAuthorization) == "" && headers.Get(HeaderAPIToken) == "" {
+ if headers.Get(HeaderAuthorization) == "" && headers.Get(HeaderAPIKey) == "" {
if cookies := c.Request.Header.Get(HeaderCookie); cookies != "" {
headers.Set(HeaderCookie, cookies)
}
@@ -79,6 +79,7 @@ func BuildWebSocketHeaders(c *gin.Context, accessToken *string) http.Header {
// Set agent token for remote environment authentication
if accessToken != nil && *accessToken != "" {
headers.Set(HeaderAgentToken, *accessToken)
+ headers.Set(HeaderAPIKey, *accessToken)
}
return headers
diff --git a/backend/internal/utils/remenv/remenv_test.go b/backend/internal/utils/remenv/remenv_test.go
index 0822f856b..7c387abc7 100644
--- a/backend/internal/utils/remenv/remenv_test.go
+++ b/backend/internal/utils/remenv/remenv_test.go
@@ -71,7 +71,7 @@ func TestCopyRequestHeaders_SkipsExpectedHeaders(t *testing.T) {
from.Add("X-Test", "a")
from.Add("X-Test", "b")
from.Set(HeaderAuthorization, "Bearer should-not-copy")
- from.Set(HeaderAPIToken, "token-should-not-copy")
+ from.Set(HeaderAPIKey, "token-should-not-copy")
from.Set("Host", "example.com")
from.Set(HeaderCookie, "session=abc")
from.Set("Transfer-Encoding", "chunked")
@@ -81,25 +81,25 @@ func TestCopyRequestHeaders_SkipsExpectedHeaders(t *testing.T) {
require.Equal(t, []string{"a", "b"}, to.Values("X-Test"))
require.Empty(t, to.Get(HeaderAuthorization))
- require.Empty(t, to.Get(HeaderAPIToken))
+ require.Empty(t, to.Get(HeaderAPIKey))
require.Empty(t, to.Get("Host"))
require.Empty(t, to.Get(HeaderCookie))
require.Empty(t, to.Get("Transfer-Encoding"))
}
-func TestSetAuthHeader_ForwardsAPITokenAndAuthorization(t *testing.T) {
+func TestSetAuthHeader_ForwardsAPIKeyAndAuthorization(t *testing.T) {
gin.SetMode(gin.TestMode)
w := httptest.NewRecorder()
c, _ := gin.CreateTestContext(w)
c.Request = httptest.NewRequest(http.MethodGet, "http://example.com", nil)
- c.Request.Header.Set(HeaderAPIToken, "api-token")
+ c.Request.Header.Set(HeaderAPIKey, "api-token")
c.Request.Header.Set(HeaderAuthorization, "Bearer auth")
req, err := http.NewRequestWithContext(context.Background(), http.MethodGet, "http://remote", nil)
require.NoError(t, err)
SetAuthHeader(req, c)
- require.Equal(t, "api-token", req.Header.Get(HeaderAPIToken))
+ require.Equal(t, "api-token", req.Header.Get(HeaderAPIKey))
require.Equal(t, "Bearer auth", req.Header.Get(HeaderAuthorization))
}
@@ -123,10 +123,12 @@ func TestSetAgentToken(t *testing.T) {
SetAgentToken(req, nil)
require.Empty(t, req.Header.Get(HeaderAgentToken))
+ require.Empty(t, req.Header.Get(HeaderAPIKey))
tok := "agent-token"
SetAgentToken(req, &tok)
require.Equal(t, tok, req.Header.Get(HeaderAgentToken))
+ require.Equal(t, tok, req.Header.Get(HeaderAPIKey))
}
func TestSetForwardedHeaders(t *testing.T) {
@@ -200,7 +202,7 @@ func TestBuildWebSocketHeaders_UsesAuthorizationHeaderAndAddsAgentToken(t *testi
agent := "agent-token"
headers := BuildWebSocketHeaders(c, &agent)
- require.Equal(t, "api-key", headers.Get(HeaderAPIKey))
+ require.Equal(t, agent, headers.Get(HeaderAPIKey))
require.Equal(t, "Bearer auth", headers.Get(HeaderAuthorization))
require.Empty(t, headers.Get(HeaderCookie))
require.Equal(t, agent, headers.Get(HeaderAgentToken))