Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
28 changes: 28 additions & 0 deletions .chloggen/fix-configgrpc-perrpc-auth-swallow.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. receiver/otlp)
component: pkg/config/configgrpc

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Return the error when a gRPC client auth extension's PerRPCCredentials() fails instead of silently swallowing it

# One or more tracking issues or pull requests related to the change
issues: [15657]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
Previously a failure from the configured client auth extension's PerRPCCredentials() was
discarded and getGrpcDialOptions returned a nil error, so the gRPC client was built without
the intended per-RPC credentials instead of failing.

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
2 changes: 1 addition & 1 deletion config/configgrpc/configgrpc.go
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ func (cc *ClientConfig) getGrpcDialOptions(

perRPCCredentials, perr := grpcAuthenticator.PerRPCCredentials()
if perr != nil {
return nil, err
return nil, perr
}
opts = append(opts, grpc.WithPerRPCCredentials(perRPCCredentials))
}
Expand Down
14 changes: 14 additions & 0 deletions config/configgrpc/configgrpc_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,20 @@ func TestAllGrpcClientSettings(t *testing.T) {
}
}

func TestGetGRPCDialOptionsPerRPCCredentialsError(t *testing.T) {
cc := ClientConfig{
Endpoint: "localhost:1234",
TLS: configtls.ClientConfig{Insecure: true},
Auth: configoptional.Some(configauth.Config{AuthenticatorID: testAuthID}),
}
extensions := map[component.ID]component.Component{
testAuthID: extensionauthtest.NewErr(errors.New("per-rpc credentials failure")),
}
_, err := cc.getGrpcDialOptions(context.Background(), extensions, componenttest.NewNopTelemetrySettings(), []ToClientConnOption{})
require.Error(t, err)
assert.ErrorContains(t, err, "per-rpc credentials failure")
}

func TestSanitizeEndpoint(t *testing.T) {
cfg := NewDefaultClientConfig()
cfg.Endpoint = "dns://authority/backend.example.com:4317"
Expand Down
Loading