Skip to content
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

Ensure loggableDSN scrubs passwords in different ways #648

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
55 changes: 55 additions & 0 deletions cmd/postgres_exporter/postgres_exporter_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -421,3 +421,58 @@ func (s *FunctionalSuite) TestParseUserQueries(c *C) {
}
}
}

func (s *FunctionalSuite) TestLoggableDSN(c *C) {
type TestCase struct {
input string
expected string
}

cases := []TestCase{
{
input: "host=host.example.com user=postgres port=5432 password=s3cr3t",
expected: "host=host.example.com user=postgres port=5432 password=PASSWORD_REMOVED",
},

{
input: "host=host.example.com user=postgres port=5432 password=\"s3cr 3t\"",
expected: "host=host.example.com user=postgres port=5432 password=PASSWORD_REMOVED",
},

{
input: "password=abcde host=host.example.com user=postgres port=5432",
expected: "password=PASSWORD_REMOVED host=host.example.com user=postgres port=5432",
},

{
input: "password=abcde host=host.example.com user=postgres port=5432 password=\"s3cr 3t\"",
expected: "password=PASSWORD_REMOVED host=host.example.com user=postgres port=5432 password=PASSWORD_REMOVED",
},

{
input: "postgresql://host.example.com:5432/tsdb?user=postgres",
expected: "postgresql://host.example.com:5432/tsdb?user=postgres",
},

{
input: "postgresql://user:s3cret@host.example.com:5432/tsdb?user=postgres",
expected: "postgresql://user:PASSWORD_REMOVED@host.example.com:5432/tsdb?user=postgres",
},

{
input: "postgresql://host.example.com:5432/tsdb?user=postgres&password=s3cr3t",
expected: "postgresql://host.example.com:5432/tsdb?password=PASSWORD_REMOVED&user=postgres",
},

{
input: "host=host.example.com user=postgres port=5432",
expected: "host=host.example.com user=postgres port=5432",
},
}

for _, cs := range cases {
loggable := loggableDSN(cs.input)
c.Assert(loggable, Equals, cs.expected)
}

}
15 changes: 15 additions & 0 deletions cmd/postgres_exporter/util.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"fmt"
"math"
"net/url"
"regexp"
"strconv"
"strings"
"time"
Expand Down Expand Up @@ -212,10 +213,24 @@ func loggableDSN(dsn string) string {
if err != nil {
return "could not parse DATA_SOURCE_NAME"
}

// If the DSN is not a URL it is expected to be in the `key1=value1 key2=value2` format
if pDSN.Scheme == "" {
re := regexp.MustCompile(`(\s?password=([^"\s]+|"[^"]+"))`)
stripped := re.ReplaceAllString(dsn, " password=PASSWORD_REMOVED")
return strings.TrimSpace(stripped)
}

// Blank user info if not nil
if pDSN.User != nil {
pDSN.User = url.UserPassword(pDSN.User.Username(), "PASSWORD_REMOVED")
}

// If the password is contained in a URL parameter, we should remove it there
if q, err := url.ParseQuery(pDSN.RawQuery); err == nil && q.Has("password") {
q.Set("password", "PASSWORD_REMOVED")
pDSN.RawQuery = q.Encode()
}

return pDSN.String()
}