-
Notifications
You must be signed in to change notification settings - Fork 60
api,sink: mask sink uri secrets in errors #5363
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.
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
asddongmen
wants to merge
4
commits into
pingcap:release-8.5
Choose a base branch
from
asddongmen:backport/pr-5093-release-8.5
base: release-8.5
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ tools/bin | |
| tools/include | ||
| tools/workload/bin | ||
|
|
||
| .design | ||
| .issue | ||
| .vscode | ||
| .idea | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright 2026 PingCAP, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package v2 | ||
|
|
||
| import ( | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| perrors "github.com/pingcap/errors" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestMaskSinkURIForError(t *testing.T) { | ||
| sinkURI := "kafka://127.0.0.1:9092/topic?protocol=canal-json" + | ||
| "&sasl-user=ticdc&sasl-password=verysecure&secret-access-key=rawsecret" | ||
|
|
||
| maskedURI := maskSinkURIForError(sinkURI) | ||
| require.NotContains(t, maskedURI, "verysecure") | ||
| require.NotContains(t, maskedURI, "rawsecret") | ||
| require.Contains(t, maskedURI, "sasl-password=xxxxx") | ||
| require.Contains(t, maskedURI, "secret-access-key=xxxxx") | ||
| require.Contains(t, maskedURI, "sasl-user=ticdc") | ||
|
|
||
| invalidURI := "mysql://root:verysecure@127.0.0.1/%zz" | ||
| require.Equal(t, "<invalid uri>", maskSinkURIForError(invalidURI)) | ||
|
|
||
| err := genSinkURIInvalidError(invalidURI, mustParseURLError(t, invalidURI)) | ||
| require.NotContains(t, err.Error(), "verysecure") | ||
| require.Contains(t, err.Error(), "<invalid uri>") | ||
| require.Contains(t, err.Error(), `parse "<invalid uri>"`) | ||
| require.Contains(t, err.Error(), "invalid URL escape") | ||
|
|
||
| err = genSinkURIInvalidError(invalidURI, perrors.Trace(mustParseURLError(t, invalidURI))) | ||
| require.NotContains(t, err.Error(), "verysecure") | ||
| require.Contains(t, err.Error(), "<invalid uri>") | ||
| require.Contains(t, err.Error(), `parse "<invalid uri>"`) | ||
| require.Contains(t, err.Error(), "invalid URL escape") | ||
| } | ||
|
|
||
| func mustParseURLError(t *testing.T, rawURL string) error { | ||
| t.Helper() | ||
|
|
||
| _, err := url.Parse(rawURL) | ||
| require.Error(t, err) | ||
| return err | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| // Copyright 2026 PingCAP, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package sink | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/pingcap/ticdc/pkg/common" | ||
| "github.com/pingcap/ticdc/pkg/config" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestUnknownSchemeMasksSensitiveSinkURI(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| changefeedID := common.NewChangefeedID(common.DefaultKeyspaceName) | ||
| cfg := &config.ChangefeedConfig{ | ||
| SinkURI: "unknown://127.0.0.1:9092/topic?sasl-password=verysecure&access-key=rawkey", | ||
| } | ||
|
|
||
| _, err := New(context.Background(), cfg, changefeedID) | ||
| require.Error(t, err) | ||
| requireMaskedSinkURIError(t, err) | ||
|
|
||
| err = Verify(context.Background(), cfg, changefeedID) | ||
| require.Error(t, err) | ||
| requireMaskedSinkURIError(t, err) | ||
| } | ||
|
|
||
| func TestParseErrorMasksSensitiveSinkURI(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| changefeedID := common.NewChangefeedID(common.DefaultKeyspaceName) | ||
| cfg := &config.ChangefeedConfig{ | ||
| SinkURI: "mysql://root:verysecure@127.0.0.1/%zz", | ||
| } | ||
|
|
||
| _, err := New(context.Background(), cfg, changefeedID) | ||
| require.Error(t, err) | ||
| requireInvalidSinkURIError(t, err) | ||
|
|
||
| err = Verify(context.Background(), cfg, changefeedID) | ||
| require.Error(t, err) | ||
| requireInvalidSinkURIError(t, err) | ||
| } | ||
|
|
||
| func requireMaskedSinkURIError(t *testing.T, err error) { | ||
| t.Helper() | ||
|
|
||
| errMsg := err.Error() | ||
| require.NotContains(t, errMsg, "verysecure") | ||
| require.NotContains(t, errMsg, "rawkey") | ||
| require.Contains(t, errMsg, "sasl-password=xxxxx") | ||
| require.Contains(t, errMsg, "access-key=xxxxx") | ||
| } | ||
|
|
||
| func requireInvalidSinkURIError(t *testing.T, err error) { | ||
| t.Helper() | ||
|
|
||
| errMsg := err.Error() | ||
| require.NotContains(t, errMsg, "verysecure") | ||
| require.Contains(t, errMsg, "<invalid uri>") | ||
| require.Contains(t, errMsg, `parse "<invalid uri>"`) | ||
| require.Contains(t, errMsg, "invalid URL escape") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In Go (and especially TiCDC), errors are frequently wrapped using
errors.Traceor other wrapping mechanisms. The current implementation ofMaskSensitiveDataInURLErroruses a direct type assertionerr.(*url.Error), which will fail to detect and mask the sensitive URL if the error is wrapped.We should traverse the error chain to find and mask the nested
*url.Errorin-place, ensuring that sensitive credentials are never leaked even when the error is wrapped.