Skip to content

fix(agent): redact error event messages #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
XnLemon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(agent): redact error event messages #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion agent/n8n/n8n_agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"trpc.group/trpc-go/trpc-agent-go/agent"
"trpc.group/trpc-go/trpc-agent-go/event"
"trpc.group/trpc-go/trpc-agent-go/model"
"trpc.group/trpc-go/trpc-agent-go/platform"
"trpc.group/trpc-go/trpc-agent-go/tool"
)

Expand Down Expand Up @@ -220,12 +221,20 @@ func (a *N8nAgent) sendErrorEvent(
a.name,
event.WithResponse(&model.Response{
Error: &model.ResponseError{
Message: errorMessage,
Message: redactAgentErrorMessage(errorMessage),
},
}),
))
}

func redactAgentErrorMessage(errorMessage string) string {
redactor, err := platform.NewRedactor()
if err != nil {
return errorMessage
}
return redactor.Redact(errorMessage)
}

func (a *N8nAgent) sendFinalStreamingEvent(
ctx context.Context,
eventChan chan<- *event.Event,
Expand Down
20 changes: 17 additions & 3 deletions agent/n8n/n8n_agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"context"
"fmt"
"net/http"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -222,7 +223,12 @@ func TestN8nAgent_SendErrorEvent(t *testing.T) {
}

eventChan := make(chan *event.Event, 1)
a.sendErrorEvent(context.Background(), eventChan, invocation, "test error message")
a.sendErrorEvent(
context.Background(),
eventChan,
invocation,
"request failed Authorization: ApiKey raw-token\napi_key=sk-1234567890abcdef\nCookie: session=abc; sid=def",
)
close(eventChan)

evt := <-eventChan
Expand All @@ -235,8 +241,16 @@ func TestN8nAgent_SendErrorEvent(t *testing.T) {
if evt.Response.Error == nil {
t.Fatal("expected error in response")
}
if evt.Response.Error.Message != "test error message" {
t.Errorf("expected error message 'test error message', got: %s", evt.Response.Error.Message)
message := evt.Response.Error.Message
for _, secret := range []string{"raw-token", "sk-1234567890abcdef", "session=abc", "sid=def"} {
if strings.Contains(message, secret) {
t.Errorf("expected error message to redact %q, got: %s", secret, message)
}
}
for _, redacted := range []string{"Authorization: ****", "api_key=****", "Cookie: ****"} {
if !strings.Contains(message, redacted) {
t.Errorf("expected error message to contain %q, got: %s", redacted, message)
}
}
if evt.Author != "test-agent" {
t.Errorf("expected author 'test-agent', got: %s", evt.Author)
Expand Down
11 changes: 10 additions & 1 deletion agent/weknora/weknora_agent.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"trpc.group/trpc-go/trpc-agent-go/agent"
"trpc.group/trpc-go/trpc-agent-go/event"
"trpc.group/trpc-go/trpc-agent-go/model"
"trpc.group/trpc-go/trpc-agent-go/platform"
"trpc.group/trpc-go/trpc-agent-go/session"
"trpc.group/trpc-go/trpc-agent-go/tool"
)
Expand Down Expand Up @@ -67,12 +68,20 @@ func (r *WeKnoraAgent) sendErrorEvent(ctx context.Context, eventChan chan<- *eve
r.name,
event.WithResponse(&model.Response{
Error: &model.ResponseError{
Message: errorMessage,
Message: redactAgentErrorMessage(errorMessage),
},
}),
))
}

func redactAgentErrorMessage(errorMessage string) string {
redactor, err := platform.NewRedactor()
if err != nil {
return errorMessage
}
return redactor.Redact(errorMessage)
}

// Run implements the Agent interface
func (r *WeKnoraAgent) Run(ctx context.Context, invocation *agent.Invocation) (<-chan *event.Event, error) {
if invocation != nil && invocation.RunOptions.Stream != nil && !*invocation.RunOptions.Stream {
Expand Down
20 changes: 17 additions & 3 deletions agent/weknora/weknora_agent_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"fmt"
"net/http"
"net/http/httptest"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -224,7 +225,12 @@ func TestWeKnoraAgent_SendErrorEvent(t *testing.T) {
}

eventChan := make(chan *event.Event, 1)
weknoraAgent.sendErrorEvent(context.Background(), eventChan, invocation, "test error message")
weknoraAgent.sendErrorEvent(
context.Background(),
eventChan,
invocation,
"weknora agent error Authorization: Bearer raw-token\napi_key=sk-1234567890abcdef\nCookie: session=abc; sid=def",
)
close(eventChan)

evt := <-eventChan
Expand All @@ -237,8 +243,16 @@ func TestWeKnoraAgent_SendErrorEvent(t *testing.T) {
if evt.Response.Error == nil {
t.Fatal("expected error in response")
}
if evt.Response.Error.Message != "test error message" {
t.Errorf("expected error message 'test error message', got: %s", evt.Response.Error.Message)
message := evt.Response.Error.Message
for _, secret := range []string{"raw-token", "sk-1234567890abcdef", "session=abc", "sid=def"} {
if strings.Contains(message, secret) {
t.Errorf("expected error message to redact %q, got: %s", secret, message)
}
}
for _, redacted := range []string{"Authorization: ****", "api_key=****", "Cookie: ****"} {
if !strings.Contains(message, redacted) {
t.Errorf("expected error message to contain %q, got: %s", redacted, message)
}
}
if evt.Author != "test-agent" {
t.Errorf("expected author 'test-agent', got: %s", evt.Author)
Expand Down
Loading