Skip to content

feat: support protobuf in trace RBAC #924

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

Merged
pavolloffay merged 1 commit into from
Aug 26, 2026
+211 −13
Merged

feat: support protobuf in trace RBAC #924

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
72 changes: 59 additions & 13 deletions api/traces/v1/trace_rbac.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/go-kit/log"
"github.com/go-kit/log/level"
"github.com/golang/protobuf/jsonpb" // nolint:staticcheck
"github.com/golang/protobuf/proto" //nolint:staticcheck
"github.com/grafana/tempo/pkg/tempopb"
commonv1 "github.com/grafana/tempo/pkg/tempopb/common/v1"
tracev1 "github.com/grafana/tempo/pkg/tempopb/trace/v1"
Expand All @@ -20,6 +21,9 @@ import (
)

const (
HeaderContentType = "Content-Type"
ContentTypeProtobuf = "application/protobuf"
ContentTypeJSON = "application/json"
namespaceAttributeKey = "k8s.namespace.name"
serviceAttributeKey = "service.name"
)
Expand Down Expand Up @@ -80,6 +84,29 @@ func WithTraceQLNamespaceSelectAndForbidOtherAPIs(enabled bool) func(http.Handle
}
}

func unmarshal(response *http.Response, body []byte, pb proto.Message) error {
switch response.Header.Get(HeaderContentType) {
case ContentTypeProtobuf:
return proto.Unmarshal(body, pb)
default:
return (&jsonpb.Unmarshaler{}).Unmarshal(bytes.NewReader(body), pb)
}
}

func marshal(response *http.Response, buf *bytes.Buffer, pb proto.Message) error {
switch response.Header.Get(HeaderContentType) {
case ContentTypeProtobuf:
b, err := proto.Marshal(pb)
if err != nil {
return err
}
buf.Write(b)
return nil
default:
return (&jsonpb.Marshaler{}).Marshal(buf, pb)
}
}

func responseRBACModifier(log log.Logger) func(response *http.Response) error {
return func(response *http.Response) error {
request := response.Request
Expand All @@ -101,45 +128,64 @@ func responseRBACModifier(log log.Logger) func(response *http.Response) error {
responseBuffer := &bytes.Buffer{}
switch {
case routeQueryV1.MatchString(request.URL.Path):
// do not use unmarshal here, because we must use
// UnmarshalFromJSONV1 instead of (&jsonpb.Unmarshaler{}).Unmarshal
trace := &tempopb.Trace{}
err = tempopb.UnmarshalFromJSONV1(b, trace)
switch response.Header.Get(HeaderContentType) {
case ContentTypeProtobuf:
err = proto.Unmarshal(b, trace)
default:
err = tempopb.UnmarshalFromJSONV1(b, trace)
}
if err != nil {
return err
}

trace = traceRBAC(allowedNamespaces, trace)

traceResponseBody, err := tempopb.MarshalToJSONV1(trace)
if err != nil {
return err
// do not use marshal here, because we must use
// MarshalToJSONV1 instead of (&jsonpb.Marshaler{}).Marshal
switch response.Header.Get(HeaderContentType) {
case ContentTypeProtobuf:
var out []byte
out, err = proto.Marshal(trace)
if err != nil {
return err
}
responseBuffer = bytes.NewBuffer(out)
default:
var traceResponseBody []byte
traceResponseBody, err = tempopb.MarshalToJSONV1(trace)
if err != nil {
return err
}
responseBuffer = bytes.NewBuffer(traceResponseBody)
}
responseBuffer = bytes.NewBuffer(traceResponseBody)

case routeQueryV2.MatchString(request.URL.Path):
traceByIDResponse := &tempopb.TraceByIDResponse{}
unmarshaller := jsonpb.Unmarshaler{}
err = unmarshaller.Unmarshal(bytes.NewReader(b), traceByIDResponse)
err = unmarshal(response, b, traceByIDResponse)
if err != nil {
return err
}

traceByIDResponse.Trace = traceRBAC(allowedNamespaces, traceByIDResponse.Trace)

marshaller := jsonpb.Marshaler{}
err = marshaller.Marshal(responseBuffer, traceByIDResponse)
err = marshal(response, responseBuffer, traceByIDResponse)
if err != nil {
return err
}

case routeSearch.MatchString(request.URL.Path):
searchResponse := &tempopb.SearchResponse{}
unmarshaller := jsonpb.Unmarshaler{}
err = unmarshaller.Unmarshal(bytes.NewReader(b), searchResponse)
err = unmarshal(response, b, searchResponse)
if err != nil {
return err
}

searchResponse = searchResponseRBAC(allowedNamespaces, searchResponse)

marshaller := jsonpb.Marshaler{}
err = marshaller.Marshal(responseBuffer, searchResponse)
err = marshal(response, responseBuffer, searchResponse)
if err != nil {
return err
}
Expand Down
152 changes: 152 additions & 0 deletions api/traces/v1/trace_rbac_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package v1

import (
"bytes"
"context"
"fmt"
"io"
Expand All @@ -12,6 +13,7 @@ import (
"testing"

"github.com/go-kit/log"
"github.com/golang/protobuf/proto" //nolint:staticcheck
"github.com/grafana/tempo/pkg/tempopb"
commonv1 "github.com/grafana/tempo/pkg/tempopb/common/v1"
resourcev1 "github.com/grafana/tempo/pkg/tempopb/resource/v1"
Expand Down Expand Up @@ -830,3 +832,153 @@ func TestResponseRBACModifier(t *testing.T) {
assert.Empty(t, resp.Header["Content-Encoding"])
})
}

func makeProtobufResponse(ctx context.Context, statusCode int, path string, pb proto.Message) *http.Response {
b, err := proto.Marshal(pb)
if err != nil {
panic(err)
}
return &http.Response{
StatusCode: statusCode,
Header: http.Header{"Content-Type": []string{"application/protobuf"}},
Body: io.NopCloser(bytes.NewReader(b)),
Request: (&http.Request{URL: &url.URL{Path: path}}).WithContext(ctx),
}
}

func TestResponseRBACModifierProtobuf(t *testing.T) {
modifier := responseRBACModifier(log.NewNopLogger())
ctx := contextWithAllowedNamespaces(t, []string{"allowed-ns"})

t.Run("v1 trace endpoint protobuf", func(t *testing.T) {
trace := &tempopb.Trace{
ResourceSpans: []*tracev1.ResourceSpans{
{
Resource: &resourcev1.Resource{
Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "allowed-ns"),
},
},
ScopeSpans: []*tracev1.ScopeSpans{
{Scope: &commonv1.InstrumentationScope{}, Spans: []*tracev1.Span{
{Attributes: []*commonv1.KeyValue{createStringAttribute("span1", "val")}},
}},
},
},
{
Resource: &resourcev1.Resource{
Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "blocked-ns"),
createStringAttribute("service.name", "blocked-svc"),
},
},
ScopeSpans: []*tracev1.ScopeSpans{
{Scope: &commonv1.InstrumentationScope{}, Spans: []*tracev1.Span{
{Attributes: []*commonv1.KeyValue{createStringAttribute("span2", "val")}},
}},
},
},
},
}

resp := makeProtobufResponse(ctx, http.StatusOK, "/api/traces/abc123", trace)
require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
result := &tempopb.Trace{}
require.NoError(t, proto.Unmarshal(body, result))

assert.Len(t, result.ResourceSpans, 2)
assert.Len(t, result.ResourceSpans[0].ScopeSpans[0].Spans[0].Attributes, 1, "allowed span keeps attributes")
assert.Empty(t, result.ResourceSpans[1].ScopeSpans[0].Spans[0].Attributes, "blocked span attributes stripped")
assert.Empty(t, result.ResourceSpans[1].ScopeSpans[0].Spans[0].Events, "blocked span events stripped")
assert.Len(t, result.ResourceSpans[1].Resource.Attributes, 2, "blocked resource keeps namespace and service.name")
assert.Equal(t, "k8s.namespace.name", result.ResourceSpans[1].Resource.Attributes[0].Key)
assert.Equal(t, "service.name", result.ResourceSpans[1].Resource.Attributes[1].Key)
assert.Equal(t, []string{fmt.Sprint(len(body))}, resp.Header["Content-Length"])
assert.Empty(t, resp.Header["Content-Encoding"])
})

t.Run("v2 trace endpoint protobuf", func(t *testing.T) {
traceByIDResp := &tempopb.TraceByIDResponse{
Trace: &tempopb.Trace{
ResourceSpans: []*tracev1.ResourceSpans{
{
Resource: &resourcev1.Resource{
Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "allowed-ns"),
},
},
ScopeSpans: []*tracev1.ScopeSpans{
{Scope: &commonv1.InstrumentationScope{}, Spans: []*tracev1.Span{
{Attributes: []*commonv1.KeyValue{createStringAttribute("span1", "val")}},
}},
},
},
{
Resource: &resourcev1.Resource{
Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "blocked-ns"),
createStringAttribute("service.name", "blocked-svc"),
},
},
ScopeSpans: []*tracev1.ScopeSpans{
{Scope: &commonv1.InstrumentationScope{}, Spans: []*tracev1.Span{
{Attributes: []*commonv1.KeyValue{createStringAttribute("span2", "val")}},
}},
},
},
},
},
}

resp := makeProtobufResponse(ctx, http.StatusOK, "/api/v2/traces/abc123", traceByIDResp)
require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
result := &tempopb.TraceByIDResponse{}
require.NoError(t, proto.Unmarshal(body, result))

assert.Len(t, result.Trace.ResourceSpans[0].ScopeSpans[0].Spans[0].Attributes, 1, "allowed span keeps attributes")
assert.Empty(t, result.Trace.ResourceSpans[1].ScopeSpans[0].Spans[0].Attributes, "blocked span attributes stripped")
assert.Equal(t, []string{fmt.Sprint(len(body))}, resp.Header["Content-Length"])
assert.Empty(t, resp.Header["Content-Encoding"])
})

t.Run("search endpoint protobuf", func(t *testing.T) {
searchResp := &tempopb.SearchResponse{
Traces: []*tempopb.TraceSearchMetadata{
{
SpanSets: []*tempopb.SpanSet{
{
Spans: []*tempopb.Span{
{Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "allowed-ns"),
createStringAttribute("extra", "val"),
}},
{Attributes: []*commonv1.KeyValue{
createStringAttribute("k8s.namespace.name", "blocked-ns"),
createStringAttribute("extra", "val"),
}},
},
},
},
},
},
}

resp := makeProtobufResponse(ctx, http.StatusOK, "/api/search", searchResp)
require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
result := &tempopb.SearchResponse{}
require.NoError(t, proto.Unmarshal(body, result))

spans := result.Traces[0].SpanSets[0].Spans
assert.Len(t, spans[0].Attributes, 2, "allowed span keeps all attributes")
assert.Len(t, spans[1].Attributes, 1, "blocked span keeps only namespace")
assert.Equal(t, "k8s.namespace.name", spans[1].Attributes[0].Key)
assert.Equal(t, []string{fmt.Sprint(len(body))}, resp.Header["Content-Length"])
assert.Empty(t, resp.Header["Content-Encoding"])
})
}