Repository navigation
Expand file tree
/
Copy pathcommand_approval_test.go
More file actions
178 lines (172 loc) · 8.39 KB
/
Copy pathcommand_approval_test.go
File metadata and controls
178 lines (172 loc) · 8.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
package service
import (
"context"
"encoding/json"
"testing"
"time"
"github.com/jumpserver/kael/internal/domain"
"github.com/jumpserver/kael/internal/event"
"github.com/jumpserver/kael/internal/policy"
"github.com/jumpserver/kael/internal/ports"
"github.com/jumpserver/kael/internal/store"
)
func TestCommandApprovalModes(t *testing.T) {
for _, tc := range []struct {
name, mode, command, commandPolicy, explicitRisk string
force, approve, read bool
}{
{"default df", "", "df -h", policy.ShellReadOnlyPolicy, "", false, false, true},
{"auto du", "auto", "du -sh /var/log", policy.ShellReadOnlyPolicy, "", false, false, true},
{"auto pipeline", "auto", "du -sh /var/log/* 2>/dev/null | sort -hr | head -n 20", policy.ShellReadOnlyPolicy, "", false, false, true},
{"auto mutation", "auto", "df -h; rm file", policy.ShellReadOnlyPolicy, "", false, true, false},
{"auto redirection", "auto", "df -h > /tmp/report", policy.ShellReadOnlyPolicy, "", false, true, false},
{"always read", "always", "df -h", policy.ShellReadOnlyPolicy, "", false, true, true},
{"never mutation", "never", "rm file", policy.ShellReadOnlyPolicy, "", false, false, false},
{"legacy registration", "auto", "df -h", "", "", false, true, false},
{"unknown policy", "auto", "df -h", "unsupported", "", false, true, false},
{"explicit confirmation", "auto", "df -h", policy.ShellReadOnlyPolicy, "", true, true, false},
{"explicit risk", "auto", "df -h", policy.ShellReadOnlyPolicy, "dangerous", false, true, false},
} {
t.Run(tc.name, func(t *testing.T) {
ctx := context.Background()
s := &Service{store: store.NewMemory(), bus: event.NewBus(), panelLease: time.Minute, registrationLease: time.Minute, eventRetention: time.Hour}
principal := domain.Principal{SubjectID: "user", OrganizationID: "org"}
if err := s.store.Transaction(ctx, func(tx ports.Tx) error {
return tx.CreateConversation(&domain.Conversation{ID: "conversation", SubjectID: principal.SubjectID, OrganizationID: principal.OrganizationID, Kind: "capability", Profile: "terminal", Status: "active"})
}); err != nil {
t.Fatal(err)
}
panel, err := s.CreatePanel(ctx, principal, CreatePanelRequest{ConversationID: "conversation", ClientInstanceID: "resource", ApprovalMode: tc.mode})
if err != nil {
t.Fatal(err)
}
registry, err := s.ReplaceRegistrations(ctx, principal, panel.ID, ReplaceRegistrationsRequest{Registrations: []RegistrationDefinition{{
Name: "custom_shell", InputSchema: json.RawMessage(`{"type":"object","properties":{"command":{"type":"string"}},"required":["command"],"additionalProperties":false}`),
Annotations: map[string]any{"readOnlyHint": false, "openWorldHint": true}, Meta: map[string]any{policy.CommandPolicyMetaKey: tc.commandPolicy}, Risk: tc.explicitRisk, RequiresConfirmation: tc.force,
}}})
if err != nil {
t.Fatal(err)
}
registration := registry.Registrations[0]
if registration.Risk != "dangerous" || !registration.RequiresConfirmation {
t.Fatal("generic shell registration lost its conservative default")
}
run := &domain.Run{ID: "run", ConversationID: panel.ConversationID, PanelSessionID: panel.ID, SubjectID: principal.SubjectID, OrganizationID: principal.OrganizationID, RegistryRevision: registry.RegistryRevision, State: "running"}
if err = s.store.Transaction(ctx, func(tx ports.Tx) error { return tx.CreateRun(run) }); err != nil {
t.Fatal(err)
}
args, _ := json.Marshal(map[string]any{"command": tc.command})
call, approval, err := s.prepareToolCall(ctx, run, registration, args, 0)
if err != nil {
t.Fatal(err)
}
if (approval != nil) != tc.approve || call.RequiresConfirmation != tc.approve || (call.Risk == "read") != tc.read {
t.Fatalf("call=%+v approval=%+v", call, approval)
}
if approval != nil {
if _, _, err = s.DecideApproval(ctx, principal, approval.ID, ApprovalDecisionRequest{Decision: "approve"}); err != nil {
t.Fatal(err)
}
}
if err = s.dispatchToolCall(ctx, run, call); err != nil {
t.Fatalf("dispatch: %v", err)
}
deliveries, _, err := s.Deliveries(ctx, principal, panel.ID, 0, 100)
if err != nil {
t.Fatal(err)
}
approvals, dispatched := 0, 0
for _, delivery := range deliveries {
if delivery.Type == "approval.required" {
approvals++
}
if delivery.Type == "tool.call" {
dispatched++
var payload struct {
Risk string `json:"risk"`
}
if json.Unmarshal(delivery.Payload, &payload) != nil || payload.Risk != call.Risk {
t.Fatal("dispatch did not carry the invocation risk")
}
}
}
if (approvals == 1) != tc.approve || dispatched != 1 {
t.Fatalf("approval events=%d dispatch events=%d", approvals, dispatched)
}
})
}
}
func TestRememberedCommandApprovalIsExactAndPanelScoped(t *testing.T) {
ctx := context.Background()
s := &Service{store: store.NewMemory(), bus: event.NewBus(), panelLease: time.Minute, registrationLease: time.Minute, eventRetention: time.Hour}
principal := domain.Principal{SubjectID: "user", OrganizationID: "org"}
if err := s.store.Transaction(ctx, func(tx ports.Tx) error {
return tx.CreateConversation(&domain.Conversation{ID: "conversation", SubjectID: principal.SubjectID, OrganizationID: principal.OrganizationID, Kind: "capability", Profile: "terminal", Status: "active"})
}); err != nil {
t.Fatal(err)
}
panel, err := s.CreatePanel(ctx, principal, CreatePanelRequest{ConversationID: "conversation", ClientInstanceID: "resource", ApprovalMode: "auto"})
if err != nil {
t.Fatal(err)
}
registry, err := s.ReplaceRegistrations(ctx, principal, panel.ID, ReplaceRegistrationsRequest{Registrations: []RegistrationDefinition{
{
Name: "execute_shell", InputSchema: json.RawMessage(`{"type":"object","properties":{"command":{"type":"string"}},"required":["command"],"additionalProperties":false}`),
Annotations: map[string]any{"readOnlyHint": false, "openWorldHint": true}, Meta: map[string]any{policy.CommandPolicyMetaKey: policy.ShellReadOnlyPolicy},
},
{
Name: "other_tool", InputSchema: json.RawMessage(`{"type":"object","properties":{"command":{"type":"string"}},"required":["command"],"additionalProperties":false}`),
Annotations: map[string]any{"readOnlyHint": false, "openWorldHint": true},
},
}})
if err != nil {
t.Fatal(err)
}
registration := registry.Registrations[0]
prepare := func(registration domain.Registration, runID, command string) (*domain.ToolCall, *domain.Approval) {
run := &domain.Run{ID: runID, ConversationID: panel.ConversationID, PanelSessionID: panel.ID, SubjectID: principal.SubjectID, OrganizationID: principal.OrganizationID, RegistryRevision: registry.RegistryRevision, State: "running"}
if createErr := s.store.Transaction(ctx, func(tx ports.Tx) error { return tx.CreateRun(run) }); createErr != nil {
t.Fatal(createErr)
}
args, _ := json.Marshal(map[string]any{"command": command})
call, approval, prepareErr := s.prepareToolCall(ctx, run, registration, args, 0)
if prepareErr != nil {
t.Fatal(prepareErr)
}
return call, approval
}
_, first := prepare(registration, "run-1", "rm /tmp/report")
if first == nil {
t.Fatal("mutating command did not require initial approval")
}
if _, _, err = s.DecideApproval(ctx, principal, first.ID, ApprovalDecisionRequest{Decision: "approve", Remember: true}); err != nil {
t.Fatal(err)
}
call, repeated := prepare(registration, "run-2", "rm /tmp/report")
if repeated != nil || call.RequiresConfirmation {
t.Fatal("exact remembered command required approval again")
}
if _, changed := prepare(registration, "run-3", "rm /tmp/other"); changed == nil {
t.Fatal("different command reused a remembered approval")
}
_, otherApproval := prepare(registry.Registrations[1], "run-other", "rm /tmp/report")
if otherApproval == nil {
t.Fatal("unclassified tool did not require approval")
}
if _, _, rememberErr := s.DecideApproval(ctx, principal, otherApproval.ID, ApprovalDecisionRequest{Decision: "approve", Remember: true}); rememberErr == nil {
t.Fatal("unclassified tool accepted a remembered approval")
}
if err = s.store.Transaction(ctx, func(tx ports.Tx) error {
current, panelErr := tx.Panel(panel.ID, principal, true)
if panelErr != nil {
return panelErr
}
current.ApprovalMode = "always"
return tx.SavePanel(current)
}); err != nil {
t.Fatal(err)
}
if _, forced := prepare(registration, "run-4", "rm /tmp/report"); forced == nil {
t.Fatal("always mode reused a remembered approval")
}
}