Skip to content

mysql/gcpmysql: redact password from connection error #3753

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
vangent merged 1 commit into from
Jul 23, 2026
Merged

mysql/gcpmysql: redact password from connection error #3753

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
2 changes: 1 addition & 1 deletion mysql/gcpmysql/gcpmysql.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func (o *lazyCredsOpener) OpenMySQLURL(ctx context.Context, u *url.URL) (*sql.DB
o.opener = &URLOpener{CertSource: certSource}
})
if o.err != nil {
return nil, fmt.Errorf("gcpmysql open %v: %v", u, o.err)
return nil, fmt.Errorf("gcpmysql open %v: %v", u.Redacted(), o.err)
}
return o.opener.OpenMySQLURL(ctx, u)
}
Expand Down
17 changes: 17 additions & 0 deletions mysql/gcpmysql/gcpmysql_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,30 @@ import (
"fmt"
"net/url"
"reflect"
"strings"
"testing"

drvr "github.com/go-sql-driver/mysql"
"gocloud.dev/internal/testing/terraform"
"gocloud.dev/mysql"
)

func TestOpenMySQLURLDoesNotLeakPasswordOnCredentialsFailure(t *testing.T) {
const password = "S3cr3tDBPassw0rd"
u, err := url.Parse(fmt.Sprintf("gcpmysql://dbuser:%s@myproject/us-central1/myinstance/mydb", password))
if err != nil {
t.Fatalf("failed to parse URL: %v", err)
}
o := new(lazyCredsOpener)
_, err = o.OpenMySQLURL(context.Background(), u)
if err == nil {
t.Skip("Application Default Credentials are available in this environment; skipping negative-path test")
}
if strings.Contains(err.Error(), password) {
t.Errorf("OpenMySQLURL error contains the raw password: %q", err.Error())
}
}

func TestOpen(t *testing.T) {
// This test will be skipped unless the project is set up with Terraform.
// Before running go test, run in this directory:
Expand Down
Loading