mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
fix: create agent firewall sessions without requiring agent read access (#26990)
## Overview Part of the **boundary correlation** feature. Fixes lazy creation of `boundary_sessions` rows so it works within the agent's RBAC constraints, and consumes the new `ConfinedProcessName` field reported by boundary. Pairs with coder/boundary#206, which adds `ConfinedProcessName` to `ReportBoundaryLogsRequest`. This branch bumps the `github.com/coder/boundary` module to pick up that work. ## Problem `ensureSession` did a pre-insert existence check via `GetBoundarySessionByID`. Agents are **not permitted to read boundary sessions**, so that read path is not viable when the session is created from an agent-reported log batch. ## Changes - **Remove the pre-insert read.** `ensureSession` now inserts directly and treats a primary-key unique violation as success, covering sessions already created by a prior batch, a reconnection, or another coderd replica — without requiring read access. - **Per-connection guard.** Add a mutex-protected `ensuredSessions` set so repeated log batches on the same connection skip the existence check and insert entirely, touching the database only for the logs. On a transient insert failure the session is left unmarked so the next batch retries. - **Consume `ConfinedProcessName`.** Pass `req.GetConfinedProcessName()` through to the session insert. - **Bump boundary module** from `v0.9.0` to `v0.9.1-0.20260706095856-35ba90f9e8b2`. - **Tests.** - Add `TestReportBoundaryLogsAgentRBAC` (`coderd/boundary_logs_test.go`), an integration test that connects as a real workspace agent, verifies the session and log are persisted under agent RBAC, and asserts the agent subject cannot read boundary sessions — guarding against reintroducing a pre-insert read. - Add `TestReportBoundaryLogsSessionGuard` (session inserted once across two batches, logs inserted per batch) and `TestReportBoundaryLogsSessionRetriedOnError` (insert retried after a transient error). - Regenerate `agent-firewall` CLI docs/golden files and adjust the clidocgen template to render the YAML path when a flag has no long name. > 🤖 This PR was opened by Coder Agents on behalf of @SasSwart.
This commit is contained in:
@@ -2,16 +2,20 @@ package agentapi_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/mock/gomock"
|
||||
"google.golang.org/protobuf/types/known/timestamppb"
|
||||
|
||||
"cdr.dev/slog/v3/sloggers/slogtest"
|
||||
agentproto "github.com/coder/coder/v2/agent/proto"
|
||||
"github.com/coder/coder/v2/coderd/agentapi"
|
||||
"github.com/coder/coder/v2/coderd/database"
|
||||
"github.com/coder/coder/v2/coderd/database/dbgen"
|
||||
"github.com/coder/coder/v2/coderd/database/dbmock"
|
||||
"github.com/coder/coder/v2/coderd/database/dbtestutil"
|
||||
"github.com/coder/coder/v2/coderd/database/dbtime"
|
||||
"github.com/coder/coder/v2/testutil"
|
||||
@@ -454,3 +458,98 @@ func TestReportBoundaryLogs(t *testing.T) {
|
||||
require.Len(t, logs, 2, "logs from both agents must be persisted")
|
||||
})
|
||||
}
|
||||
|
||||
// httpLogRequest builds a ReportBoundaryLogsRequest carrying a single allowed
|
||||
// HTTP log for the given session.
|
||||
func httpLogRequest(sessionID uuid.UUID, seq int32) *agentproto.ReportBoundaryLogsRequest {
|
||||
return &agentproto.ReportBoundaryLogsRequest{
|
||||
SessionId: sessionID.String(),
|
||||
ConfinedProcessName: "claude-code",
|
||||
Logs: []*agentproto.BoundaryLog{
|
||||
{
|
||||
Allowed: true,
|
||||
Time: timestamppb.New(dbtime.Now()),
|
||||
SequenceNumber: seq,
|
||||
Resource: &agentproto.BoundaryLog_HttpRequest_{
|
||||
HttpRequest: &agentproto.BoundaryLog_HttpRequest{
|
||||
Method: "GET",
|
||||
Url: "https://example.com",
|
||||
MatchedRule: "domain=example.com",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// TestReportBoundaryLogsSessionGuard verifies that once a session has been
|
||||
// ensured, later batches from the same connection skip the existence check and
|
||||
// insert entirely, touching the database only for the logs themselves.
|
||||
func TestReportBoundaryLogsSessionGuard(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ctrl := gomock.NewController(t)
|
||||
db := dbmock.NewMockStore(ctrl)
|
||||
|
||||
sessionID := uuid.New()
|
||||
api := &agentapi.BoundaryLogsAPI{
|
||||
Log: testutil.Logger(t),
|
||||
Database: db,
|
||||
AgentID: uuid.New(),
|
||||
WorkspaceID: uuid.New(),
|
||||
OwnerID: uuid.New(),
|
||||
TemplateID: uuid.New(),
|
||||
TemplateVersionID: uuid.New(),
|
||||
}
|
||||
|
||||
// The session is inserted once, even though two batches arrive. Times(1)
|
||||
// fails the test if the guard does not suppress the second ensure attempt.
|
||||
// Logs insert on every batch.
|
||||
db.EXPECT().InsertBoundarySession(gomock.Any(), gomock.Any()).
|
||||
Return(database.BoundarySession{}, nil).Times(1)
|
||||
db.EXPECT().InsertBoundaryLogs(gomock.Any(), gomock.Any()).
|
||||
Return([]database.BoundaryLog{}, nil).Times(2)
|
||||
|
||||
_, err := api.ReportBoundaryLogs(context.Background(), httpLogRequest(sessionID, 0))
|
||||
require.NoError(t, err)
|
||||
_, err = api.ReportBoundaryLogs(context.Background(), httpLogRequest(sessionID, 1))
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
// TestReportBoundaryLogsSessionRetriedOnError verifies that when ensureSession
|
||||
// fails, the guard is not set, so the next batch retries the existence check.
|
||||
func TestReportBoundaryLogsSessionRetriedOnError(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
ctrl := gomock.NewController(t)
|
||||
db := dbmock.NewMockStore(ctrl)
|
||||
|
||||
sessionID := uuid.New()
|
||||
api := &agentapi.BoundaryLogsAPI{
|
||||
// The first batch deliberately triggers a transient error, which
|
||||
// logs at ERROR level. Ignore errors so slogtest does not fail.
|
||||
Log: slogtest.Make(t, &slogtest.Options{IgnoreErrors: true}),
|
||||
Database: db,
|
||||
AgentID: uuid.New(),
|
||||
WorkspaceID: uuid.New(),
|
||||
OwnerID: uuid.New(),
|
||||
TemplateID: uuid.New(),
|
||||
TemplateVersionID: uuid.New(),
|
||||
}
|
||||
|
||||
// First batch: insert fails transiently, so the session is not marked
|
||||
// ensured. Second batch: insert is retried and succeeds. Logs insert on both.
|
||||
gomock.InOrder(
|
||||
db.EXPECT().InsertBoundarySession(gomock.Any(), gomock.Any()).
|
||||
Return(database.BoundarySession{}, sql.ErrConnDone),
|
||||
db.EXPECT().InsertBoundarySession(gomock.Any(), gomock.Any()).
|
||||
Return(database.BoundarySession{}, nil),
|
||||
)
|
||||
db.EXPECT().InsertBoundaryLogs(gomock.Any(), gomock.Any()).
|
||||
Return([]database.BoundaryLog{}, nil).Times(2)
|
||||
|
||||
_, err := api.ReportBoundaryLogs(context.Background(), httpLogRequest(sessionID, 0))
|
||||
require.NoError(t, err)
|
||||
_, err = api.ReportBoundaryLogs(context.Background(), httpLogRequest(sessionID, 1))
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user